The Error Response
Topics
If a REST request results in an error, the HTTP reply has:
An JSON error document as the response body
Content-Type: application/json
An appropriate 3xx, 4xx, or 5xx HTTP status code
Following is an example of a Error Response
{
"errorCode": "",
"reference": "fa08ecbb8e894890a1f787fec4c45080",
"message": "X",
"fields": [
{
Name: "Y",
Errors: [
"a",
"b",
"c"
]
}
]
}
Error Response Fields
| Field Name | Description |
|---|---|
| errorCode | An optional error code |
| reference | A unique transation id used to identify the request, this allows us to go back to the logs for this request |
| message | |
| fields | An optional set of fields with individual errors |
Error Codes
| Error Code | Description | |
|---|---|---|
| EC101 | An internal error occurred | More Help... |
| EC102 | An internal error occurred | More Help... |
| EC103 | An internal error occurred | More Help... |
| EC104 | An internal error occurred | More Help... |
| EC105 | An internal error occurred | More Help... |
| EC106 | An internal error occurred | More Help... |
| EC107 | An internal error occurred | More Help... |
| EC108 | An internal error occurred | More Help... |
| EB802 | Asendia Booking Failed | More Help... |
| EB803 | Asendia Booking Cancel Failed | More Help... |
| EB804 | Cancel Shipment Failed | More Help... |
| EC805 | An internal error occurred | More Help... |
| EB806 | Generic Booking Failed | More Help... |
| EB807 | Yodel Label Creating Failed | More Help... |
| EB808 | Yodel Booking Failed | More Help... |
| EB809 | Global Product Code Missing | More Help... |
| EB810 | DHL Shipping Exception | More Help... |
| EB813 | DocImages is required for Paperless Trade (PLT) shipments. | More Help... |
| EB814 | The origin country does not support Paperless shipment service. Please contact DHL representative for further information or resubmit as regular shipment. | More Help... |
| EB815 | You are not subscribed for Paperless shipment service. Please contact your DHL technical representative for Paperless shipment subscription. | More Help... |
| EB816 | Paperless shipment is suspended. Please contact your DHL technical representative for reactivation. | More Help... |
| EB817 | Paperless shipment service is not allowed for one of these reasons: Shipper or receiver country doesn't support Paperless Service, the product selected doesn't support Paperless or the declared value entered is greater than the allowed limit. Please contact DHL representative for further information or resubmit as regular shipment. | More Help... |
| EB818 | The total image sizes exceeded the maximum image size for Paperless shipment. Please check and resubmit with correct request message. | More Help... |
| EB819 | For shipments to Guernsey via road, value of shipment must be declared. | More Help... |
| EB820 | For shipments to Jersey via road, value of shipment must be declared. | More Help... |
| EB821 | Close time must be after ready time for collection | More Help... |
| EB819 | Usps Booking Failed | More Help... |
| EB820 | Session Expired Exception | More Help... |
| EB821 | Attempting to get processing result from ProcessWithUsps returns null, unable to process USPS shipment. | More Help... |
| EB822 | Post code is not valid, unable to process shipment. | More Help... |
| EB823 | User name is not valid, unable to process shipment. | More Help... |
| EB824 | USPS tracking number does not exist, unable to process USPS shipment. | More Help... |
| EB825 | Invalid destination code, unable to book USPS booking. | More Help... |
| EB826 | PackageId does not exist, unable to book USPS booking. | More Help... |
| EB827 | Booking with DeutschePost failed | More Help... |
| EB828 | Booking with DeutschePostUk/Global Mail failed | More Help... |
| EB829 | Attempting to get a token with the ClientId and ClientSecret failed | More Help... |
| EB830 | Opening an Order to contain collection of shipments failed | More Help... |
| EB831 | There are no open Orders to add the shipment to | More Help... |
| EB842 | Return is not bookable from this location. | More Help... |
| EB835 | Dpd Booking Failed | More Help... |
| EB836 | Hs Code should be 8 digits | More Help... |
| EB837 | Hs Code value invalid | More Help... |
| EB843 | The requested service is not bookable via DPD. | More Help... |
| EB833 | FedEx Booking Failed | More Help... |
| EB834 | Newgistics Booking Failed | More Help... |
| EB837 | Hermes Generic Booking Failed | More Help... |
| EV814 | Product details are required for the selected service. | More Help... |
| EB838 | UkMail Internal Error Occured | More Help... |
| EB839 | The requested Service via UKMail is not supported. Contact us at helpdesk@norsk-global.com | More Help... |
| EB813 | This shipment has timed out with DHL Parcel’s API. Please try the booking again and it should go through, if it does not or the error message changes please contact support | More Help... |
| EB840 | The requested Service for documents via Asendia is not supported. Contact us at helpdesk@norsk-global.com | More Help... |
| EB841 | Landmark Booking Failed | More Help... |
| EB842 | UPS Booking Failed | More Help... |
| EB844 | DAI Booking Failed | More Help... |
| EB845 | Cannot locate shipment by tracking number | More Help... |
| EB846 | Booking with Aramex failed | More Help... |
| EB847 | The username/password combination provided is disabled | More Help... |
| EB848 | The username/password combination provided is invalid | More Help... |
| EB849 | Division or Division Code is invalid | More Help... |
| EB850 | The value of the shipment doesn't match the sum total of each item | More Help... |
| EB851 | StarLinks Booking Failed | More Help... |
| EB852 | The username/password combination provided is disabled | More Help... |
| EB853 | The username/password combination provided is invalid | More Help... |
| EB854 | Attempting to get a token with the ClientId and ClientSecret failed | More Help... |
| EB855 | Mark Booking Failed | More Help... |
| EB856 | The username/password combination provided is disabled | More Help... |
| EB857 | The username/password combination provided is invalid | More Help... |
| EV801 | Format Error | More Help... |
| EV802 | Conditional Required Field | More Help... |
| EV803 | Invalid Field | More Help... |
| EV804 | Insufficient Time For Pickup | More Help... |
| EV805 | Multiple Pieces Not Supported On Selected Service | More Help... |
| EV806 | Booking Date Passed | More Help... |
| EV807 | Routing Invalid Location | More Help... |
| EV808 | Routing No Routing Option, Cannot Deliver to the Destination on the Selected Service | More Help... |
| EV809 | Supplier Label Format Not Supported | More Help... |
| EV810 | Ready by Time Too Late, Unable to order collection as time is later than Last Pickup. | More Help... |
| EC811 | An internal error occurred | More Help... |
| EC812 | An internal error occurred | More Help... |
| EV813 | The Total Shipment value must be greater than or equal to the total of all products. | More Help... |
| EV814 | Pre-Booking Validation failed, see attached reasons. | More Help... |
| ET501 | Supplier Api Unavailable | More Help... |
| ET502 | Label Generation Failed | More Help... |
| EB858 | RoyalMail Booking Failed | More Help... |
| EB859 | Fastway Booking Failed | More Help... |
| EB860 | XbxSpring Booking Failed | More Help... |
| EB861 | Skynet Booking Failed | More Help... |
| EB862 | Shippa Booking Failed | More Help... |
| EB863 | Dhl Booking Failed | More Help... |
Field Codes
| Field Code | Description |
|---|---|
| F1001 | Consignee_DivisionName |
| F1002 | Consignee_Contact_Email |
| F1003 | Customs_DeclaredValue |
| F1004 | Requestor |
| F1005 | Requestor_Name |
| F1006 | Pieces |
| F1007 | Pieces_Piece_Weight |
| F1008 | Pieces_Piece_Depth |
| F1009 | Pieces_Piece_Width |
| F1010 | Consignee |
| F1011 | Consignee_City |
| F1012 | Consignee_ContactName |
| F1013 | Consignee_CountryCode |
| F1014 | Consignee_Address1 |
| F1015 | Reference |
| F1016 | Pieces_Piece_Height |
| F1017 | Collection_PhoneNumber |
| F1018 | Collection_Zipcode |
| F1019 | Collection_Country |
| F1020 | Site_ContainerReference |
| F1021 | Consignee_CompanyName |
| F1022 | Consignee_Address2 |
| F1023 | Consignee_PhoneNumber |
| F1024 | Shipper_Address1 |
| F1025 | Shipper_ZipCode |
| F1026 | Consignee_Zipcode |
| F1027 | Consignee_Address |
| F1028 | Consignee_Address3 |
| F1029 | Product_Description |
| F1030 | ReadyByDate |
| F1031 | Piece_Product_HSCode |
| F1032 | Description |
| F1033 | Invoice |
| F1034 | Piece_Products |
| F1035 | Pieces_Total_Weight |
| F1036 | Piece_Product_CurrencyCode |
| F1037 | Shipper_VAT |
| F1038 | Consignee_VAT |
| F1039 | Piece_ProductData |
| F1040 | Shipper_PhoneNumber |
| F1041 | Shipper_CompanyName |
| F1042 | Shipper_ContactName |
| F1043 | Shipper_Address2 |
| F1044 | Shipper_Address3 |
| F1045 | Shipper_City |
| F1046 | Consignee_DivisionCode |
| F1047 | Shipper_DivisionCode |
| F1048 | Shipper_Email |
| F1049 | Importer_AccountNumber |
| F1050 | Pieces_Piece_Volume |
| F1051 | Pieces_Piece_Girth |
| F1052 | CustomsDeclaration_DangerousGoods_Type |
| F1053 | DDP |