Skip to navigation
CargoExtra Gateway API Copyshipment_adminShipment Admin Shipment ID

Get Shipment By Number

View as Markdown

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

OK
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