Errors

In case of an error, either on client or server, the API response contains a well formed JSON object including the error code, description and other additional error metadata.

Definition

required

Array of objects

Array[Error]

Example

Copy

Copied

{
  "errors": [
     {
        "errorCode": "invalid_service_combination",
        "errorDescription": "Unsupported combination of service and special service.",
        "additionalCode": "1021119",
        "additionalInfo": "Unsupported special service  for selected Mail Service and or Parcel Type."
    },
    {
        "errorCode": "validation_error",
        "errorDescription": "Invalid or missing unit of measurement / weight value.",
        "additionalCode": "1000044",
        "additionalParameters": ["Weight UOM"]
    }
 ]
}

Codes

Error Code	Error Description	Additional Code	HTTP Status
description_required	description is required in customItems object	1101055	400
validation_error	missing or invalid dimensions and/or dimUnit for the parcel	0100057	400
validation_error	isHazmat option is invalid for single rate request	0100052	400
description_required	invalid description in customItems, Valid value range is 0 to 35 alphanumeric	1101057	400
validation_error	dimUnit is required in the parcel object	1000043	400
invalid_dimensions	weight/dimension unitOfMeasurement is invalid and should be of 2 characters	1009998	400
validation_error	Requested Dimensions outside the allowed limits. Requested(L,W,H)=(A,B,C), Maximums=(X,Y,Z), Minimums=(P,Q,R)	1021151	400
invalid_postal_code	postalCode is invalid/missing in fromAddress or toAddress	1021126	400
invalid_service_combination	unsupported combination of service and special service.	1021119	400
invalid_address	Invalid address provided.	1019003	400
invalid_serviceid	serviceId is required in the request body	1021203	400
invalid_serviceid	serviceId is invalid.	1021103	400
validation_error	serviceId is required	0100054	400
invalid_weight	unitOfMeasurement is required in weight object	1000044	400
invalid_weight	missing or invalid weight and/or weightUnit for the parcel	1021105	400
validation_error	Weight must be a properly formatted positive number	1021134	400
missing_address_line1	missing address lines in fromAddress or toAddress	1012049	400
missing_address_line1	invalid address line in fromAddress or toAddress	1019000	400
not_found	shipmentId not found	0100025	404
required_phone_number	Phone number required.	1021145	400
validation_error	Invalid/Missing value for Company Name of fromAddress.	1012052	400
validation_error	From Address State is a required field	0100002	400
validation_error	To Address State is a required field	0100003	400
validation_error	parcelType is invalid or missing in the request body	1021205	400
validation_error	customs object is required in the request body	0100009	400
validation_error	customsInfo object is required in customs object	0100010	400
validation_error	unsupported size or fileFormat value in the labelLayout object	1009998	400
validation_error	invalid carrier account id in the request	0100012	400
validation_error	customsItems object is required in customs object	1101002	400
validation_error	currencyCode is missing in the customsInfo object	1105006	400
validation_error	invalid currencyCode. Valid length is 3 alphanumeric	1009998	400
invalid_quantity	quantity in customItems is missing or should be greater than 0	1101051	400
validation_error	unitPrice in customItems is missing or should be greater than 0	1105000	400
validation_error	invalid unitOfMeasurement, should be of 2 characters	1009998	400
validation_error	weightUnit in customItems is missing or invalid	1105003	400
validation_error	Invalid Country of Origin for a Line item.	1105002	400
validation_error	unauthorized carrier account id in the request	0100013	400
validation_error	countryCode is required in the request body	0100017	400
validation_error	unsupported originCountryCode in the request parameter	0100020	400
validation_error	invalid destinationCountryCode, it should be valid 2 characters ISO code	0100021	400
validation_error	unable to get shipment details for shipmentId:	0100028	400
validation_error	invalid startDate in the request parameter, valid format is YYYY-MM-DD	0100029	400
validation_error	invalid endDate in the request parameter, valid format is YYYY-MM-DD	0100030	400
validation_error	inactive subscription	0100032	400
validation_error	subscription not found	0100033	400
validation_error	rates object missing in saved transaction	0100035	400
validation_error	customs information is not required for domestic shipments	0100036	400
validation_error	unable to get ledger balance	0100037	400
validation_error	ledger is inactive	0100038	400
validation_error	insufficient balance to create shipment	0100039	400
validation_error	only one carrier account is required for single rate	0100041	400
validation_error	incorrect parcelId provided	0100050	400
validation_error	carrier account is required for single rate	0100042	400
validation_error	special services are not supported for rate shop	0100043	400
invalid_weight	weight in customItems should not be more than package weight	1101205	400
invalid_dimensions	dimensions (length/width/height) in the request is missing or is outside the allowed limits. Maximums=(X,Y,Z), Minimums=(P,Q,R)	1021132	400
invalid_service_combination	Unsupported combination of service and special service.	1021314	400
cancelshipment_already_inititated	Cancelshipment already initiated	1070003	400
invalid_eelpfc_format	EELPFC has an invalid format, it must contain a proper AES Number, AESDOWN with valid information, or an appropriate Federal Trade Regulation Number.	1101031	400
validation_error	Domestic service to an international destination is not allowed	1021001	400
validation_error	invalid/missing countryCode in toAddress	1021003	400
validation_error	No shipments are available to create a scanform/manifest document	1110019	400
time_limit_passed	Manifest time limit has passed	1110013	400
validation_error	addressLines missing in the request	1010314	400
not_found	Original Transaction not found!	1090001	404
validation_error	invalid request for bulk shipment	0100047	400
invalid_service_parcel_type	Invalid combination of Service Id and Parcel type.	1021141	400
invalid_service	Incompatible service used	1021311	400
invalid_service_combination	Unsupported combination of service and special service.	1021122	400
invalid_service_combination	Unsupported combination of service and special service.	1022025	400
validation_error	reasonForExportExplanation must be used when reasonForExport is set to OTHER.	1101022	400
validation_error	Invalid or missing sold to phone number. Valid length is 1 to 15 alphanumeric.	1000500	400
validation_error	Shipments for Home Delivery Service must be designated as Residential Delivery also.	1021316	400
validation_error	STANDARD_OVERNIGHT is not supported for the destination.	1000500	400
validation_error	SmartPost hub id is invalid.	1021313	400
validation_error	Airbill is not allowed for Destination Country.	1021003	400
validation_error	Hub ID cannot be null or empty.	1021313	400
	Unauthorized API Access for given credentials.	1000033	400
validation_error	No Service Name, Service option, Rate Type combination found that matches the shopping request.	1022029	400
validation_error	A system error occurred, try again later. If the error persists, please contact the service provider.	1179999	400
validation_error	500 Internal Server Error.	1209999	400
validation_error	A system error occurred, try again later. If the error persists, please contact the service provider.	1009999	400
validation_error	A system error occurred, try again later. If the error persists, please contact the service provider.	1119999	400
validation_error	NA is not a valid state for the specified shipment.	1021313	400
validation_error	INTERNATIONAL_FIRST is not supported for the destination.	1000500	400
validation_error	Could not send Message.	1079999	400
validation_error	General Failure	1000051	400
validation_error	Void not available at this time. Please try again later.	1000500	400