Master Data Endpoints

Tracking Endpoints

Label Endpoints

Closeout Endpoints

Sortcode Endpoints

Type HTTP Status Code Description
ACCESS_DENIED 403 User does not have access to this resource
APPLICATION_ERROR 500 An application error has occurred.
GATEWAY_INVALID_RESPONSE 502 The server was acting as a gateway or proxy and received an invalid response from the upstream server.
GATEWAY_TIMEOUT_ERROR 504 The server is acting as a gateway or proxy and did not receive a timely response from the upstream server.
INACTIVE_KEY 400 The API KEY you provided is invalid.
INVALID_CLIENT_ID 400 Client ID did not match access_token
INVALID_FACILITY_CODE 400 Incorrect DHL eCommerce Facility Code provided in the request
INVALID_JSON 400 Request did not contain valid JSON
INVALID_KEY 400 The API KEY you provided is invalid.
INVALID_TOKEN 400 Access Token provided was invalid
INVALID_XML 400 Request did not contain valid XML
METHOD_NOT_ALLOWED 405 Invalid HTTP method was used in request (e.g. GET, POST, PUT, DELETE).
SERVER_MAINTENANCE 503 Server is currently down for maintenance.
SERVICE_MAINTENANCE 503 Service is currently down for maintenance. Please re-try your request at a later time.
UNSUPPORTED_FORMAT 415 Invalid format requested (something other than XML, JSON, etc.)
UNSUPPORTED_PROTOCOL 400 Only supported formats are http and https. https could be required by some resources (e.g. Authentication).
VALIDATION_ERROR 400 An input parameter may be missing or invalid.
Type HTTP Status Code Description
INVALID_LOGIN 400 Login information provided was invalid.
Type HTTP Status Code Description
INVALID_LABEL_RESPONSE_XML 400 There was an error generating your label.
LABEL_GENERATION_INVALID_ADDRESS 400 The address entered was not found. Edit Address and try again.
LABEL_GENERATION_PARSE_ERROR 400 There was an error generating your label.
LABEL_GENERATION_REQUEST_ERROR 400 There was an error generating your label.
LABEL_GENERATION_RESPONSE_ERROR 400 There was an error generating your label: <Error Details>
VALIDATION_ERROR_LABELSIZE 400 LabelSize isn't found for merchant profile.
VALIDATION_ERROR_RETURNREASON 400 ReturnReason isn't found for merchant profile.
VALIDATION_ERROR_SERVICETYPE 400 ServiceType isn't found for this merchant profile.
Type HTTP Status Code Description
NO_MANIFEST_ITEMS 400 No mail items were available to manifest / closeout.
Type HTTP Status Code Description
ERROR_IN_IMAGE_CREATION 400 The system was unable to generate an image of the sort code / label
FACILITY_CODE_NULL 400 No DHL eCommerce Facility Code provided in the request
INCORRECT_WEIGHT_UNIT 400 No valid weight unit provided in the request
INVALID_MAIL_TYPE_OR_FORMAT 400 Mail Type Code unknown to DHL eCommerce
INVALID_PICKUP_CUSTOMER_NUMBER 400 Pickup Account Number unknown to DHL eCommerce
INVALID_PRODUCT_CODE 400 Product Code not valid for online processing
INVALID_REQUEST_TYPE 400 Request type provided in request does not match any known request type
INVALID_SERVICE_TYPE_CODE 400 Service Type Code provide as input to the request does not match any Service Type Code supported by DHL eCommerce
INVALID_SHIPPING_DATE_FORMAT 400 Shipping date provided in request not in the proper format
INVALID_ZIPCODE 400 The ZIP Code provided in the request is not a valid US Zip Code
INVALID_WEIGHT 400 Zero or negative weight provided in the request
MAIL_TYPE_OR_FORMAT_NULL 400 No Mail Type Code in the request
NO_ROUTING_FOUND 400 Using the data elements of the request, no valid USPS product could be found for the mail piece
PICKUP_CUSTOMER_NULL 400 No Pickup Account Number provided in the request
PRODUCT_CODE_NULL 400 No product code in the request
REQUEST_TYPE_NULL 400 Request did not contain a request type or request type was invalid
SERVICE_TYPE_CODE_DOESNT_MATCH_DSP_PRODUCT 400 Service Type Code provided as input to the request does not match the USPS Product as determined by DHL eCommerce
SHIPPING_DATE_BEYOND_ALLOWED_DATE 400 Shipping date beyond the maximum allowable date in the future
SHIPPING_DATE_NULL 400 No shipping date provided in the request
SLOT_NOT_FOUND 400 Using the data elements of the request, no valid sort code could be found for the mail piece
WEIGHT_NULL 400 No weight provided in the request
WEIGHT_UNIT_NULL 400 No weight unit provided in the request
ZIPCODE_NULL 400 No Zip Code in the request
Type HTTP Status Code Description
NO_DATA 400 No Results for your query
Facility Code Location
USATL1 Forest Park, GA
USBOS1 Franklin, MA
USBWI1 Elkridge, MD
USCVG1 Hebron, KY
USDEN1 Denver, CO
USDFW1 Grand Prairie, TX
USEWR1 Secaucus, NJ
USLAX1 Compton, CA
USMCO1 Orlando, FL
USMEM1 Memphis, TN
USORD1 Melrose Park, IL
USPHX1 Phoenix, AZ
USRDU1 Raleigh, NC
USSEA1 Auburn, WA
USSFO1 Union City, CA
USSLC1 Salt Lake City, UT
USSTL1 St. Louis, MO
Mail Type ID Name
2 Irregular Parcel
3 Machinable Parcel
6 BPM Machinable
7 Parcel Select Mach
8 Parcel Select NonMach
9 Media Mail
20 Marketing Parcel < 6oz
30 Marketing Parcel >= 6oz
Product ID Product Name
43 DHL GM Business Canada Post Lettermail International
41 DHL GM Business IPA International
42 DHL GM Business ISAL International
34 DHL GM Business Priority International
35 DHL GM Business Standard International
46 DHL GM Direct Canada Post Admail International
69 DHL GM Other International
56 DHL GM Packet IPA International
57 DHL GM Packet ISAL International
29 DHL GM Packet Plus International
27 DHL GM Packet Priority International
28 DHL GM Packet Standard International
59 DHL GM Parcel Canada Parcel Standard International
58 DHL GM Parcel Direct Express International
51 DHL GM Publication Canada Publication International
47 DHL GM Publication Priority International
48 DHL GM Publication Standard International
60 DHL Parcel International Direct International
54 DHL Parcel International Standard International
76 DHL SM BPM Expedited Domestic
77 DHL SM BPM Ground Domestic
72 DHL SM Flats Expedited Domestic
73 DHL SM Flats Ground Domestic
81 DHL SM Parcel Expedited Domestic
631 DHL SM Parcel Expedited Max Domestic
82 DHL SM Parcel Ground Domestic
36 DHL SM Parcel Plus Expedited Domestic
83 DHL SM Parcel Plus Ground Domestic
532 DHL SM Parcel Return Ground Domestic
531 DHL SM Parcel Return Light Domestic
491 DHL SM Parcel Return Plus Domestic
761 *Metro Same Day Domestic
764 *Metro Next Day Domestic
384 SM Marketing Parcel Expedited Domestic
383 SM Marketing Parcel Ground Domestic
44 Workshare DHL GM Business Priority International
45 Workshare DHL GM Business Standard International

