Custom Order Creation Fields for Certain Carrier Partners

Overview

Clickpost has integrated over 300+ courier partners (as of 31st October 2022). The data that we take in from enterprise customers in our Order Creation APIs suffice for most courier partners, but some partners require extra fields that the enterprise needs to send in the payload.

Table of Custom Fields for both Indian and International Couriers

The following table has all the information regarding which couriers are taking in which custom fields.

Courier Partners (Partner ID)	Field Name	Parent Object	Data Type	Description	Field	Max Length	Example
Delhivery (4) Delhivery RVP (25) Loadshare (50)	`reseller_name`	`shipment_details`	String	Name of the reseller of the order. Clickpost will primarily look for `reseller_name` in the payload, and if it is not found, will send the `name` value in `pickup_info` instead.	Optional	100	"Mr. ABC"
Delhivery (4) Shipsy (150) XpressBees (6) EcomExpress (3) Smartr (250)	`otp_based_delivery`	`additional`	Boolean	Whether the delivery of the shipment will have OTP authentication or not from the end-customer's end.	Optional		true/false
Delhivery (4)	`exchange_address`	`additional`	String	For exchange orders, the address where the old item will be sent to for exchange	Optional	500	"123, ABC Street"
Delhivery (4)	`exchange_city`	`additional`	String	For exchange orders, the city where the old item will be sent to for exchange	Optional	100	"Mumbai"
Delhivery (4)	`exchange_state`	`additional`	String	For exchange orders, the state where the old item will be sent to for exchange	Optional	100	"Maharashtra"
Delhivery (4)	`exchange_country`	`additional`	String	For exchange orders, the Alpha-2 ISO country code where the old item will be sent to for exchange	Optional	2	"IN"
Delhivery (4)	`exchange_pincode`	`additional`	String	For exchange orders, the pincode where the old item will be sent to for exchange	Optional	10	"400019"
Delhivery (4)	`exchange_shipment_description`	`additional`	String	For exchange orders, the description of the shipment to be exchanged.	Optional	100	"XYZ Brand T-Shirts, Size L, 10 Pcs"
Delhivery (4) Delhivery RVP (25)	`booking_id`	`shipment_details`	String	Booking ID of the shipment	Optional	100	"TESTBOOKING00001"
Delhivery (4) Delhivery RVP (25) EKart (55)	`is_fragile`	`shipment_details`	Boolean	Whether the shipment itself is fragile/has fragile components/has at least one fragile item. Defaults to `false`	Optional
Delhivery (4) Delhivery RVP (25) EKart (55) EcomExpress (3)	`is_dangerous`	`shipment_details`	Boolean	Whether the shipment has inflammable/reactive or any items that may cause other sorts of danger. Defaults to `false`	Optional
Delhivery (4)	`inv_url`	`additional`	String	Invoice URL of the order	Optional
EcomExpress (3)	`pickup_type`	`additional`	String	Acceptable values: “WH” (for warehouse pickup) / “SL” (for seller pickup [marketplace]). This value is passed to EcomExpress only	Optional	2	"WH"/"SL"
EcomExpress (3)	`seller_name`	`gst_info`	String	Name of the seller of the item. Required for multi-seller shipments	Conditional Mandatory	100	"Mr. XYZ"
XpressBees RVP (41)	`template_id`	`additional`	String	ID of the template to be used for Quality Check of the items being returned.	Optional	100
XpressBees RVP (41)	`template_category`	`additional`	String	Category of the template being used for Quality Check	Optional	100
XpressBees RVP (41)	`drop_alternate_phone`	`drop_info`	String	Alternate phone number of the delivery contact	Optional	12	"9876543210"
XpressBees RVP (41) Bluedart RVP (28)	`invoice_reference`	`shipment_details`->`items`->`gst_info`, `gst_info`	String	Reference number for the invoice of the order (in case of multi-seller shipments)	Conditional Mandatory	100	"TESTINV00011"
XpressBees RVP (41) Shadowfax RVP (11)	`brand`	`shipment_details`->`items`	String	Brand of the item (for QC check)	Optional	100	"ABC Brand"
XpressBees RVP (41) Shadowfax RVP (11)	`color`	`shipment_details`->`items`	String	Color of the item (for QC Check)	Optional	100	"Blue"
XpressBees RVP (41) Shadowfax RVP (11)	`size`	`shipment_details`->`items`	String	Size of the item	Optional	100	"XXL"
Bluedart (5) Bluedart RVP (28)	`categories`	`additional`	String	Comma-separated list of categories of the items being shipped (???)	Optional	100	"Footwear, Toys, Gadgets"
Bluedart (5) Bluedart RVP (28)	`otp_code`	`additional`	String	In case of Last-Mile shipments, if there are any predefined OTPs to be confirmed with the customer, that OTP code is to be provided	Optional	10	"1234"
EKart (55), Shadowfax RVP (11)	`serial_no`	`shipment_details`->`items`	String	Serial number of the item	Optional	20	"11223344"
Fareye (31)	`fareye_store_id`	`additional`	String	Store ID registered by the enterprise with Fareye	Optional	20	"fareyestore1"
Fareye (31)	`fareye_order_type`	`additional`	String	Order type of the shipment being placed with Fareye	Optional	20
Aramex (2)	`duty_fee_paid_by`	`additional`	String	Denotes which party will be paying the duty fees (if any) for the shipment. Can take values "R" for receiver and "S" for shipper. Defaults to "R".	Optional	1
Aramex (2), DHL International (145) DHL International Reverse (159)	`cod_currency_code`	`shipment_details`	String	3-letter currency code for COD orders. If not passed, the `currency_code`value will be used instead	Optional	3	"SAR"
DHL International (145) DHL International Reverse (159)	`manufacture_country`	`shipment_details`->`items`	String	Full Name of the country of manufacture of the item	Optional	100	"India"
DHL International (145) DHL International Reverse (159)	`manufacture_country_code`	`shipment_details`->`items`	String	Alpha-2 ISO Code of the country of manufacture of the item	Mandatory	2	"IN"
DHL International (145) DHL International Reverse (159)	`hs_code`	`shipment_details`->`items`	String	Harmonized system code of the item	Mandatory	100	"1234.56.78"
DHL International (145) DHL International Reverse (159) DHL India Cross Border MPS (326)	`inbound_hs_code`	`shipment_details`->`items`	String	Inbound HSN Code i.e. Shipment's HSN Code for the country where the shipment is getting shipped to (being imported into)
DHL International (145) DHL International Reverse (159)	`insured`	`additional`	Boolean	Whether the shipment is insured. Defaults to `false`	Optional
DHL International (145) DHL International Reverse (159)	`customer_id_number`	`additional`	String/Boolean	Customer ID number who will be using the API. Defaults to `false`	Optional	100	"TESTCUSTOMER0001"
DHL International (145) DHL International Reverse (159)	`insurance_amount`	`additional`	Float	Insurance amount of the shipment. Only applicable when `insured` is true. Defaults to 0	Conditional Optional		25.20
DHL International (145) DHL International Reverse (159) Bluedart International (213) Fedex International (168) Fedex International MPS Reverse (199) Fedex International Reverse (200) Fedex International MPS Forward (198) DHL India Cross Border MPS (326) Fedex India Cross Border MPS (330)	`invoice_base_64`	`additional`	String/Null	Base64 representation of the invoice of the order. Defaults to `null`. Takes in commercial invoice for cross-border shipments, and normal invoice for other shipments. Used by the following couriers: - Bluedart International (213) - DHL International (145) - Fedex International (168) Mandatory for cross-border shipments	Conditional Mandatory	1000
Shadowfax RVP (11)	`imei`	`shipment_details`->`items`	String	IMEI number of the item (if the item is a mobile device)	Optional	100	"AA-BBBBBB-CCCCCC-D"
Bluedart RVP (28)	`exchange_rvp_awb`	`additional`	String	The AWB number for tracking the reverse exchange. Applicable only for "EXCHANGE" orders.	Conditional Optional	100	"TESTEXCHAWB00001"
Fareye RVP (38)	`gst_tax_base`	`gst_info`	String		Mandatory
	`pickup_lat`	`pickup_info`	Float	Latitude of the location of pickup of the order	Conditional Mandatory		45.11221
	`pickup_long`	`pickup_info`	Float	Longitude of the location of pickup of the order	Conditional Mandatory		88.11111
	`drop_lat`	`drop_info`	Float	Latitude of the location of delivery of the order	Conditional Mandatory		45.11221
	`drop_long`	`drop_info`	Float	Longitude of the location of delivery of the order	Conditional Mandatory		88.11111
Fedex MPS Cross-Border	`payor_fedex_account_number`	`courier_custom_fields`	String	Account number of the Fedex account	Conditional