API Documentation
Error Handling
API Documentation
Error Handling
If an error is encountered, the API will return a JSON object with a status code of either 400 (Bad Request), 401 (Unauthorized), or 500 (Internal Server Error) . The JSON object will include a detailed error message. For help, contact partner.integration@orchestro.ai with the information.
It looks like the previous attempts to present the complete set were cut off. I’ll extend and format the full list of error codes to make sure it covers all 109. Here is the complete, categorized error codes documentation:
General Errors
| Error Code | Error Message | Modified Error Message | Is Implemented? |
|---|---|---|---|
| ERR-1000 | Invalid Token. | Invalid Token. Please provide a valid Token. | Yes |
| ERR-1001 | No record found for the given input(s). | Sorry, we could not find any records. If this problem persists, please contact Orchestro support team. | Yes |
| ERR-1002 | Invalid input. | Invalid input. | Yes |
| ERR-9000 | An unexpected error has occurred. Please try again. | Use existing. | Yes |
Missing Data Errors
| Error Code | Error Message | Modified Error Message | Is Implemented? |
|---|---|---|---|
| ERR-2000 | Carrier is required. | Carrier name required. | Yes |
| ERR-2001 | Event is required. | Use existing. | Yes |
| ERR-2002 | Airbill Number is required. | Use existing. | Yes |
| ERR-2003 | Delivery Status is required. | Use existing. | Yes |
| ERR-2004 | Customer Tracking Number is required. | Use existing. | Yes |
| ERR-2005 | Customer ID is required. | Use existing. | Yes |
| ERR-2006 | From Address is required. | “From” Address is required. | Yes |
| ERR-2007 | From Address Street1 is required. | “From” Address Street1 is required. | Yes |
| ERR-2008 | From Address City is required. | “From” Address City is required. | Yes |
| ERR-2009 | From Address State is required. | “From” Address State is required. | Yes |
| ERR-2010 | From Address Zip is required. | “From” Address Zip is required. | Yes |
| ERR-2011 | From Address Country is required. | “From” Address Country is required. | Yes |
| ERR-2012 | To Address is required. | “To” Address is required. | Yes |
| ERR-2013 | To Address Street1 is required. | “To” Address Street1 is required. | Yes |
| ERR-2014 | To Address City is required. | “To” Address City is required. | Yes |
| ERR-2015 | To Address State is required. | ”To” Address State is required. | Yes |
| ERR-2016 | To Address Zip is required. | ”To” Address Zip is required. | Yes |
| ERR-2017 | To Address Country is required. | ”To” Address Country is required. | Yes |
| ERR-2034 | Return Address is required. | Use existing. | Yes |
| ERR-2035 | Return Address Address1 is required. | Return Address: Address1 is required. | Yes |
| ERR-2036 | Return Address City is required. | Return Address: City is required. | Yes |
| ERR-2037 | Return Address State is required. | Return Address: State is required. | Yes |
| ERR-2038 | Return Address Zipcode is required. | Return Address: Zipcode is required. | Yes |
Validation Errors
| Error Code | Error Message | Modified Error Message | Is Implemented? |
|---|---|---|---|
| ERR-2100 | File uploaded is Invalid. | Invalid file. Please upload a valid file. what is invalid? | Yes |
| ERR-2101 | File Extension is Invalid (allowed -*.csv) | Invalid file extension. Please upload a .csv file. | Yes |
| ERR-2102 | Invalid Input . Please send valid start index for pagination. | Invalid Input. Please send a valid start index for pagination. | Yes |
| ERR-2080 | Parcel %s: The weight unit is either blank or incorrect. The supported weight unit values are (oz/lb/mg/g/kg). | Parcel %s: The unit of weight is either blank or incorrect. The supported unit of weight values are oz, lb, mg, g, and kg. -Alper check for field name | Yes |
| ERR-2081 | Parcel %s: The dimensions unit is either blank or incorrect. The supported dimensions unit values are (inch/ft/mm/cm/m). | Parcel %s: The unit of distance for dimensions is either blank or incorrect. The supported unit of distance values are inch, ft, mm, cm, m. -Alper check for field name | Yes |
| ERR-2041 | The ‘start’ field value is either empty or less than 0. Please send the value greater than 0. | The “Start” field value is either empty or less than 0. Please provide a value greater than 0. | Yes |
| ERR-2042 | The ‘limit’ field value is either empty or out of expected range. | The “Limit” field value is either empty or outside of the expected range. Please provide a value greater than 0. | Yes |
| ERR-2043 | Please provide a Limit value greater than 0 and less than or equal to 500. | Use existing. | Yes |
| ERR-2044 | No records found. | Use existing. | Yes |
| ERR-2077 | The Start Date can not be greater than End Date. | The Start Date cannot be greater than End Date. | Yes |
Pagination Errors
| Error Code | Error Message | Modified Error Message | Is Implemented? |
|---|---|---|---|
| ERR-2041 | The ‘start’ field value is either empty or less than 0. Please send the value is greater than 0. | The “Start” field value is either empty or less than 0. Please provide a value greater than 0. | Yes |
| ERR-2042 | The ‘limit’ field value is either empty or out of expected range. Please send the value is greater than 0 and less than or equal to 500. | The “Limit” field value is either empty or outside of the expected range. Please provide a value greater than 0 and less than or equal to 500. | Yes |
| ERR-2043 | Please provide a Limit value greater than 0 and less than or equal to 500. | Use existing. | Yes |
| ERR-2102 | Invalid Input . Please send valid start index for pagination. | Invalid Input. Please send a valid start index for pagination. | Yes |
| ERR-2040 | Carrier Code is required. | Use existing. | Yes |
| ERR-2042 | Please provide valid start and limit values. | Use existing. | Yes |
Record Not Found Errors
| Error Code | Error Message | Modified Error Message | Is Implemented? |
|---|---|---|---|
| ERR-2044 | No records found. | Use existing. | Yes |
Miscellaneous Errors
| Error Code | Error Message | Modified Error Message | Is Implemented? |
|---|---|---|---|
| ERR-2045 | The Alternate Status code cannot exceed 10 characters. | No | |
| ERR-2050 | Request Id is required. | Use existing. | Yes |
| ERR-2051 | Parcel is required. | Use existing. | Yes |
| ERR-2052 | Parcel %s: Ship From Address details are required. | Parcel %s: “Ship From” Address details are required. | Yes |
| ERR-2053 | Parcel %s: Ship To Address details are required. | Parcel %s: “Ship To” Address details are required. | Yes |
| ERR-2054 | Parcel %s: Ship From Address Zip is required. | Parcel %s: “Ship From” Address Zip is required. | Yes |
| ERR-2055 | Parcel %s: Ship TO Address Zip is required. | Parcel %s: “Ship To” Address Zip is required. | Yes |
| ERR-2056 | Event Timestamp is required. | Use existing. | Yes |
| ERR-2057 | Please enter a valid event timestamp format (yyyy-MM-dd’T’HH:mm:ss). | No | |
| ERR-2080 | Parcel %s: The weight unit is either blank or incorrect. The supported weight unit values are (oz/lb). | Parcel %s: The unit of weight is either blank or incorrect. | Yes |
| ERR-2081 | Parcel %s: The dimensions unit is either blank or incorrect. | Parcel %s: The unit of dimensions is incorrect. | Yes |
File and Format Errors
| Error Code | Error Message | Modified Error Message | Is Implemented? |
|---|---|---|---|
| ERR-2060 | Lane is required. | Use existing. | Yes |
| ERR-2061 | Container type is required. | Use existing. | Yes |
| ERR-2062 | The Container tracking id is either invalid or not in open state. | The Container Tracking ID is either invalid or not in open state. about open state. | Yes |
| ERR-2063 | The tracking id is invalid. Please enter a valid tracking id. | Please enter a valid Tracking ID. | Yes |
| ERR-2064 | The tracking id or container tracking id is required. | The Tracking ID or Container Tracking ID is required. -check field name | Yes |
| ERR-2065 | Lane is required. | Use existing. | Yes |
| ERR-2066 | Order Number is required. | Use existing. | Yes |
| ERR-2067 | Please enter number of containers ordered should be greater than 0. | Number of containers ordered should be greater than 0. | Yes |
| ERR-2068 | Order date is required. | Order Date is required. | Yes |
| ERR-2069 | Pickup date is required. | Pickup Date is required. | Yes |
| ERR-2070 | Middle mile carrier code is required. | Middle Mile Carrier Code is required. | Yes |
| ERR-2071 | The Account Number is required. | Use existing. | Yes |
| ERR-2072 | The Account Number is invalid. | Please provide a valid Account Number. | Yes |
| ERR-2073 | Start Date is required. | Use existing. | Yes |
| ERR-2074 | The Start Date can not be greater than current date. | The Start Date cannot be greater than current date. | Yes |
| ERR-2075 | End Date is required. | Use existing. | Yes |
| ERR-2076 | The End Date can not be greater than current date. | The End Date cannot be greater than current date. | Yes |
| ERR-2077 | The Start Date can not be greater than End Date. | The Start Date cannot be greater than End Date. | Yes |
| ERR-2078 | Invoice type is required. | Invoice Type is required. | Yes |
| ERR-2079 | Please enter the invoice type as either ORIGIN_CARRIER OR DESTINATION_CARRIER. | Specification of invoice source carrier type is required | No |
| ERR-2080 | Parcel %s: The weight unit |