Shipments

List Shipments

get/brands/{brand}/shipments

Request

  • Base URL: https://app.amber.ai/api/public/v1
  • URL: https://app.amber.ai/api/public/v1/brands/{brand}/shipments
  • Auth: HTTP bearer

Path parameters

brandstring required
Example:acme

Brand slug authorized by this API key.

Query parameters

cursorstring

Opaque nextCursor from the same collection and filters. Omit on the first request.

limitinteger
shipmentCodestring

Exact, case-sensitive match. Spaces and punctuation are literal.

trackingNumberstring

Exact, case-sensitive match. Spaces and punctuation are literal.

carrierstring

Exact, case-sensitive match. Spaces and punctuation are literal.

carrierSlugstring

Exact, case-sensitive match. Spaces and punctuation are literal.

freightForwarderstring

Exact, case-sensitive match. Spaces and punctuation are literal.

shipmentModestring

Exact, case-sensitive match. Spaces and punctuation are literal.

houseBillNumberstring

Exact, case-sensitive match. Spaces and punctuation are literal.

masterBillNumberstring

Exact, case-sensitive match. Spaces and punctuation are literal.

externalShipmentIdstring

Exact, case-sensitive match. Spaces and punctuation are literal.

externalBookingReferencestring

Exact, case-sensitive match. Spaces and punctuation are literal.

sourcestring

Exact, case-sensitive match. Spaces and punctuation are literal.

statusstring

Exact, case-sensitive match. Spaces and punctuation are literal.

dischargeLocationIdstring

Exact related entity ID.

pickupLocationIdstring

Exact related entity ID.

containerNumberstring

Exact member of containerNumbers.

originIdstring
destinationIdstring

Response

A page of matching records. totalItems counts all matches across pages. When nextCursor is null, you have reached the last page.

nextCursorstring nullable required
totalItemsinteger required

Total number of matching records across all pages.

Changes

No recorded changes to this operation across all 1 revision of this API.