Get Shipment By Number | CargoExtra Global Logistics USA

Returns one shipment by shipment number.

Path parameter: shipmentId shipment number.

Response fields: message, data shipment document.

Possible errors:

400: Invalid customer Id - admin customer filter is not a valid ObjectId.
404: Shipment not found - shipment number/id was not found.
400: Invalid Type/Status/Value - shipment filters or model values are outside allowed ranges.
400: Missing One or More Required Parameters - required body/query fields were not supplied.
401: Unauthorized - token is missing, expired, invalid, or the account/token pair was not found.
403: Access denied - gateway traffic guard/rate policy blocked the request.
429: Too many requests - gateway rate limit exceeded.
500: Unexpected Error - unhandled gateway or downstream service failure.

Returns one shipment by shipment number. Path parameter: `shipmentId` shipment number. Response fields: `message`, `data` shipment document. Possible errors: - 400: Invalid customer Id - admin customer filter is not a valid ObjectId. - 404: Shipment not found - shipment number/id was not found. - 400: Invalid Type/Status/Value - shipment filters or model values are outside allowed ranges. - 400: Missing One or More Required Parameters - required body/query fields were not supplied. - 401: Unauthorized - token is missing, expired, invalid, or the account/token pair was not found. - 403: Access denied - gateway traffic guard/rate policy blocked the request. - 429: Too many requests - gateway rate limit exceeded. - 500: Unexpected Error - unhandled gateway or downstream service failure.

Path parameters

shipmentIdstringRequired

ShipmentId path parameter.

Response

key_0integer

key_1string

key_2double

key_3string

key_4boolean

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error

Returns one shipment by shipment number.

Path parameter: shipmentId shipment number.

Response fields: message, data shipment document.

Possible errors:

400: Invalid customer Id - admin customer filter is not a valid ObjectId.
404: Shipment not found - shipment number/id was not found.
400: Invalid Type/Status/Value - shipment filters or model values are outside allowed ranges.
400: Missing One or More Required Parameters - required body/query fields were not supplied.
401: Unauthorized - token is missing, expired, invalid, or the account/token pair was not found.
403: Access denied - gateway traffic guard/rate policy blocked the request.
429: Too many requests - gateway rate limit exceeded.
500: Unexpected Error - unhandled gateway or downstream service failure.

1	{
2	"key_0": 7724,
3	"key_1": "NYC to LAX",
4	"key_2": 4012.68,
5	"key_3": "In Transit",
6	"key_4": false
7	}