post https://www.clickpost.in/api/v3/create-order/
This API takes the shipment details, drop information, pickup information and creates an order with specified carrier partner. Works only for shipments created and transported within India.
Sample Payload for SPS
{
"drop_info": {
"drop_lat": 0,
"drop_city": "Mumbai",
"drop_long": 0,
"drop_name": "dsadsad sadsad",
"drop_email": "[email protected]",
"drop_phone": "9876543210",
"drop_state": "Maharashtra",
"drop_address": "123 ABC St",
"drop_district": "Mumbai City",
"drop_landmark": null,
"drop_pincode": "400065",
"drop_country": "IN",
"drop_address_type": "RESIDENTIAL"
},
"pickup_info": {
"pickup_lat": 25.1414664,
"pickup_city": "Mumbai",
"pickup_long": 55.255369,
"pickup_name": "TEST DO NOT PICKUP",
"pickup_time": "2022-10-271T11:52:36+04:00",
"pickup_email": "[email protected]",
"pickup_phone": "1234567890",
"pickup_state": "Maharashtra",
"pickup_address": "123, ABC St",
"pickup_district": "Mumbai City",
"pickup_landmark": null,
"pickup_phone_code": "+971",
"pickup_pincode": "400065",
"pickup_country": "IN",
"pickup_address_type": "OFFICE"
},
"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",
"color": "Blue",
"brand": "Allen Solly",
"size": "Small",
"final_amount_paid": "200.29",
"store_credits_used": "49.00"
}],
"height": 13,
"length": 23,
"weight": 1000,
"breadth": 31,
"order_id": "TESTORDER0001",
"cod_value": 50,
"order_type": "COD",
"invoice_date": "2022-06-21",
"delivery_type": "FORWARD",
"invoice_value": 468.58,
"invoice_number": "TLC-2022-06-WS-00038",
"courier_partner": "129",
"reference_number": "TESTORDER000001",
"account_code": "test"
},
"additional": {
"return_info": {
"lat": 25.1414664,
"city": "Mumbai",
"long": 55.255369,
"name": "TEST DO NOT RETURN",
"email": "[email protected]",
"phone": "1234567890",
"state": "Maharashtra",
"address": "123, ABC St",
"district": "Mumbai City",
"landmark": null,
"pincode": "400065",
"country": "IN"
},
"estimated_delivery_date":"2023-12-05",
"async": false,
"label": true,
"user_defined_field_array": [{
"name": "udf_1",
"type": "String",
"value": ""
}, {
"name": "udf_2",
"type": "String",
"value": ""
}, {
"name": "udf_3",
"type": "String",
"value": ""
}, {
"name": "udf_4",
"type": "String",
"value": ""
}]
},
"gst_info": {
"seller_gstin": "1234",
"taxable_value": 100,
"ewaybill_serial_number": "2345677",
"is_seller_registered_under_gst": false,
"sgst_tax_rate": 100,
"place_of_supply": "DELHI",
"gst_discount": 0,
"hsn_code": "1234",
"sgst_amount": 100,
"enterprise_gstin": "13",
"gst_total_tax": 100,
"igst_amount": 100,
"cgst_amount": 200,
"gst_tax_base": 200,
"consignee_gstin": "1233",
"igst_tax_rate": 100,
"invoice_reference": "1234",
"cgst_tax_rate": 100
}
}
{
"drop_info": {
"drop_lat": 0,
"drop_city": "Mumbai",
"drop_long": 0,
"drop_name": "dsadsad sadsad",
"drop_email": "[email protected]",
"drop_phone": "9876543210",
"drop_state": "Maharashtra",
"drop_address": "123 ABC St",
"drop_district": "Mumbai City",
"drop_landmark": null,
"drop_pincode": "400065",
"drop_country": "IN",
"drop_address_type": "OFFICE",
"drop_vendor_code": "test_drop"
},
"pickup_info": {
"pickup_lat": 25.1414664,
"pickup_city": "Mumbai",
"pickup_long": 55.255369,
"pickup_name": "TEST DO NOT PICKUP",
"pickup_time": "2022-10-27T11:52:36",
"email": "[email protected]",
"pickup_phone": "1234567890",
"pickup_state": "Maharashtra",
"pickup_address": "123, ABC St",
"pickup_district": "Mumbai City",
"pickup_landmark": "Near XYZ Towers",
"pickup_pincode": "400065",
"pickup_country": "IN",
"tin": "TIN000001",
"pickup_address_type": "RESIDENTIAL"
},
"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",
"product_id": "11112222333444555",
"variant_id": "66667777888999111",
"additional": {
"manufacture_country": "Italy",
"manufacture_country_code": "IT",
"cat": "Footwear",
"images": "http://link1.image.com",
"product_url": "http://link1.product.com,http://link2.procuct.com",
"return_days": 2,
"exchange_days": 2,
"length": 25,
"breadth": 15,
"height": 11,
"brand": "Tod's",
"color": "blue",
"size": "39.5",
"serial_no": "25",
"imei": "AA-BBBBBB-CCCCCC-D",
"ean": "EAN123456",
"sub_category": "Flats",
"return_reason": "ABCD"
}
}],
"height": 13,
"length": 23,
"weight": 1000,
"breadth": 31,
"order_id": "TESTORDER0001",
"cod_value": 50,
"cod_currency_code": "INR",
"order_type": "COD",
"invoice_date": "2022-06-21",
"delivery_type": "RVP",
"invoice_value": 468.58,
"invoice_number": "TLC-2022-06-WS-00038",
"courier_partner": 3,
"reference_number": "TESTECOM00001",
"account_code": "1",
"reseller_name": "ABCD",
},
"additional": {
"return_info": {
"lat": 25.1414664,
"city": "Mumbai",
"long": 55.255369,
"name": "TEST DO NOT RETURN",
"email": "[email protected]",
"phone": "1234567890",
"state": "Maharashtra",
"address": "123, ABC St",
"district": "Mumbai City",
"landmark": "Near GHI Towers",
"pincode": "400065",
"country": "IN"
},
"async": false,
"label": true,
"vendor_code": "ABC",
"zone": "ABC",
"min_edd": 2,
"max_edd": 5,
"invoice_base_64": "JWBERKLhjfswifniouNuiHFGIUEHWOWNOFOINkjno2749189",
"is_multi_seller": false,
"channel_name": "Channel 1",
"exchange_address": "123, XYZ Street",
"exchange_city": "Delhi",
"exchange_state": "Delhi",
"exchange_country": "India",
"exchange_pincode": "110001",
"exchange_shipment_description": "Exchanged due to defective product",
"otp_based_delivery": false,
"inv_url": "http://link.to.invoice.com",
"pickup_type": "WH",
"is_fragile": true,
"is_dangerous": false,
"from_wh": "SOURCE WAREHOUSE",
"to_wh": "DESTINATION WAREHOUSE",
"template_id": "123456",
"template_category": "ABCD",
"invoice_reference": "TESTINV00001",
"categories": "Footwear, Footwear",
"otp_code": "174747",
"insured": false,
"customer_id_number": "111AAA6464646",
"insurance_amount": 1125.55,
"exchange_rvp_awb": "TESTRVPAWB00001",
"rvp_reason": "Defective product",
"qc_type": "doorstep",
"order_date": "2022-11-21",
"user_defined_field_array": [{
"name": "udf_1",
"type": "String",
"value": ""
}, {
"name": "udf_2",
"type": "String",
"value": ""
}, {
"name": "udf_3",
"type": "String",
"value": ""
}, {
"name": "udf_4",
"type": "String",
"value": ""
}]
},
"gst_info": {
"seller_gstin": "1234",
"taxable_value": 100,
"ewaybill_serial_number": "2345677",
"is_seller_registered_under_gst": false,
"sgst_tax_rate": 100,
"place_of_supply": "DELHI",
"gst_discount": 0,
"hsn_code": "1234",
"sgst_amount": 100,
"enterprise_gstin": "13",
"gst_total_tax": 100,
"igst_amount": 100,
"cgst_amount": 200,
"gst_tax_base": 200,
"consignee_gstin": "1233",
"igst_tax_rate": 100,
"cgst_tax_rate": 100
}
}
{
"drop_info": {
"drop_lat": 0,
"drop_city": "Mumbai",
"drop_long": 0,
"drop_name": "dsadsad sadsad",
"drop_email": "[email protected]",
"drop_phone": "9876543210",
"drop_state": "Maharashtra",
"drop_address": "123 ABC St",
"drop_district": "Mumbai City",
"drop_landmark": null,
"drop_pincode": "400065",
"drop_country": "IN"
},
"pickup_info": {
"pickup_lat": 25.1414664,
"pickup_city": "Mumbai",
"pickup_long": 55.255369,
"pickup_name": "TEST DO NOT PICKUP",
"pickup_time": "2022-10-271T11:52:36+04:00",
"pickup_email": "[email protected]",
"pickup_phone": "1234567890",
"pickup_state": "Maharashtra",
"pickup_address": "123, ABC St",
"pickup_district": "Mumbai City",
"pickup_landmark": null,
"pickup_pincode": "400065",
"pickup_country": "IN"
},
"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"
}
],
"height": 13,
"length": 23,
"weight": 1000,
"breadth": 31,
"order_id": "TESTORDER0001",
"cod_value": 50,
"order_type": "COD",
"invoice_date": "2022-06-21",
"delivery_type": "FORWARD",
"invoice_value": 468.58,
"invoice_number": "TLC-2022-06-WS-00038",
"courier_partner": "129",
"reference_number": "TESTORDER000001",
"account_code": "test"
},
"additional": {
"return_info": {
"return_lat": 25.1414664,
"return_city": "Mumbai",
"return_long": 55.255369,
"return_name": "TEST DO NOT RETURN",
"return_email": "[email protected]",
"return_phone": "1234567890",
"return_state": "Maharashtra",
"return_address": "123, ABC St",
"return_district": "Mumbai City",
"return_landmark": null,
"return_pincode": "400065",
"return_country": "IN"
},
"async": true,
"label": true,
"vendor_code": "ABC"
},
"gst_info": {
"seller_gstin": "1234",
"taxable_value": 100,
"ewaybill_serial_number": "2345677",
"is_seller_registered_under_gst": false,
"sgst_tax_rate": 100,
"place_of_supply": "DELHI",
"gst_discount": 0,
"hsn_code": "1234",
"sgst_amount": 100,
"enterprise_gstin": "13",
"gst_total_tax": 100,
"igst_amount": 100,
"cgst_amount": 200,
"gst_tax_base": 200,
"consignee_gstin": "1233",
"igst_tax_rate": 100,
"cgst_tax_rate": 100
}
}
Sample Payload for MPS
{
"drop_info": {
"drop_lat": 0,
"drop_city": "Mumbai",
"drop_long": 0,
"drop_name": "dsadsad sadsad",
"drop_email": "[email protected]",
"drop_phone": "9876543210",
"drop_state": "Maharashtra",
"drop_address": "123 ABC St",
"drop_district": "Mumbai City",
"drop_landmark": null,
"drop_pincode": "400065",
"drop_country": "IN",
"drop_address_type": "OFFICE",
"drop_vendor_code": "test_drop"
},
"pickup_info": {
"pickup_lat": 25.1414664,
"pickup_city": "Mumbai",
"pickup_long": 55.255369,
"pickup_name": "TEST DO NOT PICKUP",
"pickup_time": "2022-10-271T11:52:36+04:00",
"pickup_email": "[email protected]",
"pickup_phone": "1234567890",
"pickup_state": "Maharashtra",
"pickup_address": "123, ABC St",
"pickup_district": "Mumbai City",
"pickup_landmark": null,
"pickup_pincode": "400065",
"pickup_country": "IN",
"pickup_address_type": "RESIDENTIAL"
},
"shipment_details": {
"items": [
{
"sku": "53813",
"price": 249.29,
"weight": 500,
"hs_code": "6405.10.00",
"quantity": 1,
"description": "Tod's Blue Shoes",
"additional": {
"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": 25,
"breadth": 15,
"height": 11,
"brand": "Tod's",
"color": "blue",
"size": "39.5",
"serial_no": "25",
"imei": "AA-BBBBBB-CCCCCC-D",
"ean": "EAN123456",
"sub_category": "Flats",
"return_reason": "ABCD"
},
"gst_info": {
"hsn_code": "84713010",
"cgst_amount": "4193.1",
"igst_amount": "8386.2",
"sgst_amount": "4193.1",
"gst_discount": "0",
"seller_gstin": "34AACCA1237A1ZK",
"cgst_tax_rate": "9",
"gst_total_tax": "16772.4",
"igst_tax_rate": "18",
"sgst_tax_rate": "9",
"taxable_value": "46590",
"consignee_gstin": "09AAACH2702H1ZY",
"place_of_supply": "09",
"enterprise_gstin": "34AACCA1237A1ZK",
"ewaybill_serial_number": "NA",
"is_seller_registered_under_gst": true,
"invoice_reference": "TESTINV00001"
}
},
{
"sku": "53814",
"price": 109.99,
"weight": 100,
"hs_code": "6405.10.21",
"quantity": 1,
"description": "Tod's Blue Shirt, Size L",
"additional": {
"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": 25,
"breadth": 15,
"height": 11,
"brand": "Tod's",
"color": "blue",
"size": "39.5",
"serial_no": "25",
"imei": "AA-BBBBBB-CCCCCC-D",
"ean": "EAN123456",
"sub_category": "Flats",
"return_reason": "ABCD"
},
"gst_info": {
"hsn_code": "84713010",
"cgst_amount": "4193.1",
"igst_amount": "8386.2",
"sgst_amount": "4193.1",
"gst_discount": "0",
"seller_gstin": "34AACCA1237A1ZK",
"cgst_tax_rate": "9",
"gst_total_tax": "16772.4",
"igst_tax_rate": "18",
"sgst_tax_rate": "9",
"taxable_value": "46590",
"consignee_gstin": "09AAACH2702H1ZY",
"place_of_supply": "09",
"enterprise_gstin": "34AACCA1237A1ZK",
"ewaybill_serial_number": "NA",
"is_seller_registered_under_gst": true,
"invoice_reference": "TESTINV00001"
}
}
],
"height": 13,
"length": 23,
"weight": 1000,
"breadth": 31,
"order_id": "TESTORDER0001",
"cod_value": 50,
"cod_currency_code": "INR",
"order_type": "COD",
"invoice_date": "2022-06-21",
"delivery_type": "FORWARD",
"invoice_value": 468.58,
"invoice_number": "TLC-2022-06-WS-00038",
"courier_partner": 3,
"reference_number": "TESTECOM00001",
"account_code": "1",
"reseller_name": "ABCD",
"booking_id": "123456",
},
"additional": {
"return_info": {
"lat": 25.1414664,
"city": "Mumbai",
"long": 55.255369,
"name": "TEST DO NOT RETURN",
"email": "[email protected]",
"phone": "1234567890",
"state": "Maharashtra",
"address": "123, ABC St",
"district": "Mumbai City",
"landmark": "Near GHI Towers",
"pincode": "400065",
"country": "IN"
},
"estimated_delivery_date":"2023-12-05",
"async": false,
"label": true,
"vendor_code": "ABC",
"zone": "ABC",
"min_edd": 2,
"max_edd": 5,
"qc_type": "doorstep",
"invoice_base_64": "JWBERKLhjfswifniouNuiHFGIUEHWOWNOFOINkjno2749189",
"is_multi_seller": false,
"channel_name": "Channel 1",
"exchange_address": "123, XYZ Street",
"exchange_city": "Delhi",
"exchange_state": "Delhi",
"exchange_country": "India",
"exchange_pincode": "110001",
"exchange_shipment_description": "Exchanged due to defective product",
"otp_based_delivery": false,
"inv_url": "http://link.to.invoice.com",
"pickup_type": "WH",
"is_fragile": true,
"is_dangerous": false,
"from_wh": "SOURCE WAREHOUSE",
"to_wh": "DESTINATION WAREHOUSE",
"template_id": "123456",
"template_category": "ABCD",
"invoice_reference": "TESTINV00001",
"categories": "Footwear, Footwear",
"otp_code": "174747",
"insured": false,
"customer_id_number": "111AAA6464646",
"insurance_amount": 1125.55,
"exchange_rvp_awb": "TESTRVPAWB00001",
"fareye_order_type": "ABC",
"duty_fee_paid_by": "S",
"order_date": "2022-11-21"
},
"gst_info": {
"seller_gstin": "1234",
"seller_name": "ABCD Apparel",
"taxable_value": 100,
"ewaybill_serial_number": "2345677",
"is_seller_registered_under_gst": false,
"sgst_tax_rate": 100,
"place_of_supply": "DELHI",
"gst_discount": 0,
"hsn_code": "1234",
"sgst_amount": 100,
"enterprise_gstin": "13",
"gst_total_tax": 100,
"igst_amount": 100,
"cgst_amount": 200,
"gst_tax_base": 200,
"consignee_gstin": "1233",
"igst_tax_rate": 100,
"cgst_tax_rate": 100
}
}
{
"drop_info": {
"drop_lat": 0,
"drop_city": "Mumbai",
"drop_long": 0,
"drop_name": "dsadsad sadsad",
"drop_email": "[email protected]",
"drop_phone": "9876543210",
"drop_state": "Maharashtra",
"drop_address": "123 ABC St",
"drop_district": "Mumbai City",
"drop_landmark": null,
"drop_pincode": "400065",
"drop_country": "IN",
"drop_address_type": "OFFICE"
},
"pickup_info": {
"pickup_lat": 25.1414664,
"pickup_city": "Mumbai",
"pickup_long": 55.255369,
"pickup_name": "TEST DO NOT PICKUP",
"pickup_time": "2022-10-271T11:52:36+04:00",
"pickup_email": "[email protected]",
"pickup_phone": "1234567890",
"pickup_state": "Maharashtra",
"pickup_address": "123, ABC St",
"pickup_district": "Mumbai City",
"pickup_landmark": null,
"pickup_pincode": "400065",
"pickup_country": "IN",
"pickup_address_type": "RESIDENTIAL"
},
"shipment_details": {
"items": [
{
"sku": "UN.VPKSI.068",
"price": "46590",
"height": "29",
"images": null,
"length": "46",
"weight": "2600",
"breadth": "7",
"additional": {
"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": 25,
"width": 15,
"height": 11,
"brand": "Tod's",
"color": "blue",
"size": "39.5",
"serial_no": "25",
"imei": "AA-BBBBBB-CCCCCC-D",
"ean": "EAN123456",
"sub_category": "Flats",
"return_reason": "ABCD"
},
"gst_info": {
"hsn_code": "84713010",
"cgst_amount": "4193.1",
"igst_amount": "8386.2",
"sgst_amount": "4193.1",
"gst_discount": "0",
"seller_gstin": "34AACCA1237A1ZK",
"cgst_tax_rate": "9",
"gst_total_tax": "16772.4",
"igst_tax_rate": "18",
"sgst_tax_rate": "9",
"taxable_value": "46590",
"consignee_gstin": "09AAACH2702H1ZY",
"place_of_supply": "09",
"enterprise_gstin": "34AACCA1237A1ZK",
"ewaybill_serial_number": "NA",
"is_seller_registered_under_gst": true
},
"quantity": 1,
"description": "box1",
"brand": "XYZ",
"color": "green",
"size": "6x6",
"serial_no": "25",
"imei": "AA-BBBBBB-CCCCCC-D",
"ean": "EAN123456",
"sub_category": "Towel"
},
{
"sku": "5W.50664.658",
"price": "550",
"height": "53",
"images": null,
"length": "39",
"weight": "500",
"breadth": "12",
"additional": {
"manufacture_country": "Italy",
"manufacture_country_code": "IT",
"cat": "Footwear",
"images": "http://link1.image.com",
"product_url": "http://link1.product.com,http://link2.procuct.com",
"return_days": 2,
"exchange_days": 2,
"length": 25,
"width": 15,
"height": 11,
"brand": "Tod's",
"color": "blue",
"size": "39.5",
"serial_no": "25",
"imei": "AA-BBBBBB-CCCCCC-D",
"ean": "EAN123456",
"sub_category": "Flats",
"return_reason": "ABCD"
},
"gst_info": {
"hsn_code": "84713010",
"cgst_amount": "4193.1",
"igst_amount": "8386.2",
"sgst_amount": "4193.1",
"gst_discount": "0",
"seller_gstin": "34AACCA1237A1ZK",
"cgst_tax_rate": "9",
"gst_total_tax": "16772.4",
"igst_tax_rate": "18",
"sgst_tax_rate": "9",
"taxable_value": "46590",
"consignee_gstin": "09AAACH2702H1ZY",
"place_of_supply": "09",
"enterprise_gstin": "34AACCA1237A1ZK",
"ewaybill_serial_number": "NA",
"is_seller_registered_under_gst": true
},
"quantity": 1,
"description": "box2",
"brand": "XYZ",
"color": "yellow",
"size": "6x6",
"serial_no": "25",
"imei": "AA-BBBBBB-CCCCCC-D",
"ean": "EAN123456",
"sub_category": "Towel"
}
],
"height": 13,
"length": 23,
"weight": 1000,
"breadth": 31,
"order_id": "TESTORDER0001",
"cod_value": 50,
"order_type": "COD",
"invoice_date": "2022-06-21",
"delivery_type": "FORWARD",
"invoice_value": 468.58,
"invoice_number": "TLC-2022-06-WS-00038",
"courier_partner": 129,
"reference_number": "TESTORDER000001",
"account_code": "test"
},
"additional": {
"return_info": {
"return_lat": 25.1414664,
"return_city": "Mumbai",
"return_long": 55.255369,
"return_name": "TEST DO NOT RETURN",
"return_email": "[email protected]",
"return_phone": "1234567890",
"return_state": "Maharashtra",
"return_address": "123, ABC St",
"return_district": "Mumbai City",
"return_landmark": null,
"return_pincode": "400065",
"return_country": "IN"
},
"async": false,
"label": true,
"vendor_code": "ABC",
"rvp_reason": "Cancelled",
"qc_type": "doorstep"
},
"gst_info": {
"seller_gstin": "1234",
"taxable_value": 100,
"ewaybill_serial_number": "2345677",
"is_seller_registered_under_gst": false,
"sgst_tax_rate": 100,
"place_of_supply": "DELHI",
"gst_discount": 0,
"hsn_code": "1234",
"sgst_amount": 100,
"enterprise_gstin": "13",
"gst_total_tax": 100,
"igst_amount": 100,
"cgst_amount": 200,
"gst_tax_base": 200,
"consignee_gstin": "1233",
"igst_tax_rate": 100,
"cgst_tax_rate": 100
}
}
{
"drop_info": {
"drop_lat": 0,
"drop_city": "Mumbai",
"drop_long": 0,
"drop_name": "dsadsad sadsad",
"drop_email": "[email protected]",
"drop_phone": "9876543210",
"drop_state": "Maharashtra",
"drop_address": "123 ABC St",
"drop_district": "Mumbai City",
"drop_landmark": null,
"drop_pincode": "400065",
"drop_country": "IN",
"drop_address_type": "OFFICE"
},
"pickup_info": {
"pickup_lat": 25.1414664,
"pickup_city": "Mumbai",
"pickup_long": 55.255369,
"pickup_name": "TEST DO NOT PICKUP",
"pickup_time": "2022-10-271T11:52:36+04:00",
"pickup_email": "[email protected]",
"pickup_phone": "1234567890",
"pickup_state": "Maharashtra",
"pickup_address": "123, ABC St",
"pickup_district": "Mumbai City",
"pickup_landmark": null,
"pickup_pincode": "400065",
"pickup_country": "IN",
"pickup_address_type": "RESIDENTIAL"
},
"shipment_details": {
"items": [
{
"sku": "UN.VPKSI.068",
"price": "46590",
"height": "29",
"images": null,
"length": "46",
"weight": "2600",
"breadth": "7",
"gst_info": {
"hsn_code": "84713010",
"cgst_amount": "4193.1",
"igst_amount": "8386.2",
"sgst_amount": "4193.1",
"gst_discount": "0",
"seller_gstin": "34AACCA1237A1ZK",
"cgst_tax_rate": "9",
"gst_total_tax": "16772.4",
"igst_tax_rate": "18",
"sgst_tax_rate": "9",
"taxable_value": "46590",
"consignee_gstin": "09AAACH2702H1ZY",
"place_of_supply": "09",
"enterprise_gstin": "34AACCA1237A1ZK",
"ewaybill_serial_number": "NA",
"is_seller_registered_under_gst": true
},
"quantity": 1,
"description": "box1"
},
{
"sku": "5W.50664.658",
"price": "550",
"height": "53",
"images": null,
"length": "39",
"weight": "500",
"breadth": "12",
"gst_info": {
"hsn_code": "84713010",
"cgst_amount": "4193.1",
"igst_amount": "8386.2",
"sgst_amount": "4193.1",
"gst_discount": "0",
"seller_gstin": "34AACCA1237A1ZK",
"cgst_tax_rate": "9",
"gst_total_tax": "16772.4",
"igst_tax_rate": "18",
"sgst_tax_rate": "9",
"taxable_value": "46590",
"consignee_gstin": "09AAACH2702H1ZY",
"place_of_supply": "09",
"enterprise_gstin": "34AACCA1237A1ZK",
"ewaybill_serial_number": "NA",
"is_seller_registered_under_gst": true
},
"quantity": 1,
"description": "box2"
}
],
"height": 13,
"length": 23,
"weight": 1000,
"breadth": 31,
"order_id": "TESTORDER0001",
"cod_value": 50,
"order_type": "COD",
"invoice_date": "2022-06-21",
"delivery_type": "FORWARD",
"invoice_value": 468.58,
"invoice_number": "TLC-2022-06-WS-00038",
"courier_partner": 129,
"reference_number": "TESTORDER000001",
"account_code": "test"
},
"additional": {
"return_info": {
"return_lat": 25.1414664,
"return_city": "Mumbai",
"return_long": 55.255369,
"return_name": "TEST DO NOT RETURN",
"return_email": "[email protected]",
"return_phone": "1234567890",
"return_state": "Maharashtra",
"return_address": "123, ABC St",
"return_district": "Mumbai City",
"return_landmark": null,
"return_pincode": "400065",
"return_country": "IN"
},
"async": true,
"label": true,
"vendor_code": "ABC"
},
"gst_info": {
"seller_gstin": "1234",
"taxable_value": 100,
"ewaybill_serial_number": "2345677",
"is_seller_registered_under_gst": false,
"sgst_tax_rate": 100,
"place_of_supply": "DELHI",
"gst_discount": 0,
"hsn_code": "1234",
"sgst_amount": 100,
"enterprise_gstin": "13",
"gst_total_tax": 100,
"igst_amount": 100,
"cgst_amount": 200,
"gst_tax_base": 200,
"consignee_gstin": "1233",
"igst_tax_rate": 100,
"cgst_tax_rate": 100
}
}
Sample Response for SPS
We can either get a 200 (OK) or a 400 (Bad Request) error as follows
{
"result": {
"waybill": "ABCD0000001",
"reference_number": "TESTORDER00001",
"label": "https://pyck-res-bucket.s3.amazonaws.com:443/TEST_COURIER/2022-10-21/ABCD0000001.pdf",
"courier_partner_id": 123,
"courier_name": "Test Courier",
"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
}
}
{
"order_id": 8488863,
"result": {
"waybill": null,
"sort_code": null,
"security_key": null,
"label": null,
"reference_number": "TEST-ALPHA-132135"
},
"meta": {
"message": "We are processing your order",
"success": false,
"status": 102
}
}
{
"meta": {
"success": true,
"message": "Order Placed Successfully",
"status": 202
},
"order_id": 8488542,
"result": {
"reference_number": "TEST-ALPHA-132135",
"waybill": null,
"label": null,
"sort_code": null
}
}
Sample Response for MPS
{
"meta":{
"status":200,
"message":"Order Placed Successfully",
"success":true
},
"result":{
"label":"https://pyck-res-bucket.s3.amazonaws.com:443/BLUEDART/2022-11-10/53435204782.pdf",
"waybill":"53435204782",
"children":[
{
"item":{
"sku":"UN.VPKSI.068",
"price":46590,
"height":"29",
"images":null,
"length":"46",
"weight":"2600",
"breadth":"7",
"waybill":"53435204782-0001",
"gst_info":{
"hsn_code": "84713010",
"cgst_amount": "4193.1",
"igst_amount": "8386.2",
"sgst_amount": "4193.1",
"gst_discount": "0",
"seller_gstin": "34AACCA1237A1ZK",
"cgst_tax_rate": "9",
"gst_total_tax": "16772.4",
"igst_tax_rate": "18",
"sgst_tax_rate": "9",
"taxable_value": "46590",
"consignee_gstin": "09AAACH2702H1ZY",
"place_of_supply": "09",
"enterprise_gstin": "34AACCA1237A1ZK",
"ewaybill_serial_number": "NA",
"is_seller_registered_under_gst": true
},
"quantity":"1",
"description":"box1"
},
"label":"https://pyck-res-bucket.s3.amazonaws.com:443/BLUEDART/2022-11-10/53435204782.pdf",
"waybill":"53435204782-0001",
"DestinationArea":"NDA",
"reference_number":"PYSI22050862",
"DestinationLocation":"NDO"
},
{
"item":{
"sku":"5W.50664.658",
"price":550,
"height":"53",
"images":null,
"length":"39",
"weight":"500",
"breadth":"12",
"waybill":"53435204782-0002",
"gst_info":{
"hsn_code": "84713010",
"cgst_amount": "4193.1",
"igst_amount": "8386.2",
"sgst_amount": "4193.1",
"gst_discount": "0",
"seller_gstin": "34AACCA1237A1ZK",
"cgst_tax_rate": "9",
"gst_total_tax": "16772.4",
"igst_tax_rate": "18",
"sgst_tax_rate": "9",
"taxable_value": "46590",
"consignee_gstin": "09AAACH2702H1ZY",
"place_of_supply": "09",
"enterprise_gstin": "34AACCA1237A1ZK",
"ewaybill_serial_number": "NA",
"is_seller_registered_under_gst": true
},
"quantity":"1",
"description":"box2"
},
"label":"https://pyck-res-bucket.s3.amazonaws.com:443/BLUEDART/2022-11-10/53435204782.pdf",
"waybill":"53435204782-0002",
"DestinationArea":"NDA",
"reference_number":"PYSI22050862",
"DestinationLocation":"NDO"
}
],
"order_id": "1383554",
"sort_code": "NDA/NDO",
"courier_name": "Bluedart",
"security_key": "d410db64-6033-4601-8a24-6c6ba440888f",
"token_number": "14786970",
"DestinationArea": "NDA",
"reference_number": "PYSI22050862",
"courier_partner_id": 129,
"DestinationLocation": "NDO"
},
"order_id":151848508,
"tracking_id":507531070
}
{
"meta": {
"status": 400,
"message": "Error Message",
"success": false
}
}
{
"order_id": 8488863,
"result": {
"waybill": null,
"sort_code": null,
"security_key": null,
"label": null,
"reference_number": "TEST-ALPHA-132135"
},
"meta": {
"message": "We are processing your order",
"success": false,
"status": 102
}
}
{
"meta": {
"success": true,
"message": "Order Placed Successfully",
"status": 202
},
"order_id": 8488542,
"result": {
"reference_number": "TEST-ALPHA-132135",
"waybill": null,
"label": null,
"sort_code": null
}
}
Payload
The payload will consist of the following fields:
| Field Name | Data Type | Field | Description | Max Length | Example |
|---|---|---|---|---|---|
pickup_info | Object | Mandatory | Information for where the shipment will be picked up by the carrier | ||
drop_info | Object | Mandatory | Information for where the shipment will be delivered by the carrier | ||
shipment_details | Object | Mandatory | Information about the shipment itself | ||
additional | Object | Optional | Additional optional information about the shipment |
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 |
|---|---|---|---|
pickup_lat | Float | Conditional Mandatory* | Latitude of the pickup location. To review conditional mandatory refer to this doc here |
pickup_long | Float | Conditional Mandatory* | Longitude of the pickup location |
pickup_name | String | Mandatory | Contact name of the consignor of the shipment |
pickup_address | String | Mandatory | Address of the pickup location |
pickup_district | String | Optional | District of the pickup location |
pickup_city | String | Mandatory | City of the pickup location |
pickup_state | String | Mandatory | State/province of the pickup location |
pickup_landmark | String | Optional | Landmarks to help find the pickup location |
email | String | Mandatory | Email of the pickup contact |
pickup_phone | String | Mandatory | Contact number of the pickup contact |
pickup_time | String | Mandatory | Time of pickup for the order (to be provided in YYYY-MM-DDTHH:MM:SS format only) |
pickup_pincode | String | Mandatory | 6-digit Pin code of the pickup location |
pickup_country | String | Mandatory | Alpha ISO-2 country code of the pickup location. Only "IN" is accepted as input. |
tin | String | Mandatory | Taxpayer Identification Number (TIN) of the seller. In case the TIN is not available, the user may choose to enter the seller's GST number instead. |
pickup_address_type | String | Optional | Address type of the pickup address. 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 |
|---|---|---|---|
drop_lat | Float | Optional | Latitude of the drop location |
drop_long | Float | Optional | Longitude of the drop location |
drop_name | String | Mandatory | Contact name of the consignee of the shipment |
drop_address | String | Mandatory | Address of the drop location |
drop_district | String | Optional | District of the drop location |
drop_city | String | Mandatory | City of the drop location |
drop_state | String | Mandatory | State/province of the drop location |
drop_landmark | String | Optional | Landmarks to help find the drop location |
drop_email | String | Optional | Email of the drop contact |
drop_phone | String | Mandatory | Contact number of the drop contact |
drop_time | String | Optional | Estimated time of drop for the order (to be provided in YYYY-MM-DDTHH:MM:SS format only) |
drop_pincode | String | Mandatory | 6-digit Pin code of the drop location |
drop_country | String | Mandatory | Alpha ISO-2 country code of the drop location. Only "IN" is accepted as input. |
drop_address_type | String | Optional | Address type of the drop address. Must be either OFFICE or RESIDENTIAL |
drop_vendor_code | String | Optional | Hub code of the drop address (if the drop address is a warehouse) |
Additional Fields (additional)
additional)In the "additional" object optional fields can be passed which may be used by the carrier, 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 |
|---|---|---|---|
async | Boolean | Optional | Whether the order will be placed asynchronously (in the background) or not (in real-time). Defaults to false. Please read the section "Processing Async Requests" for how async requests work. |
label | Boolean | Optional | Whether label is required for the order or not. Defaults to true. |
zone | String | Optional | Zone of the location of pickup |
min_edd | Integer | Optional | Minimum estimated due date (in days) for delivery of the shipment |
max_edd | Integer | Optional | Maximum estimated due date (in days) for delivery of the shipment |
invoice_base_64 | String | Optional | A Base64 string representation of the invoice document file |
is_multi_seller | Boolean | Conditional | Required for multi-seller shipments only. Denotes whether the shipment has multiple items, each with different GST numbers. Defaults to false |
vendor_code | String | Optional | Vendor code of pickup location. Not supported for all carriers |
qc_type | String/Null | Optional | Only applicable for RVP. Should be set to doorstep if the carrier needs to do a quality check for the item, otherwise null. |
rvp_reason | String | Conditional | Reason for returning the product/failed delivery. Mandatory if delivery_type is RVP. |
order_date | String | Optional | Date when the order was placed for this shipment. To be provided in YYYY-MM-DD format only |
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 optionalreturn_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 |
pincode | String | Mandatory | 6-digit Pin code of the return location |
country | String | Mandatory | Alpha ISO-2 country code of the return location. Only "IN" is accepted as input. |
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, carrier, etc. are added.
| Field Name | Data Type | Field | Description |
|---|---|---|---|
items | Listck:param | Mandatory | List of items to be delivered in the shipment. Details of the items explained below. |
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) |
breadth | Float | Mandatory | Breadth 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. Note: For Bluedart, the reference number should not go beyond 20 characters, or else the AWB generation will fail |
cod_value | Float | Conditional Mandatory | Cash to be given to the carrier (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", "EXCHANGE" or "PREPAID". cod_value must be non-zero for COD shipments and zero for PREPAID shipments. "EXCHANGE" is only applicable for Delhivery (Partner ID: 4) and Bluedart (Partner ID: 5) |
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 | Conditional Mandatory | The airwaybill number of the shipment. Mandatory for the following couriers - Shadowfax Forward (Partner ID: 9) - Fareye (Partner ID: 31) - Gati (Partner ID: 32) - SELF Reverse (Partner ID: 34) - SELF (Partner ID: 35) - Gati MPS (Partner ID: 71) - Holisol Reverse (Partner ID: 77) - Trackon (Partner ID: 80) - Sicepat (Partner ID: 116) - Ithink Logistics (Partner ID: 170) - Swftbox (Partner ID: 202) - KerryIndev MPS (Partner ID: 259) |
Reference Number should not exceed 20 characters
For Bluedart, the reference number should not go beyond 20 characters, or else the AWB generation will fail
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 |
|---|---|---|---|
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) |
gst_info | Object | Conditional | Required for multi-seller shipments Information regarding the GST levied on the item. GST Info to be passed will have the same fields as the gst_infofield mentioned below. |
final_amount_paid | String | Optional | The Final amount that the customer has paid for the item after deducting store credits, discounts, vouchers etc |
store_credits_used | String | Optional | The store credits used to purchase the item |
product_id | String | Conditional Optional | Needed only if customer has subscribed for Exchanges platform (Currently only supported for Shopify) Product ID of the item in Shopify storefront |
variant_id | String | Conditional Optional | Needed only if customer has subscribed for Exchanges platform (Currently only supported for Shopify) Variant ID of the item (mentioned in product_id) in Shopify storefront |
The item's additional object can have the following fields:
| Field Name | Data Type | Field | Description |
|---|---|---|---|
cat | String | Optional | Category of the item in question |
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. |
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 |
GST Info (gst_info)
gst_info)This object encapsulates every information about the Goods and Services Tax (GST) levied on the shipment, and all it's requisite details, e.g. GST Number, EWaybill Number, etc.
| Field | Data Type | Field | Description |
|---|---|---|---|
enterprise_gstin | String | Optional | GST No of enterprise shipping the shipment |
seller_gstin | String | Optional | GST No of seller sending the shipment (will be different from above for marketplaces) |
taxable_value | Float | Optional | Taxable amount for GST (in INR) |
ewaybill_serial_number | String | Optional | EWaybill Serial Number for the shipment |
is_seller_registered_under_gst | Boolean | Optional | Whether the enterprise/seller is registered under the GST law |
place_of_supply | String | Optional | Place of supply of the service or product. Please refer to https://cleartax.in/s/gst-state-code-jurisdiction for further details |
gst_discount | Float | Optional | Discount under GST, if any |
hsn_code | String | Optional | Harmonized System Nomenclature Code of the product. Please refer to https://cleartax.in/s/gst-hsn-lookup for knowing the code for your products. |
gst_total_tax | Float | Optional | Total GST applicable for the shipment (in INR) |
sgst_tax_rate | Float | Optional | Tax percent applicable for SGST for the shipment |
sgst_amount | Float | Optional | SGST Amount levied on the shipment (in INR) |
igst_tax_rate | Float | Optional | Tax percent applicable for IGST for the shipment |
igst_amount | Float | Optional | IGST Amount levied on the shipment (in INR) |
cgst_tax_rate | Float | Optional | Tax percent applicable for CGST for the shipment |
cgst_amount | Float | Optional | CGST Amount levied on the shipment (in INR) |
consignee_gstin | String | Conditional | GST No of consignee (compulsory for B2B shipments) |
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/carrier.
| 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. 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 carriers) URL to the generated commercial invoice of the order |
courier_partner_id | Integer | ID of the carrier |
courier_name | String | Name of the carrier |
sort_code | String/Null | Carrier Sort code. Certain carriers 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" |
| 202 | 200 | For async orders: The async order request has been successfully registered. | Need to poll the same API endpoint with the same reference number (the one used to register the order) to get the results of the request. | Order may succeed or fail | "Order Registered Successfully" |
| 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, or check the username. | 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" |
| 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 carrier defined by the courier_partner field does not support RVP shipments, or is not an RVP carrier. | 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 carrier 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 carrier. | The actual error generally pops up alongside the error message (see Status 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 carrier's servers. | Need to retry after waiting for a while, or get in touch with Clickpost support or the carrier's 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 carrier's API timed out. | Need to retry after waiting for a while, or get in touch with Clickpost support or the carrier support. | No | "Courier Partner API timeout" |
| 351 | 200 | The account name of the carrier 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 - Carrier ID in the courier_partner field.- Account name in the account_code field, and whether this account exists for this carrier.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 carrier 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 carrier'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" |