OVERVIEW
OVERVIEW
AUTHENTICATION
AUTHENTICATION
ENDPOINTS
Shipping Label
Close-Out
Manifest
Tracking
ENDPOINTS
Shipping Label
Shipping Label
Shipping Label Edit
Shipping Label Edit
Shipment Delete/Cancel
Shipment Delete/Cancel
Shipment Creation
Shipment Creation
Close-Out
Close-Out
Manifest
Manifest
Domestic Manifest
Domestic Manifest
Reprint Shipping Label
Reprint Shipping Label
Pickup
Pickup
Pickup Label
Pickup Label
Tracking
Tracking
APPENDIX
APPENDIX
SHIPMENT CREATION ENDPOINT
A user who is using this API must be certified by DHL eCommerce to print the Shipping Labels offline.
This API is used to create a shipment, there will be no shipment manifest and no label returned.
The Shipment Creation API supports up to 100 standard shipments in one request message.
If one or more shipment(s) in the request fails validation, only those shipments having errors will fail and successfully validated shipments will be created.
Please note :
API users should not send the same requests in parallel; this will result in duplicate shipments.
Each shipping service has different requirements to fulfill. Please be sure you understand all fields and their requirements. You might need to make some minor modifications to customize the code to suit your needs.
/rest/v3/Shipment
POST
REQUEST
Request has to conform with the below specification:
ENVIRONMENT
PROTOCOL
HOST
RESOURCE PATH
Production
https
api.dhlecommerce.dhl.com
/rest/v3/Shipment
PreProd
https
apitest.dhlecommerce.asia
/rest/v3/Shipment
* M : Mandatory, O : Optional, C : Conditional
REQUEST MESSAGE STRUCTURE
RESPONSE MESSAGE STRUCTURE
| Element Name | M/O/C * | Length (min/max) | Data Type | Cardinality | Description |
|---|---|---|---|---|---|
|
|
|||||
manifestResponse |
M | - | Group | 1..1 | Root element |
|
|
|||||
hdr   |
M | - | Group | 1..1 | Response header |
|
|
|||||
messageType |
M | 1/50 | String | 1..1 | Message Type |
|
|
|||||
messageDateTime |
M | - | DateTime | 1..1 | Message creation date and time, CCYY-MM-DDThh:mm:ssTZD where CCYY is Year, MM is month, DD is date, character "T", hh is hours, mm is minutes, ss is seconds and TZD is time zone designator (+hh:mm or -hh:mm)e.g 2016-01-13T16:20:27+08:00 |
|
|
|||||
messageVersion |
M | 1/5 | String | 1..1 | Message version. Refer to Version History |
|
|
|||||
messageLanguage |
O | 2/10 | String | 0..1 | Language submitted in the request is returned. If language was not provided, “en” is returned. |
|
|
|||||
messageSource |
O | 1/10 | String | 0..1 | Indicates the source of the Request. For eg. "POS" or a 3PV platform name |
|
|
|||||
|
|
|||||
bd |
M | - | Group | 1..1 | Response body |
|
|
|||||
shipmentItems |
M | - | Group | 1..N | Label details |
|
|
|||||
shipmentID |
M | 1/35 | String | 1..1 | Shipment ID submitted in the request is returned. |
|
|
|||||
deliveryConfirmationNo |
O | 1/40 | String | 0..1 | Final mile delivery tracking number. Note that it is not always returned. |
|
|
|||||
originalShipmentID |
O | 1/35 | String | 0..1 | If productCode is PDR and shipmentID is originally delivered by DHL, original shipment ID will be returned. |
|
|
|||||
pickupStartDateTime |
O | String | 0..1 | Pickup start datetime for the parcel. This value is only applicable for domestic MY/TH/VN products. | |
|
|
|||||
pickupEndDateTime |
O | String | 0..1 | Pickup end datetime for the parcel. This value is only applicable for domestic MY/TH/VN products. | |
|
|
|||||
deliveryDepotCode |
O | 1/6 | String | 0..1 | DHLeC Routing information |
|
|
|||||
primarySortCode |
O | 1/4 | String | 0..1 | DHLeC Routing information |
|
|
|||||
secondarySortCode |
O | 1/6 | String | 0..1 | DHLeC Routing information |
|
|
|||||
responseStatus |
M | - | Group | 1..1 | Shipment level response status. |
|
|
|||||
code |
M | 1/5 | String | 1..1 | Response status code. For possible values, refer to Response Status Code in Appendix page. |
|
|
|||||
message |
M | 1/300 | String | 1..1 | Response message. |
|
|
|||||
messageDetails |
O | - | Group | 0..n | Response message details. |
|
|
|||||
messageDetail |
M | 1/500 | String | 1..1 | Detailed message. May contain the xpath where the error occurs. |
|
|
|||||
pieces |
O | - | Group | 0..1 | |
|
|
|||||
shipmentPieceID |
O | 1/40 | String | 0..1 | Piece ID submitted in the request is returned. For tracking purposes, the piece can be tracked using {shipmentID}-{pieceID}. |
|
|
|||||
deliveryConfirmationNo |
O | 1/40 | String | 0..1 | Final mile delivery tracking number. Note that it is not always returned. |
|
|
|||||
deliveryDepotCode |
O | 1/6 | String | 0..1 | DHLeC Routing information |
|
|
|||||
primarySortCode |
O | 1/4 | String | 0..1 | DHLeC Routing information |
|
|
|||||
secondarySortCode |
O | 1/6 | String | 0..1 | DHLeC Routing information |
|
|
|||||
responseStatus |
M | - | Group | 1..1 | Shipment level response status. |
|
|
|||||
code |
M | 1/5 | String | 1..1 | Response status code. For possible values, refer to Response Status Code in Appendix page. |
|
|
|||||
message |
M | 1/300 | String | 1..1 | Response message. |
|
|
|||||
messageDetails |
O | - | Group | 0..n | Response message details. |
|
|
|||||
messageDetail |
M | 1/500 | String | 1..1 | Detailed message. May contain the xpath where the error occurs. |
|
|
|||||
responseStatus |
M | - | Group | 1..1 | Service level response status. |
|
|
|||||
code |
M | 1/5 | String | 1..1 | Response status code. For possible values, refer to Response Status Code in Appendix page. |
|
|
|||||
message |
M | 1/300 | String | 1..1 | Response message. |
|
|
|||||
messageDetails |
O | - | Group | 0..n | Response message details. |
|
|
|||||
messageDetail |
M | 1/500 | String | 1..1 | Detailed message. May contain the xpath where the error occurs. |
|
|
|||||
| Element Name | M/O/C * | Length (min/max) | Data Type | Cardinality | Description |
|---|---|---|---|---|---|
|
|
|||||
manifestRequest |
M | - | Group | 1..1 | Root element |
|
|
|||||
hdr |
M | - | Group | 1..1 | Request header |
|
|
|||||
messageType |
M | 1/50 | String | 1..1 | Default value is "SHIPMENT" |
|
|
|||||
messageDateTime |
M | - | DateTime | 1..1 | Message creation date and time, CCYY-MM-DDThh:mm:ssTZD where CCYY is Year, MM is month, DD is date, character "T", hh is hours, mm is minutes, ss is seconds and TZD is time zone designator (+hh:mm or -hh:mm) e.g 2016-01-13T16:20:27+08:00 |
|
|
|||||
messageVersion |
M | 1/5 | String | 1..1 | Message version. Refer to Version History |
|
|
|||||
accessToken |
M | 1/32 | String | 1..1 | Access token assigned by access token authentication. |
|
|
|||||
messageLanguage |
O | 2/10 | String | 0..1 | Language code to indicate the expected response message localization. IETF RFC 3066 language identification tag. For possible values. refer to Message Language in Appendix page. If no value is provided, "en" is default. |
|
|
|||||
messageSource |
O | 1/10 | String | 0..1 | Indicates the source of the Request. For eg. "POS" or a 3PV platform name. |
|
|
|||||
bd |
M | - | Group | 1..1 | Request body |
|
|
|||||
customerAccountId |
O | 1/10 | Numeric | 0..1 | Customer account to use for label request |
|
|
|||||
pickupAccountId |
M | 1/10 | String | 1..1 | DHL PICKUP Account ID |
|
|
|||||
soldToAccountId |
M | 1/10 | String | 1..1 | DHL SOLDTO Account ID |
|
|
|||||
pickupDateTime |
O | - | DateTime | 0..1 | Shipment pickup date time, CCYY-MM-DDThh:mm:ssTZD where CCYY is Year, MM is month, DD is date, character "T", hh is hours, mm is minutes, ss is seconds and TZD is time zone designator (+hh:mm or -hh:mm) e.g 2016-01-13T16:20:27+08:00 |
|
|
|||||
handoverMethod |
O | 1/1 | Integer | 0..1 | Handover method; Refer to Handover Methods under Appendix page for the list of possible values. |
|
|||||
pickupAddress |
O | - | Group | 0..1 | Pickup address details. If your account is Domestic, this will take precedence over Shipper Address for pickup services, if applicable. |
|
|
|||||
companyName |
O | 1/30 | String | 0..1 | Pickup Company name. Please do not include pipeline "|" in this field. |
|
|
|||||
name |
M | 1/50 | String | 1..1 | Contact person name at Pickup location. Cross Border shipment with minimum length of 1 and maximum length of 30. Domestic shipment with minimum length of 1 and maximum length of 50. Please do not include pipeline "|" in this field. |
|
|
|||||
address1 |
M | 1/60 | String | 0..1 | Pickup Address Line 1. Cross Border shipment with minimum length of 1 and maximum length of 50. Domestic shipment with minimum length of 1 and maximum length of 60. Please do not include pipeline "|" in this field. |
|
|
|||||
address2 |
O | 1/60 | String | 0..1 | Pickup Address Line 2. Cross Border shipment with minimum length of 1 and maximum length of 50. Domestic shipment with minimum length of 1 and maximum length of 60. Please do not include pipeline "|" in this field. |
|
|
|||||
address3 |
O | 1/60 | String | 0..1 | Pickup Address Line 3. Cross Border shipment with minimum length of 1 and maximum length of 30. Domestic shipment with minimum length of 1 and maximum length of 60. Please do not include pipeline "|" in this field. |
|
|
|||||
city |
C | 1/40 | String | 0..1 | Pickup City. Mandatory for Cross Border shipment with minimum length of 1 and maximum length of 30. Optional for Domestic shipment with minimum length of 1 and maximum length of 40. Please do not include pipeline "|" in this field. |
|
|
|||||
state |
O | 2/20 | String | 0..1 | Pickup State or province. Please do not include pipeline "|" in this field. |
|
|
|||||
district |
O | 1/40 | String | 0..1 | Pickup District. Only applicable for domestic shipment |
|
|
|||||
country |
M | 2/2 | String | 1..1 | Pickup Country code (ISO 2-char country code). Refer to Country Codes in the Appendix page |
|
|
|||||
postCode |
O | 1/10 | String | 0..1 | Pickup Postal code. Refer to Postal Code Formats in the Appendix page |
|
|
|||||
phone |
O | 1/20 | String | 0..1 | Phone number of contact person situated at Pickup location. Accepted special characters are : - ( ) # + |
|
|
|||||
email |
O | 1/50 | String | 0..1 | Email address of contact person situated at Pickup location. Please do not include pipeline "|" in this field. |
|
|
|||||
shipperAddress |
O | - | Group | 1..1 | Shipper address details Optional if productCode is PDR and shipmentID is originally delivered by DHL. |
|
|
|||||
companyName |
O | 1/30 | String | 0..1 | Shipper Company name. Please do not include pipeline "|" in this field. |
|
|
|||||
name |
C | 1/50 | String | 0..1 | Shipper name. Cross Border shipment with minimum length of 1 and maximum length of 30. Domestic shipment with minimum length of 1 and maximum length of 50. Please do not include pipeline "|" in this field. |
|
|
|||||
address1 |
C | 1/60 | String | 0..1 | Shipper Address Line 1. Cross Border shipment with minimum length of 1 and maximum length of 50. Domestic shipment with minimum length of 1 and maximum length of 60. Please do not include pipeline "|" in this field. |
|
|
|||||
address2 |
O | 1/60 | String | 0..1 | Shipper Address Line 2. Cross Border shipment with minimum length of 1 and maximum length of 50. Domestic shipment with minimum length of 1 and maximum length of 60. Please do not include pipeline "|" in this field. |
|
|
|||||
address3 |
O | 1/60 | String | 0..1 | Shipper Address Line 3. Cross Border shipment with minimum length of 1 and maximum length of 30. Domestic shipment with minimum length of 1 and maximum length of 60. Please do not include pipeline "|" in this field. |
|
|
|||||
city |
C | 1/40 | String | 0..1 | Shipper City. Mandatory for Cross Border shipment with minimum length of 1 and maximum length of 30. Optional for Domestic shipment with minimum length of 1 and maximum length of 40. Please do not include pipeline "|" in this field. |
|
|
|||||
state |
O | 2/20 | String | 0..1 | Shipper state or province. Please do not include pipeline "|" in this field. |
|
|
|||||
district |
O | 1/40 | String | 0..1 | Shipper District. Only applicable for domestic shipment. |
|
|
|||||
country |
C | 2/2 | String | 0..1 | Shipper Country code (ISO 2-char country code). Refer to Country Codes in the Appendix page |
|
|
|||||
postCode |
O | 1/10 | String | 0..1 | Shipper Postal code. Refer to Postal Code Formats in the Appendix page |
|
|
|||||
phone |
C | 1/20 | String | 0..1 | Phone number of contact person situated at Shipper location. Accepted special characters are : - ( ) # + |
|
|
|||||
email |
O | 1/50 | String | 0..1 | Shipper Email address. Please do not include pipeline "|" in this field. |
|
|
|||||
fiscalId |
O | 1/50 | String | 0..1 | Shipper’s official fiscal Identification Number for e.g. Income Tax, VAT, GST, EORI, IOSS, Permanent Account Number (PAN), etc. |
|
|
|||||
fiscalIdType |
O | 1/2 | Numeric | 0..1 | Shipper’s official identification number type. Allowed values: 0 – Other / Unknown 1 - GST/VAT 2 – EORI (EU) 3 – IOSS (EU) 4 - TBD 5 – PAN (IN) |
|
|
|||||
gstIN |
O | 1/15 | String | 0..1 | GSTIN No. of the shipper - ONLY for INDIA customers |
|
|
|||||
iecNumber |
O | 1/20 | String | 0..1 | IEC No. of the shipper - ONLY for INDIA customers |
|
|
|||||
bankAdCode |
O | 1/20 | String | 0..1 | Bank AD Code of the shipper - ONLY for INDIA customers |
|
|
|||||
bankAc |
O | 1/30 | String | 0..1 | Bank Account no. of the Shipper - Valid for India Customers only |
|
|
|||||
bankIfsc |
O | 1/30 | String | 0..1 | Bank IFSC no. of the Shipper - Valid for India Customers only |
|
|
|||||
shipmentItems |
M | - | Group | 1..100 | Shipment Items details |
|
|
|||||
consigneeAddress |
C | - | Group | 0..1 | Consignee address details Optional if productCode is PDR and shipmentID is originally delivered by DHL. |
|
|
|||||
companyName |
O | 1/50 | String | 0..1 | Consignee Company name. Cross Border shipment with minimum length of 1 and maximum length of 30. Domestic shipment with minimum length of 1 and maximum length of 50. Please do not include pipeline "|" in this field. |
|
|
|||||
name |
M | 1/50 | String | 1..1 | Consignee name. Cross Border shipment with minimum length of 1 and maximum length of 30. Domestic shipment with minimum length of 1 and maximum length of 50. Please do not include pipeline "|" in this field. |
|
|
|||||
address1 |
M | 1/60 | String | 1..1 | Consignee Address Line 1. Cross Border shipment with minimum length of 1 and maximum length of 50. Domestic shipment with minimum length of 1 and maximum length of 60. Please do not include pipeline "|" in this field. |
|
|
|||||
address2 |
O | 1/60 | String | 0..1 | Consignee Address Line 2. Cross Border shipment with minimum length of 1 and maximum length of 50. Domestic shipment with minimum length of 1 and maximum length of 60. Please do not include pipeline "|" in this field. |
|
|
|||||
address3 |
O | 1/60 | String | 0..1 | Consignee Address Line 3. Cross Border shipment with minimum length of 1 and maximum length of 30. Domestic shipment with minimum length of 1 and maximum length of 60. Please do not include pipeline "|" in this field. |
|
|
|||||
city |
C | 1/40 | String | 0..1 | Consignee City. Mandatory for Cross Border shipment with minimum length of 1 and maximum length of 30. For PLT/PLE AU, US, and VN this field is validated against destination country data and will not accept any free text. Please reach out to your local onboarding team to understand more. Optional for Domestic shipment with minimum length of 1 and maximum length of 40. Please do not include pipeline "|" in this field. |
|
|
|||||
state |
C | 2/20 | String | 0..1 | Consignee State or province. Refer to State Code Formats in the Appendix page for Parcel Direct US and AU. For PLT VN this field is validated against destination country data and will not accept any free text. Please reach out to your local onboarding team to understand more. Please do not include pipeline "|" in this field. |
|
|
|||||
district |
C | 1/40 | String | 0..1 | Consignee District. Only applicable for domestic shipment. Please do not include pipeline "|" in this field. |
|
|
|||||
country |
M | 2/2 | String | 1..1 | Consignee Country code (ISO 2-char country code). Refer to Country Codes in the Appendix page |
|
|
|||||
postCode |
C | 1/10 | String | 0..1 | Consignee Postal code. Refer to Postal Code Formats in the Appendix page. For PLT/PLE AU/DE/FR/MY/TH/US this value must be a valid postcode in the destination country. Please reach out to your local onboarding team to understand more. |
|
|
|||||
phone |
O | 1/20 | String | 0..1 | Consignee Phone number. Accepted special characters are : - ( ) # + |
|
|
|||||
email |
O | 1/50 | String | 0..1 | Consignee Email address. Please do not include pipeline "|" in this field. |
|
|
|||||
idNumber |
C | 1/30 | String | 0..1 | Consignee Identification Number |
|
|
|||||
idType |
C | 1/2 | String | 0..1 | Consignee Identification Type. For possible values, refer to Identification Type in Appendix page. |
|
|
|||||
fiscalId |
O | 1/50 | String | 0..1 | Consignee’s official fiscal Identifier, e.g. Income Tax, EORI, IOSS, VAT, GST Number, Permanent Account Number (PAN) |
|
|
|||||
fiscalIdType |
O | 1/2 | Numeric | 0..1 | Consignee's official identification number type. Allowed values: 0 – Other / Unknown 1 - GST/VAT 2 – EORI (EU) 3 – IOSS (EU) 4 - TBD 5 – PAN (IN) |
|
|
|||||
altConsigneeId |
O | 1/20 | String | 0..1 | Consignee’s DSP registration ID to route deliveries to alternative locations, e.g. parcel locker, shops, agents on request |
|
|
|||||
returnAddress |
O | - | Group | 0..1 | Return address details. Applicable to Domestic and PLE or PLT products with destination US. returnAddress block can only be provided with returnMode element, only used if returnMode is 03. |
|
|
|||||
companyName |
O | 1/30 | String | 0..1 | Return Company name. Please do not include pipeline "|" in this field. |
|
|
|||||
name |
M | 1/50 | String | 1..1 | Contact person name at Return location. Cross Border shipment with minimum length of 1 and maximum length of 30. Domestic shipment with minimum length of 1 and maximum length of 50. Please do not include pipeline "|" in this field. |
|
|
|||||
address1 |
M | 1/60 | String | 1..1 | Return Address Line 1. Cross Border shipment with minimum length of 1 and maximum length of 50. Domestic shipment with minimum length of 1 and maximum length of 60. Please do not include pipeline "|" in this field. |
|
|
|||||
address2 |
O | 1/60 | String | 0..1 | Return Address Line 2. Cross Border shipment with minimum length of 1 and maximum length of 50. Domestic shipment with minimum length of 1 and maximum length of 60. Please do not include pipeline "|" in this field. |
|
|
|||||
address3 |
O | 1/60 | String | 0..1 | Return Address Line 3. Cross Border shipment with minimum length of 1 and maximum length of 30. Domestic shipment with minimum length of 1 and maximum length of 60. Please do not include pipeline "|" in this field. |
|
|
|||||
city |
C | 1/40 | String | 0..1 | Return City. Mandatory for Cross Border shipment with minimum length of 1 and maximum length of 30. Optional for Domestic shipment with minimum length of 1 and maximum length of 40. Please do not include pipeline "|" in this field. |
|
|
|||||
state |
C | 2/20 | String | 0..1 | Return State or province. Please do not include pipeline "|" in this field. |
|
|
|||||
district |
O | 1/40 | String | 0..1 | Return District. Only applicable for domestic shipment. |
|
|
|||||
country |
M | 2/2 | String | 1..1 | Return Country code (ISO 2-char country code). Refer to Country Codes in the Appendix page |
|
|
|||||
postCode |
C | 1/10 | String | 0..1 | Return Postal code. Refer to Postal Code Formats in the Appendix page. |
|
|
|||||
phone |
O | 1/20 | String | 0..1 | Return Phone number. Accepted special characters are : - ( ) # + |
|
|
|||||
email |
O | 1/50 | String | 0..1 | Return Email address.Only applicable for domestic shipment |
|
|
|||||
fiscalId |
O | 1/50 | String | 0..1 | Return Company’s official fiscal Identifier, e.g. Income Tax, EORI, IOSS, VAT, GST Number, Permanent Account Number (PAN) |
|
|
|||||
fiscalIdType |
O | 1/2 | Numeric | 0..1 | Return Company's official identification number type. Allowed values: 0 – Other / Unknown 1 - GST/VAT 2 – EORI (EU) 3 – IOSS (EU) 4 - TBD 5 – PAN (IN) |
|
|
|||||
shipmentID |
M | 1/35 | String | 1..1 | Customer applied identifier for shipment. Customer prefix must be included. Sales order is suggested to be used as identifier.
Shipment ID must not be repeated within 90 days. Accepted special characters : ~ _ \ . : Note : Note: Character \ cannot be used alone. Please enter two, e.g: SHIPMENTID123\\2017 If isMult is true, max length becomes 32 characters. Please do not include pipeline "|" in this field. |
|
|
|||||
returnMode |
O | 2/2 | String | 0..1 | Domestic Only. Indicator for returned shipments; Refer to Return Mode under Appendix page for the list of possible values. Return Mode must be provided with Return Address block. |
|
|
|||||
deliveryConfirmationNo |
O | 1/40 | String | 0..1 | Final mile delivery tracking number. Not in use. Default to “null” |
|
|
|||||
packageDesc |
C | 1/50 | String | 0..1 | Generic description of contents in Shipment (e.g. Fashion). Mandatory for Cross Border shipment with minimum length of 3 and maximum length of 50. Optional for Domestic shipment, unless the destination is Malaysia or Vietnam, with minimum length of 1 and maximum length of 50. Please do not include pipeline "|" in this field. Optional if productCode is PDR and shipmentID is originally delivered by DHL. |
|
|
|||||
totalWeight |
C | 1/6 | Numeric | 1..1 | Total shipment weight including packaging. Whole numbers only and cannot be zero. Optional if productCode is PDR and shipmentID is originally delivered by DHL. |
|
|
|||||
totalWeightUOM |
M | 1/3 | String | 1..1 | Shipment weight unit of
measurement. For possible unit of measures, refer to Weight UOM Code List in Appendix page. Only G (Grams) is supported at this time. |
|
|
|||||
dimensionUOM |
C | 1/2 | String | 0..1 | Dimension unit of measurement. Mandatory if height, length and width are provided. For possible values, refer to Dimension UOM Code List under Appendix page. |
|
|
|||||
height |
C | N(3.2)/N(8.2) | Numeric | 0..1 | Shipment height (cm) in 2 decimal points. |
|
|
|||||
length |
C | N(3.2)/N(8.2) | Numeric | 0..1 | Shipment length (cm) in 2 decimal points. |
|
|
|||||
width |
C | N(3.2)/N(8.2) | Numeric | 0..1 | Shipment width (cm) in 2 decimal points. |
|
|
|||||
customerReference1 |
O | 1/50 | String | 0..1 | Customer reference 1. Not in use, default to “null”. |
|
|
|||||
customerReference2 |
O | 1/50 | String | 0..1 | Customer reference 2. Not in use, default to “null”. |
|
|
|||||
productCode |
M | 3/3 | String | 1..1 | DHLeC Shipping service. For possible values, refer to Shipping Service in Appendix page. |
|
|
|||||
incoterm |
C | 3/3 | String | 0..1 | Inco term. For possible values, refer to Inco Term in Appendix page. |
|
|
|||||
contentIndicator |
O | 2/2 | String | 0..1 | When Lithium Batteries are contained within the device only. For possible values please refer to Content Indicator in Appendix page. Not in use. Default to “null”. |
|
|
|||||
codValue |
O | N(3.2)/N(15.2) | Numeric | 0..1 | Cash on delivery collection value (in 2 decimal points). If not required, provide value as NULL. Can be used for XBOCOD if the product and your account supports. |
|
|
|||||
insuranceValue |
O | N(3.2)/N(15.2) | Numeric | 0..1 | Insured Value (in 2 decimal points). Mandatory for shipment with SVP. If not required, provide value as NULL. |
|
|
|||||
freightCharge |
O | N(3.2)/N(8.2) | Numeric | 0..1 | Freight charges (in 2 decimal points). If not required, default to 0.00. |
|
|
|||||
totalValue |
C | N(3.2)/N(15.2) | Numeric | 1..1 | Total declared value of the shipment (in 2 decimal points). Mandatory for Cross Border shipment, optional for Domestic shipment. For Vietnam Domestic, totalValue must be a multiple of 500. |
|
|
|||||
currency |
C | 3/3 | String | 0..1 | 3-char ISO currency code for all monetary value fields. Refer to Currency Codes in the Appendix page. Optional if productCode is PDR and shipmentID is originally delivered by DHL. If your account and product supports XBOCOD, then only the destination currency code can be given. E.g. PLT MY = MYR only. |
|
|
|||||
remarks |
O | 1/200 | String | 0..1 | Shipment remarks. Additional remarks to be printed on shipping label for Shipper reference only. Cross Border shipment with minimum length of 1 and maximum length of 200. Domestic shipment with minimum length of 1 and maximum length of 50. Please do not include pipeline "|" in this field. |
|
|
|||||
billingReference1 |
O | 1/80 | String | 0..1 | Available for Domestic shipments, should be populated with OrderID. Please do not include pipeline "|" in this field. |
|
|
|||||
billingReference2 |
O | 1/80 | String | 0..1 | Available for Domestic shipments, should be populated with Merchant Reference. Please do not include pipeline "|" in this field. |
|
|
|||||
customsSalesOrderNumber |
O | 1/50 | String | 0..1 | Sales Order Number |
|
|
|||||
customsPurchaseOrderNumber |
O | 1/50 | String | 0..1 | Purchase Order Number |
|
|
|||||
otherChargesDescription |
O | 1/50 | String | 0..1 | Description of other charges on the sale of goods - Valid for India Customers only |
|
|
|||||
otherChargesAmount |
O | N(3,2)/N(10,2) | Numeric | 0..1 | Amount of other charges on the sale of goods - Valid for India Customers only |
|
|
|||||
orderURL |
O | 1/255 | String | 0..1 | URL of the shipment order or where order reference can be looked up online. For example: www.amazon.com/order?=12345 |
|
|
|||||
customsCertificateNumber |
O | 1/50 | String | 0..1 | Customer Certificate |
|
|
|||||
customsLicenceNumber |
O | 1/50 | String | 0..1 | Customs License Number |
|
|
|||||
taxPrepaid |
O | 1/1 | String | 0..1 | To indicate that VAT / GST Tax has been pre-paid in case of DDP Y = pre-paid N= not prepaid |
|
|
|||||
eSellerWebsite |
O | 1/80 | String | 0..1 | Main Website name/domain where the shipment order was sold on. for example: www.amazon.com www.ebay.de www.joom.com www.ooshirts.com |
|
|
|||||
exportDeclarationNumber |
O | 1/50 | String | 0..1 | Shipment based registration number provided by national Customs Authorities to Business Customers to pre-alert, track, document and proof actual export of goods from Customs export office |
|
|
|||||
customsInvoiceNumber |
O | 1/35 | String | 0..1 | Invoice Number on printed Invoice |
|
|
|||||
isMult |
O | 1/5 | String | 0..1 | Indicator of whether your shipment has multiple pieces. Expected Value: TRUE or FALSE |
|
|
|||||
deliveryOption |
O | 1/1 | String | 0..1 | Indicator of whether all shipment pieces can be delivered together or separately. “C” for complete delivery and "P" for partial Delivery. |
|
|
|||||
numberOfPieces |
O | 1/2 | Integer | 0..1 | Indicate the number of pieces for MPS shipments. |
|
|
|||||
invoiceNumber |
C | 1/20 | String | 0..1 | Valid for India Customers only, if provided then invoiceDate is mandatory. |
|
|
|||||
invoiceDate |
C | 10/10 | Date | 0..1 | Valid for India Customers only, if provided then invoiceNumber is mandatory.Format must be YYYY-MM-DD. |
|
|
|||||
reverseCharge |
C | 4/5 | String | 0..1 | Reverse Charge.Expected value is TRUE/FALSE. Mandatory for India CSB-V customers. |
|
|
|||||
igstPaymentStatus |
C | 1/1 | String | 0..1 | ISGT Payment Status.Expected value is A/B/C: A- not applicable B- LUT or Export under Bond. C- Export Against Payment of IGST Mandatory for India CSB-V customers. |
|
|
|||||
reasonOfExport |
C | 1/1 | String | 0..1 | Valid for India Customers only, if provided,For CSB IV shipmnet booking 0- Bonafide Sample 1- Sample 2- Gift For CSB V shipmnet booking 3 - Commercial |
|
|
|||||
termsOfInvoice |
C | 3/25 | String | 0..1 | Terms of Invoice. Mandatory for India CSB-V customers. |
|
|
|||||
returnProductCode |
O | 3/3 | String | 0..1 | The Shipping Service to be used for return to sender items can be specified here. This is only applicable for Domestic shipments. If MY or TH then PDO is the only accepted value. If VN then PDO or PDE will be accepted. If not provided then the value will be defaulted to PDO. |
|
|
|||||
locationID |
O | 1/10 | String | 0..1 | This field is to be used if delivery of the shipment is to go to a ServicePoint location local to the consignee. LocationID list to be supplied separately. |
|
|
|||||
additionalOrderRef |
C | 1/50 | String | 0..1 | |
|
|
|||||
isRoutingInfoRequired |
O | 0/1 | String | 0..1 | Expected value is “Y” or “N”. |
|
|
|||||
valueAddedServices |
O | - | Group | 0..1 | Value added services. |
|
|
|||||
valueAddedService |
M | - | Group | 1..n | Value added service codes. |
|
|
|||||
vasCode |
M | 1/10 | String | 1..1 | Value added service codes for domestic products. OBOX, PPOD, AMD, TDD and EEPOD are the current accepted values. Please check with your onboarding representative to know if these are available for you. |
|
|
|||||
attributes |
O | - | Group | o..n | Additional attributes for VAS codes |
|
|
|||||
attributeName |
M | 1/30 | String | 1..1 | Only supported if vasCode is PPOD. Only value “INSTRUCTION” can be given.
For vasCode TDD Only value “TIMESLOT” can be given. |
|
|
|||||
attributeValue |
M | 1/30 | String | 1..1 | To be filled with PPOD Instruction codes as configured for your account. Can support up to 3 instruction codes, comma separated. E.g. “01,02,03”.
To be filled with TDD Timeslots as configured for your account. Timeslot would be 4 digits. E.g. "0900". |
|
|
|||||
shipmentAttrs |
O | - | List | 0..1 | Shipment Attributes details, for Retail Info. |
|
|
|||||
key |
M | - | String | 1..n | Accepted valuesare "retailAccNo", "cartEmailAddress", "paymentAmount", "paymentStatus", "paymentMethod" |
|
|
|||||
value |
M | - | String | 1..n | |
|
|
|||||
shipmentPieces |
C | - | Group | 0..99 | Shipment content details. Optional for Domestic shipments. |
|
|
|||||
pieceID |
M | 1/2 | Integer | 1..1 | The piece ID which will be appended after the provided Shipment ID. Cannot have leading zeroes. |
|
|
|||||
announcedWeight |
O | - | Group | 0..1 | Value added services. |
|
|
|||||
weight |
O | 1/6 | Numeric | 0..1 | Weight of individual piece |
|
|
|||||
unit |
O | 1/3 | String | 0..1 | Weight unit - only G (Grams) is supported at this time. |
|
|
|||||
codAmount |
O | N(3.2)/N(10.2) | Numeric | 0..1 | If COD is applicable for the multipiece shipment, it must be provided for all pieces. |
|
|
|||||
insuranceAmount |
O | N(3.2)/N(10.2) | Numeric | 0..1 | If Insurance is applicable for the multipiece shipment, it must be provided for all pieces |
|
|
|||||
billingReference1 |
O | 1/80 | String | 0..1 | Available for Domestic shipments, should be populated with OrderID |
|
|
|||||
billingReference2 |
O | 1/80 | String | 0..1 | Available for Domestic shipments, should be populated with Merchant Reference |
|
|
|||||
pieceDescription |
C | 1/50 | String | 0..1 | Mandatory if insurance is specified. |
|
|
|||||
additionalOrderRef |
C | 1/50 | String | 0..1 | |
|
|
|||||
shipmentContents |
C | - | Group | 0..10 | Shipment content details. Optional for Domestic shipments. |
|
|
|||||
skuNumber |
C | 1/50 | String | 1..1 | SKU number or marketplace item code of the shipment content.
For product verification on client website
during custom clearance. For India customers this cannot exceed 15 characters. |
|
|
|||||
description |
C | 1/50 | String | 1..1 | Detailed description of shipment content matching with Commercial Invoice. This description is most often used for customs clearance, so accurate and concise descriptions improves clearance times.
For India customers this cannot exceed 30 characters. Please do not include pipeline "|" in this field. |
|
|
|||||
descriptionImport |
O | 1/50 | String | 1..1 | Detailed description of shipment content in the language of the importing country. Please do not include pipeline "|" in this field. |
|
|
|||||
descriptionExport |
O | 1/50 | String | 1..1 | Detailed description of shipment content in the language of the exporting country. Required in Chinese characters for all shipments shipped via a DHLeC distribution centre in China. Please do not include pipeline "|" in this field. |
|
|
|||||
itemValue |
C | (N3.2)/N(10.2) | Numeric | 1..1 | Unit selling price of 1 shipment content (in 2 decimal points) matching with Commercial Invoice. This declared value is most often used for customs clearance, so accurate declared value improves clearance times. |
|
|
|||||
itemQuantity |
C | 1/3 | Integer | 1..1 | Quantity of 1 shipment content in the shipment. |
|
|
|||||
grossWeight |
O | 1/6 | Integer | 1..1 | Total shipment content gross weight. Whole numbers only. |
|
|
|||||
netWeight |
O | 1/6 | Integer | 1..1 | Total shipment content net weight. Whole numbers only. |
|
|
|||||
weightUOM |
C | 1/3 | String | 0..1 | Weight unit - must be
populated if gross weight or net weight is
provided. Only G (Grams) is supported at this time. |
|
|
|||||
contentIndicator |
O | 2/2 | String | 0..1 |
When Lithium Batteries are contained within the
device only. For possible values please refer to Content Indicator in Appendix page. Only offered for selected facilities, default to “null” if not applicable. |
|
|
|||||
countryOfOrigin |
C | 2/2 | String | 1..1 | Manufactured country of shipment content (ISO 2-char country code). Mandatory for India, Shenzhen, and Shanghai customers or if using PLT/PLE US product. Refer to Country Codes in the Appendix page. |
|
|
|||||
hsCode |
C | 6/20 | String | 0..1 | HS code for commercial clearance. Mandatory for India customers. |
|
|
|||||
cgstAmount |
C | N(3.2)/N(10.2) | Numeric | 0..1 | Central Goods & Services Tax amount, mandatory for India Ewaybill eligible customers. |
|
|
|||||
sgstAmount |
C | N(3.2)/N(10.2) | Numeric | 0..1 | State Goods & Services Tax amount, mandatory for India Ewaybill eligible customers |
|
|
|||||
igstAmount |
C | N(3.2)/N(10.2) | Numeric | 0..1 | Integrated Goods & Services Tax amount, mandatory for India Ewaybill eligible customers |
|
|
|||||
cessAmount |
C | N(3.2)/N(10.2) | Numeric | 0..1 | Cess amount, mandatory for India Ewaybill eligible customers |
|
|
|||||
igstRate |
C | N(3.2)/N(5.2) | Numeric | 0..1 | IGST Rate %, cannot exceed 100. Mandatory for India CSB-V customers. |
|
|
|||||
discount |
C | N(3.2)/N(10.2) | Numeric | 0..1 | Discount, cannot exceed Unit Price * Quantity. Mandatory for India CSB-V customers. |
|
|
|||||
commodityUnder3C |
C | 4/5 | String | 0..1 | Commodity under 3C.Expected Value is TRUE/FALSE or true/false. Mandatory for India CSB-V customers. |
|
|
|||||
meis |
C | 4/5 | String | 0..1 | MEIS.Expected Value is TRUE/FALSE or true/false. Mandatory for India CSB-V customers. |
|
|
|||||
marketplaceName |
O | 1/50 | String | 0..1 | Main Website name/domain where the commodity order was sold on, for example: www.amazon.com |
|
|
|||||
marketplaceURL |
O | 1/255 | String | 0..1 | Order URL of specific Commodity, if available.For example:www.amazon.com/order?=12345 |
|
|
|||||
Sample Request
VALUE
DESCRIPTION
KG
Kilograms
LB
Pounds
G
Grams
VALUE
DESCRIPTION
CM
Centimeters
FT
Feet
IN
Inches
M
Meters
MM
Millimeters
YD
Yards