* The Metro services are currently running in a beta phase and only available in the Chicago and Los Angeles area.

Product ID Product Name
76 DHL SM BPM Expedited
77 DHL SM BPM Ground
72 DHL SM Flats Expedited
73 DHL SM Flats Ground
81 DHL SM Parcel Expedited
631 DHL SM Parcel Expedited Max
82 DHL SM Parcel Ground
36 DHL SM Parcel Plus Expedited
83 DHL SM Parcel Plus Ground
761 *Metro Same Day
764 *Metro Next Day
384 SM Marketing Parcel Expedited
383 SM Marketing Parcel Ground

* The Metro services are currently running in a beta phase and only available in the Chicago and Los Angeles area.

Product ID Product Name
43 DHL GM Business Canada Post Lettermail
41 DHL GM Business IPA
42 DHL GM Business ISAL
34 DHL GM Business Priority
35 DHL GM Business Standard
46 DHL GM Direct Canada Post Admail
69 DHL GM Other
56 DHL GM Packet IPA
57 DHL GM Packet ISAL
29 DHL GM Packet Plus
27 DHL GM Packet Priority
28 DHL GM Packet Standard
59 DHL GM Parcel Canada Parcel Standard
58 DHL GM Parcel Direct Express
51 DHL GM Publication Canada Publication
47 DHL GM Publication Priority
48 DHL GM Publication Standard
60 DHL Parcel International Direct
54 DHL Parcel International Standard
44 Workshare DHL GM Business Priority
45 Workshare DHL GM Business Standard
Product ID Product Name   Min. Weight Max. Weight
532 DHL SM Parcel Return Ground Domestic 1 oz 1,120 oz (70 lbs)
531 DHL SM Parcel Return Light Domestic 1 oz 15.999 oz
491 DHL SM Parcel Return Plus Domestic 1 oz 1,120 oz (70 lbs)
Service Type Code Name
001 First Class Package - Del Con
021 First Class Package - Sig Con
025 Priority Mail
055 Priority Mail - Del Con
108 Priority Mail - Sig Con
419 BPM - Del Con
422 BPM - Sig Con
458 BPM
490 Media Mail - Del Con
493 Media Mail - Sig Con
521 Media Mail
551 Library Mail - Del Con
554 Library Mail - Sig Con
582 Library Mail
612 Parcel Select - Del Con
615 Parcel Select - Sig Con
642 Parcel Select
703 Standard Mail Marketing
704 Standard Mail Marketing - Del Con
742 First Class Package Service
748 Parcel Select LW - Del Con
789 Parcel Select LW
Service Endorsement Value
1 Address Service Requested
2 Forwarding Service Requested
3 Change Service Requested
4 Return Service Requested
Category Code Description Max. Weight Valid Products
01 Primary Contained in Equipment 11 lbs. SM Parcels Ground, SM Parcel Plus Ground, SM Parcel Plus Expedited, SM Parcels Expedited
02 Primary Packed with Equipment 11 lbs. SM Parcels Ground, SM Parcel Plus Ground
03 Primary Stand-Alone 5 lbs. SM Parcels Ground, SM Parcel Plus Ground
04 Secondary Contained in Equipment Expedited - 11 lbs.
Ground - 15 lbs.
SM Parcels Ground, SM Parcel Plus Ground, SM Parcel Plus Expedited, SM Parcels Expedited
05 Secondary Packed with Equipment 15 lbs. SM Parcels Ground, SM Parcel Plus Ground
06 Secondary Stand-Alone 15 lbs. SM Parcels Ground, SM Parcel Plus Ground
07 Lithium (ground only service for Primary and Secondary Lithium) 5 lbs. SM Parcels Ground, SM Parcel Plus Ground
08 ORM-D 15 lbs. SM Parcels Ground, SM Parcel Plus Ground
09 Small Quantity Provision 15 lbs. SM Parcels Ground, SM Parcel Plus Ground