post https://www.clickpost.in/api/v4/create-order/
This API takes the shipment details, drop information, pickup information and creates an order with specified carrier partner. This applies for shipments created and transported within North America, Europe, Middle East and South-East Asia and cross-border shipments.
Sample Payload for SPS
{
"tax_info": {
"tax_paid":true,
"tax_amount":0,
"exporter_type":"UT",
"shipper_tax_id":"100315930600003",
"consignee_tax_id": "1234864968849",
"consignee_tax_type": "UT",
"consignee_tax_country_code": "MX",
"exporter_tax_id": "1234864968849",
"exporter_tax_type": "UT",
"exporter_tax_country_code": "MX",
},
"drop_info": {
"lat": 0,
"city": "RUH",
"long": 0,
"name": "TEST DO NOT DELIVER",
"email": "[email protected]",
"phone": "9876543210",
"state": "Dubai",
"address": "sadsa",
"district": "Dubai",
"landmark": "Near XYZ Park",
"phone_code": "+965",
"postal_code": "12345",
"country_code": "SA"
},
"pickup_info": {
"lat": 25.1414664,
"city": "DXB",
"long": 55.255369,
"name": "TEST DO NOT PICKUP",
"time": "2022-07-01T11:52:36",
"email": "[email protected]",
"phone": "1234567890",
"state": "Dubai",
"address": "123, Xyz Street, Near BNM Park",
"district": "Dubai",
"landmark": "Near LMN Building",
"phone_code": "+971",
"postal_code": "502626",
"country_code": "AE"
},
"shipment_details": {
"items": [
{
"sku": "53813",
"price": 249.29,
"weight": 500,
"hs_code": "6405.10.00",
"length": 25,
"width": 21,
"height": 6,
"quantity": 1,
"description": "Tod's Blue Patent Cutout Ankle Strap Ballet Flats Size 39.5",
"manufacture_country": "Italy",
"manufacture_country_code": "IT",
"cat": "Footwear",
"images": "http://link1.image.com,http://link2.image.com",
"product_url": "http://link1.product.com,http://link2.procuct.com",
"return_days": 2,
"exchange_days": 2,
"color": "dark blue",
"brand": "Tod's",
"size": "39.5",
"sub_category": "Flats",
"return_reason": "Defective",
"special_instructions": "Handle with care",
"imei": "12345678910111",
"ean": "EAN123456"
}
],
"height": 13,
"length": 23,
"weight": "1000",
"breadth": 31,
"order_id": "Test.UPS.Order0002",
"cod_value": 0,
"order_type": "PREPAID",
"invoice_date": "2022-06-21",
"account_code": "test",
"currency_code": "USD",
"delivery_type": "RVP",
"invoice_value": 468.58,
"invoice_number": "TLC-2022-06-WS-00038",
"courier_partner": 123,
"rvp_reason": "Cancelled",
"reference_number": "test_courier_00001",
"reseller_name": "Test Reseller",
"otp_based_delivery": true,
"exchange_address": "123, Test address"
},
"additional": {
"return_info": {
"lat": 25.1414664,
"city": "Dubai",
"long": 55.255369,
"name": "TEST DO NOT RETURN",
"email": "[email protected]",
"phone": "1234567890",
"state": "Dubai",
"address": "123, ABC St",
"district": "Dubai",
"landmark": "Near LMN Building",
"phone_code": "+965",
"postal_code": "502626",
"country_code": "KW"
},
"estimated_delivery_date":"2023-12-05",
"label": true,
"priority": "NORMAL",
"invoice_base_64": "JVBERaolfnawofikwenfoifoeirf",
"order_date": "2022-11-21"
},
"courier_custom_fields": {}
}
{
"tax_info": {
"tax_paid":true,
"tax_amount":0,
"exporter_type":"UT",
"shipper_tax_id":"100315930600003",
"consignee_tax_id": "1234864968849",
"consignee_tax_type": "UT",
"consignee_tax_country_code": "MX",
"exporter_tax_id": "1234864968849",
"exporter_tax_type": "UT",
"exporter_tax_country_code": "MX",
},
"drop_info": {
"lat": 0,
"city": "RUH",
"long": 0,
"name": "TEST DO NOT DELIVER",
"email": "[email protected]",
"phone": "9876543210",
"state": "Dubai",
"address": "sadsa",
"district": "Dubai",
"landmark": "Near XYZ Towers",
"phone_code": "+965",
"postal_code": "12345",
"country_code": "SA"
},
"pickup_info": {
"lat": 25.1414664,
"city": "DXB",
"long": 55.255369,
"name": "TEST DO NOT PICKUP",
"time": "2022-07-01T11:52:36",
"email": "[email protected]",
"phone": "1234567890",
"state": "Dubai",
"address": "123, Xyz Street, Near BNM Park",
"district": "Dubai",
"landmark": "Opposite to HHH",
"phone_code": "+971",
"postal_code": "502626",
"country_code": "AE"
},
"shipment_details": {
"items": [
{
"cat": "Footwear",
"sku": "53813",
"price": 249.29,
"weight": 500,
"length": 23,
"width": 21,
"height": 22,
"hs_code": "6405.10.00",
"quantity": 1,
"description": "Tod's Blue Patent Cutout Ankle Strap Ballet Flats Size 39.5",
"manufacture_country": "Italy",
"manufacture_country_code": "IT"
}
],
"height": 13,
"length": 23,
"weight": "1000",
"breadth": 31,
"order_id": "Test.UPS.Order0002",
"cod_value": 0,
"order_type": "PREPAID",
"invoice_date": "2022-06-21",
"account_code": "test",
"currency_code": "USD",
"delivery_type": "FORWARD",
"invoice_value": 468.58,
"invoice_number": "TLC-2022-06-WS-00038",
"courier_partner": 123,
"reference_number": "test_courier_00001"
},
"additional": {
"return_info": {
"lat": 25.1414664,
"city": "Dubai",
"long": 55.255369,
"name": "TEST DO NOT RETURN",
"email": "[email protected]",
"phone": "1234567890",
"state": "Dubai",
"address": "123, ABC St",
"district": "Dubai",
"landmark": "Near PPP Park",
"phone_code": "+965",
"postal_code": "502626",
"country_code": "KW"
},
"label": true,
"invoice_base_64": "JVBERaolfnawofikwenfoifoeirf"
},
"courier_custom_fields": {}
}
{
"tax_info": {
"tax_paid":true,
"tax_amount":0,
"exporter_type":"UT",
"shipper_tax_id":"100315930600003",
"consignee_tax_id": "1234864968849",
"consignee_tax_type": "UT",
"consignee_tax_country_code": "MX",
"exporter_tax_id": "1234864968849",
"exporter_tax_type": "UT",
"exporter_tax_country_code": "MX",
},
"drop_info": {
"city": "HERMOSILLO",
"name": "Hernan Cortez",
"time": "2022-09-07T19:16:24",
"email": "[email protected]",
"phone": "1234567890",
"state": "SO",
"district":"HERMOSILLO",
"address": "52, ABC Calle",
"phone_code": "+52",
"postal_code": "12345",
"country_code": "MX",
"alternate_phone": "",
"lat": "",
"long": "",
"instructions": "Leave at the door",
"landmark": "lampost"
},
"pickup_info": {
"city": "MEGAPARK",
"name": "WALMART.COM",
"time": "2022-09-07T19:16:24",
"email": "[email protected]",
"phone": "9876543210",
"state": "CP",
"address": "113, Tlaloc Calle",
"district":"MEXICO",
"phone_code": "+52",
"postal_code": "54321",
"country_code": "MX",
"lat": "",
"long": "",
"landmark": "Society Park"
},
"shipment_details": {
"items": [
{
"sku": "6000202721854",
"price": 0,
"height": 17,
"length": 25,
"weight": 1000,
"width": 1,
"quantity": 1,
"additional": {
"asn_code": "Test-GLS-MX-1"
},
"carta_porte": {
"embalaje": "",
"claveUnidad": "H87",
"descripcion": "LapTop",
"bienesTransp": "10282",
"materialPeligroso": "",
"cveMaterialPeligroso": ""
},
"description": "Baby powder"
}
],
"height": 17,
"length": 25,
"weight": 1000,
"breadth": 1,
"cod_value": 0,
"order_type": "PREPAID",
"invoice_date": "2022-09-19",
"currency_code": "MXN",
"delivery_type": "FORWARD",
"invoice_value": 1,
"invoice_number": "IOL-000024",
"courier_partner": 234,
"reference_number": "TEST30092022003"
},
"additional": {
"return_info": {
"lat": 25.1414664,
"city": "Dubai",
"long": 55.255369,
"name": "TEST DO NOT RETURN",
"email": "[email protected]",
"phone": "1234567890",
"state": "Dubai",
"address": "123, ABC St",
"district": "Dubai",
"landmark": "Top of TTT Office Building",
"phone_code": "+965",
"postal_code": "502626",
"country_code": "KW"
},
"label": true,
"from_wh": "",
"asn_code": "Test-GLS-MX-1",
"order_id": "521512117539Test5",
"sort_code": "",
"account_code": "paq-testing",
"channel_name": "",
"user_defined_field_array": [
{
"name": "ship_via_method",
"type": "String",
"value": "75120003"
},
{
"name": "max_edd",
"type": "String",
"value": "2022-09-19"
},
{
"name": "ship_via_po",
"type": "String",
"value": "521512117539-2-Test4"
}
]
},
"courier_custom_fields": {}
}
Sample Payload for MPS
{
"tax_info":{
"tax_paid":true,
"tax_amount":0,
"exporter_type":"UT",
"shipper_tax_id":"100315930600003",
"consignee_tax_id": "1234864968849",
"consignee_tax_type": "UT",
"consignee_tax_country_code": "MX",
"exporter_tax_id": "1234864968849",
"exporter_tax_type": "UT",
"exporter_tax_country_code": "MX",
},
"drop_info":{
"city":"Kuwait City",
"name":"ABCD",
"email":"[email protected]",
"phone":"123456780",
"state":"",
"address":"ABCD Street",
"district":"",
"phone_code":"965",
"postal_code":"Salmiya",
"country_code":"KW",
"landmark": "Near HHH Towers"
},
"additional":{
"estimated_delivery_date":"2023-12-05",
"max_edd":"10",
"order_id":"A093815000001",
"channel_name":"",
"duty_fee_paid_by":"S",
"invoice_base_64": "JVBERklsfhs16561sfsfsvsvsv"
},
"pickup_info":{
"city":"DUBAI",
"name":"DEFG",
"time":"2022-11-09T18:47:00Z",
"email":"[email protected]",
"phone":"45678901",
"state":"",
"address":"HYTTX Towers",
"district":"",
"phone_code":"971",
"postal_code":"JAFZA - JEBEL ALI FREE ZONE SOUTH",
"country_code":"AE",
"landmark": "Near III Towers"
},
"shipment_details":{
"items":[
{
"sku":"box-1",
"price":9.44,
"height":2,
"images":"https://b.bflcdn.com/products/22/8/192005329771_BTM_RAW_1.JPG",
"length":1,
"weight":200,
"width":1,
"hs_code":"nullnull",
"quantity":2,
"description":"box 1",
"product_url":"https://b.bflcdn.com/products/22/8/192005329771_BTM_RAW_1.JPG",
"manufacture_country":"UNITED ARAB EMIRATES",
"manufacture_country_code":"AE"
}
],
"height":2,
"length":1,
"weight":200,
"breadth":1,
"cod_value":0,
"order_type":"PREPAID",
"invoice_url":"http://link.to.inv1.com",
"invoice_date":"2022-11-09",
"currency_code":"KWD",
"delivery_type":"FORWARD",
"invoice_value":9.44,
"invoice_number":"A093815000001",
"account_code":"DHL_KW_LB",
"courier_partner":164,
"reference_number":"A093815000001-s2888",
"items_in_shipment":[
{
"sku": "53813",
"price": 249.29,
"weight": 500,
"hs_code": "6405.10.00",
"quantity": 1,
"description": "Tod's Blue Patent Cutout Ankle Strap Ballet Flats Size 39.5",
"manufacture_country": "Italy",
"manufacture_country_code": "IT",
"cat": "Footwear",
"images": "http://link1.image.com,http://link2.image.com",
"product_url": "http://link1.product.com,http://link2.procuct.com",
"return_days": 2,
"exchange_days": 2,
"length":10,
"width": 7,
"height": 6
},
{
"sku":"6955214840390",
"price":4.18,
"height":1,
"images":"https://b.bflcdn.com/products/22/9/NOIMAGE.JPG",
"length":1,
"weight":100,
"breadth":1,
"hs_code":"1234.56.78",
"quantity":1,
"description":"Men Printed Backpack 47 H x 35 L x 13 W cm Red/Blue/Yellow Combo",
"product_url":"https://b.bflcdn.com/products/22/9/NOIMAGE.JPG",
"manufacture_country":"UNITED ARAB EMIRATES",
"manufacture_country_code":"AE"
}
]
},
"courier_custom_fields": {}
}
{
"tax_info": {},
"drop_info": {
"lat": 0,
"city": "Dubai",
"long": 0,
"name": "dsadsad sadsad",
"email": "[email protected]",
"phone": "9876543210",
"state": "Dubai",
"address": "123 ABC St",
"district": "Dubai",
"landmark": "Near III Towers",
"phone_code": "+965",
"postal_code": "12345",
"country_code": "KW"
},
"pickup_info": {
"lat": 25.1414664,
"city": "Dubai",
"long": 55.255369,
"name": "TEST DO NOT PICKUP",
"time": "2022-07-01T11:52:36+04:00",
"email": "[email protected]",
"phone": "1234567890",
"state": "Dubai",
"address": "123, ABC St",
"district": "Dubai",
"landmark": "Near HHH Towers",
"phone_code": "+971",
"postal_code": "502626",
"country_code": "AE"
},
"shipment_details": {
"items": [
{
"sku": "53813",
"price": 249.29,
"weight": 500,
"hs_code": "6405.10.00",
"quantity": 1,
"description": "Tod's Blue Patent Cutout Ankle Strap Ballet Flats Size 39.5",
"manufacture_country": "Italy",
"manufacture_country_code": "IT",
"cat": "Footwear",
"images": "http://link1.image.com,http://link2.image.com",
"product_url": "http://link1.product.com,http://link2.procuct.com",
"return_days": 2,
"exchange_days": 2,
"color": "dark blue",
"brand": "Tod's",
"size": "39.5",
"sub_category": "Flats",
"return_reason": "Defective",
"special_instructions": "Handle with care",
"imei": "12345678910111",
"ean": "EAN123456"
},
{
"sku": "53814",
"price": 111.00,
"weight": 78,
"hs_code": "1234.56.78",
"quantity": 1,
"description": "Tod's Blue Shoes - Size 8",
"manufacture_country": "Italy",
"manufacture_country_code": "IT",
"cat": "Footwear",
"images": "http://link1.image.com,http://link2.image.com",
"product_url": "http://link1.product.com,http://link2.procuct.com",
"return_days": 2,
"exchange_days": 2,
"color": "dark blue",
"brand": "Tod's",
"size": "39.5",
"sub_category": "Flats",
"return_reason": "Defective",
"special_instructions": "Handle with care",
"imei": "12345678910111",
"ean": "EAN123456"
}
],
"height": 13,
"length": 23,
"weight": "1000",
"breadth": 31,
"order_id": "Test.UPS.Order0002",
"cod_value": 50,
"order_type": "COD",
"invoice_date": "2022-06-21",
"account_code": "test",
"currency_code": "USD",
"delivery_type": "RVP",
"rvp_reason": "Defective product",
"invoice_value": 468.58,
"invoice_number": "TLC-2022-06-WS-00038",
"courier_partner": "107",
"reference_number": "Test.UPS.Order0002"
},
"additional": {
"return_info": {
"lat": 25.1414664,
"city": "Dubai",
"long": 55.255369,
"name": "TEST DO NOT RETURN",
"email": "[email protected]",
"phone": "1234567890",
"state": "Dubai",
"address": "123, ABC St",
"district": "Dubai",
"landmark": "Near RRR Towers",
"phone_code": "+965",
"postal_code": "502626",
"country_code": "KW"
},
"label": true,
"invoice_base_64": "JVBERklsfhs16561sfsfsvsvsv"
},
"courier_custom_fields": {}
}
{
"drop_info": {
"city": "HERMOSILLO",
"name": "Hernan Cortez",
"time": "2022-09-07T19:16:24",
"email": "[email protected]",
"phone": "1234567890",
"state": "SO",
"district":"HERMOSILLO",
"address": "52, ABC Calle",
"phone_code": "+52",
"postal_code": "12345",
"country_code": "MX",
"alternate_phone": "",
"lat": 12.34,
"long": 56.78,
"instructions": "Leave at the door",
"landmark": "lampost"
},
"additional": {
"from_wh": "",
"asn_code": "Test-GLS-MX-1",
"order_id": "521512117539Test5",
"sort_code": "",
"account_code": "paq-testing",
"channel_name": "",
"user_defined_field_array": [
{
"name": "ship_via_method",
"type": "String",
"value": "75120003"
},
{
"name": "max_edd",
"type": "String",
"value": "2022-09-19"
},
{
"name": "ship_via_po",
"type": "String",
"value": "521512117539-2-Test4"
}
]
},
"pickup_info": {
"city": "MEGAPARK",
"name": "WALMART.COM",
"time": "2022-09-07T19:16:24",
"email": "[email protected]",
"phone": "9876543210",
"state": "CP",
"address": "113, Tlaloc Calle",
"district":"MEXICO",
"phone_code": "+52",
"postal_code": "54321",
"country_code": "MX",
"lat": "",
"long": "",
"landmark": "Society Park"
},
"shipment_details": {
"items": [
{
"sku": "6000202721854",
"price": 0,
"height": 17,
"length": 25,
"weight": 1000,
"breadth": 1,
"quantity": 1,
"additional": {
"asn_code": "Test-GLS-MX-1"
},
"carta_porte": {
"embalaje": "",
"claveUnidad": "H87",
"descripcion": "LapTop",
"bienesTransp": "10282",
"materialPeligroso": "",
"cveMaterialPeligroso": ""
},
"description": "Baby powder"
}
],
"height": 17,
"length": 25,
"weight": 1000,
"breadth": 1,
"cod_value": 0,
"order_type": "PREPAID",
"invoice_date": "2022-09-19",
"currency_code": "MXN",
"delivery_type": "FORWARD",
"invoice_value": 1,
"invoice_number": "IOL-000024",
"courier_partner": 234,
"reference_number": "TEST30092022003"
},
"additional": {
"return_info": {
"lat": 25.1414664,
"city": "San Francisco de Campeche",
"long": 55.255369,
"name": "TEST DO NOT RETURN",
"email": "[email protected]",
"phone": "1234567890",
"state": "Campeche",
"address": "123, ABC St",
"district": "Campeche City",
"landmark": "Near RRR Towers",
"phone_code": "+52",
"postal_code": "502626",
"country_code": "MX"
},
"label": true
},
"courier_custom_fields": {}
}
Sample Response for SPS
{
"result": {
"waybill": "SKY0000006574",
"reference_number": "Test.SKYEXRVP.Order00002",
"label": "https://pyck-res-bucket.s3.amazonaws.com:443/SKYEXPRESS_RVP/2022-10-21/SKY0000006574.pdf",
"courier_partner_id": 325,
"courier_name": "SkyExpress",
"sort_code": null,
"order_id": 147175531,
"security_key": "4d36d09c-53b3-49f3-beb3-4eb8f884f941",
"tracking_id": 487501569
},
"meta": {
"status": 200,
"success": true,
"message": "Order Placed Successfully"
}
}
{
"meta": {
"status": 400,
"message": "Error Message",
"success": false
}
}
{
"result": {
"reference_number": "TestSolv00002",
"label": "https://pyck-res-bucket.s3.amazonaws.com:443/BLUEDART/2022-10-25/53433518935.pdf",
"waybill": "53433518935",
"DestinationLocation": "KOO",
"token_number": "13933760",
"DestinationArea": "COK",
"children": [
{
"reference_number": "TestSolv00002",
"label": "https://pyck-res-bucket.s3.amazonaws.com:443/BLUEDART/2022-10-25/53433518935.pdf",
"waybill": "53433518935-0001",
"DestinationLocation": "KOO",
"DestinationArea": "COK",
"item": {
"sku": "XYZ1",
"price": 200.0,
"height": 10,
"images": "http://sample-file1.jpg,http://sample-file2.jpg",
"length": 10,
"weight": 100,
"breadth": 10,
"gst_info": {
"hsn_code": "1234",
"cgst_amount": 10,
"igst_amount": 100,
"seller_name": "Deepanshu",
"sgst_amount": 10,
"gst_discount": 0,
"gst_tax_base": 20,
"invoice_date": "2022-08-01",
"seller_gstin": "11ANKPT8882PQZC",
"seller_state": "Delhi",
"cgst_tax_rate": 10,
"gst_total_tax": 100,
"igst_tax_rate": 10,
"invoice_value": 200,
"sgst_tax_rate": 10,
"taxable_value": 100,
"invoice_number": "1882782",
"seller_address": "A-228 top floor kalkaji",
"seller_pincode": "110019",
"consignee_gstin": "11ANKPT8882PQZD",
"place_of_supply": "DELHI",
"enterprise_gstin": "11ANKPT8882ERZC",
"invoice_reference": "DC68HJJ",
"ewaybill_expiry_date": "",
"ewaybill_serial_number": "",
"is_seller_registered_under_gst": true
},
"quantity": 13,
"description": "Cartoon Box 1",
"product_url": "<Product Page Url>",
"image_urls": [
"http://sample-file1.jpg",
"http://sample-file2.jpg"
],
"waybill": "53433518935-0001"
}
},
{
"reference_number": "TestSolv00002",
"label": "https://pyck-res-bucket.s3.amazonaws.com:443/BLUEDART/2022-10-25/53433518935.pdf",
"waybill": "53433518935-0002",
"DestinationLocation": "KOO",
"DestinationArea": "COK",
"item": {
"sku": "XYZ2",
"price": 200.0,
"height": 10,
"images": "http://sample-file1.jpg,http://sample-file2.jpg",
"length": 10,
"weight": 100,
"breadth": 10,
"gst_info": {
"hsn_code": "1234",
"cgst_amount": 10,
"igst_amount": 100,
"seller_name": "Deepanshu",
"sgst_amount": 10,
"gst_discount": 0,
"gst_tax_base": 20,
"invoice_date": "2022-08-08",
"seller_gstin": "11ANKPT8882DPQC",
"seller_state": "Delhi",
"cgst_tax_rate": 10,
"gst_total_tax": 100,
"igst_tax_rate": 10,
"invoice_value": 200,
"sgst_tax_rate": 10,
"taxable_value": 100,
"invoice_number": "1882783",
"seller_address": "A-228 top floor kalkaji",
"seller_pincode": "110019",
"consignee_gstin": "11ANKPT8882RDZD",
"place_of_supply": "DELHI",
"enterprise_gstin": "11ANKPT8882UIZC",
"invoice_reference": "DC68HJJ1",
"is_seller_registered_under_gst": true
},
"quantity": 17,
"description": "Cartoon Box 1",
"product_url": "<Product Page Url>",
"image_urls": [
"http://sample-file1.jpg",
"http://sample-file2.jpg"
],
"waybill": "53433518935-0002"
}
}
],
"courier_partner_id": 129,
"courier_name": "Bluedart",
"sort_code": "COK/KOO",
"order_id": "Order-123456",
"security_key": "3ee64ff7-be52-4e31-9ec5-21cf194cab03"
},
"meta": {
"status": 200,
"success": true,
"message": "Order Placed Successfully"
},
"order_id": 147885236,
"tracking_id": 491322827
}
Sample Response for MPS
{
"meta": {
"status": 400,
"message": "Error Message",
"success": false
}
}
{
"meta":{
"status":200,
"message":"Order Placed Successfully",
"success":true
},
"result":{
"label":"https://pyck-res-bucket.s3.amazonaws.com:443/DHL_MPS/2022-11-09/6852865692.pdf",
"waybill":"6852865692",
"order_id":151445760,
"sort_code":null,
"tracking_id":506175035,
"courier_name":"DHL",
"security_key":"efa57dfe-8456-4744-b83d-cd9f36577632",
"courier_partner_id":164,
"commercial_invoice_url":"https://pyck-res-bucket.s3.amazonaws.com:443/DHL_MPS/INVOICE_DATA/2022-11-09/6852865692.pdf"
}
}
Payload
The payload will consist of the following fields:
| Field Name | Data Type | Field | Description |
|---|---|---|---|
pickup_info | Object | Mandatory | Information for where the shipment will be picked up by the courier |
drop_info | Object | Mandatory | Information for where the shipment will be delivered by the courier |
additional | Object | Optional | Additional optional information about the shipment |
shipment_details | Object | Mandatory | Information about the shipment itself |
tax_info | Object | Optional | Information for taxes levied on the shipment. Note: Required only for cross-border having tax/customs requirements |
courier_custom_fields | Object | Conditional Mandatory | Fields required for specific carriers. Only applicable for Fedex MPS Cross-Border (Partner ID: 330) |
Pickup Info (pickup_info)
pickup_info)This mandatory object takes in the data for the warehouse/pickup location for the shipment.
| Field Name | Data Type | Field | Description |
|---|---|---|---|
lat | Float | Optional | Latitude of the pickup location |
long | Float | Optional | Longitude of the pickup location |
name | String | Mandatory | Contact name of the consignor of the shipment |
address | String | Mandatory | Address of the pickup location |
district | String | Optional | District of the pickup location |
city | String | Mandatory | City of the pickup location |
state | String | Mandatory | State/province of the pickup location |
landmark | String | Optional | Landmarks to help find the pickup location |
email | String | Mandatory | Email of the pickup contact |
phone | String | Mandatory | Contact number of the pickup contact |
time | String | Mandatory | Time of pickup for the order (to be provided in YYYY-MM-DDTHH:MM:SS format only) |
postal_code | String | Mandatory | Postal code of the pickup location. If postal code system is not applicable for the location, use blank string. |
country_code | String | Mandatory | Alpha ISO-2 country code of the pickup location |
phone_code | String | Optional | Country phone dialling code of the pickup location |
address_type | String | Optional | Address type of the pickup location. Must be either OFFICE or RESIDENTIAL |
Drop Info (drop_info)
drop_info)This mandatory object takes in the data for the delivery/consignee location for the shipment.
| Field Name | Data Type | Field | Description |
|---|---|---|---|
lat | Float | Optional | Latitude of the drop location |
long | Float | Optional | Longitude of the drop location |
name | String | Mandatory | Contact name of the consignee of the shipment |
address | String | Mandatory | Address of the drop location |
district | String | Optional | District of the drop location |
city | String | Mandatory | City of the drop location |
state | String | Mandatory | State/province of the drop location |
landmark | String | Optional | Landmarks to help find the drop location |
email | String | Optional | Email of the drop contact |
phone | String | Mandatory | Contact number of the drop contact |
time | String | Optional | Estimated time of drop for the order (to be provided in YYYY-MM-DDTHH:MM:SS format only) |
postal_code | String | Mandatory | Postal code of the drop location. If postal code system is not applicable for the location, use blank string. |
country_code | String | Mandatory | Alpha ISO-2 country code of the drop location |
phone_code | String | Optional | Country phone dialling code of the drop location |
address_type | String | Optional | Address type of the drop location. Must be either OFFICE or RESIDENTIAL |
Additional Fields (additional)
additional)In the "additional" object optional fields can be passed which may be used by the courier partner, or give additional details for the order, e.g. Async/Sync order creation or whether label generation is needed.
| Field Name | Data Type | Field | Description |
|---|---|---|---|
label | Boolean | Optional | Whether label is required for the order or not. Defaults to true. |
priority | String | Optional | Priority of the order to be delivered. Can only take values as "NORMAL" or "URGENT". Defaults to "NORMAL" |
rvp_reason | String | Conditional | Reason for returning the product/failed delivery. Mandatory if delivery_type is RVP. |
estimated_delivery_date | Date | Optional | The date of estimated delivery has been shared with the customer. This field can be used to measure carrier performance by comparing it with the actual date of delivery in the Clickpost reports to be provided in YYYY-MM-DD format only |
Return Info (return_info)
return_info)In the "return_info" object, the details for the return address is to be provided. The details are particularly useful in case of a failed delivery or product return due to other reasons.
| Field Name | Data Type | Field | Description |
|---|---|---|---|
lat | Float | Optional | Latitude of the return location |
long | Float | Optional | Longitude of the return location |
name | String | Mandatory | Contact name of the return contact of the shipment |
address | String | Mandatory | Address of the return location |
district | String | Optional | District of the return location |
city | String | Mandatory | City of the return location |
state | String | Mandatory | State/province of the return location |
landmark | String | Optional | Landmarks to help find the return location |
email | String | Optional | Email of the return contact |
phone | String | Mandatory | Contact number of the return contact |
postal_code | String | Mandatory | Postal code of the return location. If postal code system is not applicable for the location, use blank string. |
country_code | String | Mandatory | Alpha ISO-2 country code of the return location |
Shipment Details (shipment_details)
shipment_details)In the 'shipment_details' field, the details regarding all items, and important order details like payment type, order type, courier partner, etc. are added.
| Field Name | Data Type | Field | Description |
|---|---|---|---|
items | List[Object] | Mandatory | List of items to be delivered in the shipment. Details of the items explained below. |
vendor_code | String | Conditional | Vendor code of pickup location. only if required by courier partner |
account_code | String | Mandatory | Courier partner account name configured on the Clickpost dashboard. Will return a 400 Bad Request response if the given account is inactive or does not exist. |
height | Float | Mandatory | Height of the overall package (in cms) |
width | Float | Mandatory | Width of the overall package (in cms) |
length | Float | Mandatory | Length of the overall package (in cms) |
weight | Float | Mandatory | Weight of the package (in gms) |
courier_partner | Integer | Mandatory | Partner ID of the desired carrier. Refer to List of carriers supported by Clickpost to get the partner ID. |
reference_number | String | Mandatory | Reference number of the order. Must be unique for every shipment, i.e. every call of this API. |
cod_value | Float | Mandatory | Cash to be given to the courier (currency to be determined by currency_code). Must be non-zero for COD orders, and zero for PREPAID orders. |
order_id | String | Optional | Identification string for the order |
order_type | String | Mandatory | Type of payment of the shipment. Can only take values "COD" or "PREPAID". cod_value must be non-zero for COD shipments and zero for PREPAID shipments. |
delivery_type | String | Mandatory | Type of delivery to be done. Can only take values "FORWARD" or "RVP". |
invoice_value | Float | Mandatory | Value of the shipment as mentioned in the invoice. |
invoice_date | String | Mandatory | Date of issuance of the invoice of the shipment. (YYYY-MM-DD format only) |
awb_number | String | Optional | The airwaybill number of the shipment. |
Item Level details (items)
items)The details for each item to be delivered is passed in the "items" field, in "shipment_details".
| Field Name | Data Type | Field | Description |
|---|---|---|---|
cat | String | Optional | Category of the item in question |
description | String | Mandatory | Brief description of the item |
quantity | Integer | Mandatory | Number of units of the item |
weight | Float | Mandatory | Weight of each unit of the item |
price | Float | Mandatory | Non-negative price of each unit of the item (currency to be decided by 'currency_code' field) |
manufacture_country_code | String | Optional | Alpha-2 ISO Country code of manufacture of the item |
manufacture_country | String | Optional | Full country name of manufacture of the item |
sku | String | Optional | Stock-keeping unit of the item |
return_days | Integer | Optional | Number of days within which the item can be returned |
exchange_days | Integer | Optional | Number of days within which the item can be exchanged |
product_url | String | Optional | URL for the product. If there are multiple URLs, they can be sent as a single string with comma-separated values. |
images | String | Optional | URL for the image(s) of the product. If there are multiple URLs, they can be sent as a single string with comma-separated values. |
carta_porte | Object | Conditional | Applicable for Mexican couriers only Mexican couriers often require a bill of lading in their invoices, known as Carta Porte. This object encapsulates all necessary details for the bill of lading. |
color | String | Conditional Optional | Colour of the item Applicable for quality checking for RVP shipments |
sub_category | String | Conditional Optional | Category the item's type is classified in Applicable for quality checking for RVP shipments |
size | String | Conditional Optional | Size of the item Applicable for quality checking for RVP shipments |
brand | String | Conditional Optional | Brand of the item Applicable for quality checking for RVP shipments |
return_reason | String | Conditional Optional | Reason for returning the item Applicable for quality checking for RVP shipments |
special_instructions | String | Conditional Optional | Special Instructions for returning the item Applicable for quality checking for RVP shipments |
imei | String | Conditional Optional | IMEI number of the item (if it is a mobile device) Applicable for quality checking for RVP shipments |
ean | String | Conditional Optional | EAN Number of the item Applicable for quality checking for RVP shipments |
Carta Porte Details (carta_porte field) - For Mexico Only
carta_porte field) - For Mexico OnlyMexican couriers often require a bill of lading per item in their invoices, known as Carta Porte. The carta_porte object encapsulates all necessary details for the bill of lading of the item. For more information, you can visit What you should know about the 'Carta Porte'
The following fields can be included in the carta_porte field.
| Field Name | Data Type | Field | Description |
|---|---|---|---|
bienesTransp | String | Conditional Mandatory | A number representing the categorization of the SKU of the item by the government. |
descripcion | String | Conditional Mandatory | Item description |
materialPeligroso | Boolean | Conditional Mandatory | Whether the item is dangerous/inflammable/reactive. |
cveMaterialPeligroso | String | Conditional Mandatory | An ID for the item, denoting what type of danger it might pose if it is dangerous. Leave blank if materialPeligroso is set to false. |
embalaje | String | Conditional Mandatory | Type of packing of the item |
claveUnidad | String | Conditional Mandatory | Stock-keeping unit of the item |
The sample request payload may look like this:
Tax Info (tax_info)
tax_info)This field will contain several information for the taxes levied on the shipment.
| Field Name | Data Type | Field | Description |
|---|---|---|---|
shipper_tax_id | String | Optional | Tax Identification Number of the shipper |
consignee_tax_id | String | Optional | Tax Identification Number of the consignee |
consignee_tax_type | String | Optional | Type of tax levied, on the consignee e.g: VAT, GST, etc. |
consignee_tax_type_country_code | String | Optional | Alpha-2 ISO Country code, denoting the country where the tax is levied on the consignee |
exporter_tax_id | String | Optional | Tax Identification Number of the exporter/shipper |
exporter_tax_type | String | Optional | Type of tax levied, on the exporter/shipper e.g: VAT, GST, etc. |
exporter_tax_type_country_code | String | Optional | Alpha-2 ISO Country code, denoting the country where the tax is levied on the exporter/shipper |
lut_bond_number | String | Optional | LUT Bond Reference number - The Letter of Undertaking, also known as the LUT Bond, is a document submitted by an exporter to be exempt from paying IGST on exports. Mandatory for Delhivery International ( CP ID: 93) where IGST isn't paid by the seller for export goods. |
Response
The response typically consists of the following fields. Keep in mind that additional fields can be present according to the requirement of the enterprise/courier.
| Field Name | Data Type | Description |
|---|---|---|
meta | Object | Metadata for the request, e.g. status code, error messages. |
result | Object | Actual result of the request |
order_id | Integer | Order ID of the request |
tracking_id | Integer | A special ID of the request used for tracking |
Response Meta
| Field Name | Data Type | Description |
|---|---|---|
status | Integer | Status code for the request (including but not limited to HTTP Status codes) |
message | String | Error/Success messages for the request |
success | Boolean | Whether the order was successfully created or not |
Response Result
| Field Name | Data Type | Description |
|---|---|---|
waybill | String | Waybill of the newly created order, or the one passed in the awb_number field (if any). This waybill is automatically registered for tracking in our database |
reference_number | String | Reference number of the order, sent in the payload. |
label | String/Null | URL to the generated label of the order. If labels are not needed, this stays null. |
commercial_invoice_url | String | (Appears for certain couriers) URL to the generated commercial invoice of the order |
courier_partner_id | Integer | ID of the courier partner |
courier_name | String | Name of the courier |
sort_code | String/Null | Courier Partner Sort code. Certain couriers use something called a sort code that can be passed to the shipping label for custom-built labels. Will return null if sort codes are not supported. |
security_key | String | UUID security key of the order that needs to be stored at the enterprise's end. |
children | Object | (Only for MPS responses) A list of item objects, with details of each item |
Possible Error Codes
These are the list of possible error/status codes that can appear in the response metadata, and the actionables corresponding to each.
| Meta Status Code | HTTP Status Code | Description | Actionable | Order Successful? | Status Message |
|---|---|---|---|---|---|
| 102 | 200 | For async orders: The order has been recorded in Clickpost's database and is under processing. | Need to re-attempt Clickpost's order creation API to check if the order has been processed. | No | " |
| 200 | 200 | The order is successfully created | None | Yes | "Success" |
| 301 | 200 | The customer is sending an invalid/non-existent/inactive license key in the URL parameters | Need to re-attempt the order with a valid/registered/active license key. | No | "Authentication Failed: Invalid Token or API Key" |
| 302 | 200 | Either of the three things: - The customer is sending the courier_partner value as a string- The customer is sending a null value in the courier_partner field.- The partner ID being sent in courier_partner field does not exist. | Need to re-attempt the order with a valid integer value in the courier_partner field, and the value should exist in Clickpost's database. | No | "Invalid Courier Partner Id with Field courier_partner" |
| 303 | 200 | For async orders: The awb_number provided already exists and is registered by Clickpost | Need to re-attempt the order with a different awb_number value. | Yes | "Waybill already registered" |
| 307 | 200 | Theorder_type value is anything other than PREPAID, COD or EXCHANGE, or is null. | Need to re-attempt the order with the order_type as either PREPAID, COD or EXCHANGE. | No | "You have entered invalid Order Type" |
| 308 | 200 | Thepriority value is anything other than NORMAL or URGENT. | Need to re-attempt the order with the priority as either NORMAL or URGENT. | No | "You have entered invalid Order priority" |
| 309 | 200 | Thedelivery_type value is anything other than FORWARD or RVP. | Need to re-attempt the order with the delivery_type as either FORWARD or RVP. | No | "Invalid Delivery Type" |
| 310 | 200 | In case of RVP orders: This is due to either of the following - The rvp_reason field is missing- The rvp_reason length is more than 500 characters. | Need to re-attempt the RVP order with a non-null rvp_reason value within 500 characters. | No | "RVP reason is missing" or "RVP reason can't be more than 500 chars" |
| 311 | 200 | For RVP orders: The courier partner defined by the courier_partner field does not support RVP shipments, or is not an RVP courier. | Need to re-attempt the RVP order with a courier_partner value that supports RVP shipments. | No | "Invalid Courier Partner For RVP" |
| 312 | 200 | There is no item data in the payload (in the item field). | Need to retry the order with a non-empty items array. | No | "Items Data is missing from order details" |
| 313 | 200 | Either of the following: - The item data being sent in the items field is either a string or any other invalid format.- The items value is an array, but of anything other than objects.- The items value is an array of objects, but one or more mandatory fields are missing for one or more items. | Need to retry the order with proper items data, as an array of JSON objects. | No | "Invalid Format of items for Order data" |
| 314 | 200 | There is an issue with the order data being passed. | The error is captured in the status message. Retry the order after addressing the status message. | No | "Invalid Format of items for Order data: " |
| 315 | 200 | Either of the following: - For a PREPAID order, the cod_value is non-zero.- For a COD order, the cod_value is zero. | Need to retry the orders after: - (For PREPAID orders) setting the cod_value to zero.- (For COD orders) setting the cod_value to a non-zero number | No | "Invalid Cod Value" |
| 316 | 200 | There are no credentials for the courier partner of the account given in account_code, or the credentials are blank. | Need to re-attempt the order with a different account_code, or fill the credential fields in the dashboard and retry. | No | "You do not have credentials for the Courier Partner" |
| 319 | 200 | There is an issue in placing orders with the courier partner. | The actual error generally pops up alongside the error message. In cases where the error message is vague, contact the support team. | No | "Error In Order Placing To Courier Partner: " |
| 320 | 200 | The enterprise has not subscribed for Clickpost's Order Creation Service. | Need to subscribe to the order creation service, then retry with all valid details and credentials. | No | "This service is not subscribed by you" |
| 321 | 200 | The awb provided in the awb_number field does not exist in Clickpost's database. | Need to provide a registered AWB, or remove the AWB field and try again. | No | "Awb Number Does not exist in system for courier partner" |
| 322 | 200 | There is an issue in the courier partner servers. | Need to retry after waiting for a while, or get in touch with Clickpost support or the courier partner support. | No | "Internal Server Error In Courier Partners Server" |
| 323 | 200 | An order is already present in Clickpost's database with the same reference number as the one provided. | Need to re-attempt the order with a different reference number | Yes | "You have already placed this order" |
| 328 | 200 | Some mandatory field in the POST data might be missing. | Check for missing fields that are supposed to be there in the data and retry | No | "Invalid POST data" |
| 329 | 200 | The connection to the courier partner's API timed out. | Need to retry after waiting for a while, or get in touch with Clickpost support or the courier partner support. | No | "Courier Partner API timeout" |
| 351 | 200 | The account name of the courier partner account given in the account_code field does not exist for the enterprise user. | The user needs to check either/all of the things below if they are correct - Enterprise license key in the URL params - Courier Partner ID in the courier_partner field.- Account name in the account_code field, and whether this account exists for this courier partner.Re-attempt the order after correcting any of the incorrect details mentioned above. | No | "Clickpost Account: Does not exist" |
| 352 | 200 | There are multiple accounts of the same enterprise with the same courier partner with the same name as the one in account_code field. | No | "Multiple account exists" | |
| 353 | 200 | The account mentioned in the account_code field is inactive. | Need to either enable the account on the dashboard from the enterprise's end, or use an active account. | No | "Clickpost Account: Inactive" |
| 354 | 200 | There is an unhandled error from the courier partner's end. | The error is typically visible in the status message and can be fixed accordingly. In case of vague error messages, get in touch with the support team | No | "Unhandled error! Contact [email protected]" or the actual error |
| 355 | 200 | In certain couriers the vendor_code field is required. This error pops up whenever vendor_code is not passed in the payload | Need to pass the vendor_code field alongwith a registered vendor code. | No | "Vendor code not found" |
| 400 | 200 | There is an issue with the payload, or some invalid data is being sent in the request. | Need to fix the issues in the payload as mentioned in the status message. If "Bad Request" pops up, get in touch with the support team. | No | "Bad Request" or the actual error |
| 500 | 200 | There is an error in Clickpost's servers. | Need to wait a while and try again. If this error pops up even after multiple tries, get in touch with the support team. | No | "Oops! Internal server error in Clickpost" |