Shipments

Get Shipments

get/brands/{brand}/shipments/{id}

Request

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

Path parameters

brandstring required
Example:acme

Brand slug authorized by this API key.

idstring required

Stable resource identifier.

Response

The requested record.

idstring required
shipmentCodestring required
statusstring required
trackingNumberstring nullable required
carrierstring nullable required
carrierSlugstring nullable required
freightForwarderstring nullable required
shipmentModestring nullable required
containerNumbersstring[] required
totalPacksnumber nullable required
grossWeightValuestring nullable required
grossWeightUomstring nullable required
volumeValuestring nullable required
volumeUomstring nullable required
incotermstring nullable required
incotermLocationstring nullable required
targetShipDatestring nullable required
agreedShipDatestring nullable required
revisedShipDatestring nullable required
actualShipDatestring nullable required
agreedPickupDatestring nullable required
revisedPickupDatestring nullable required
actualPickupDatestring nullable required
estimatedPortArrivalDatestring nullable required
actualPortArrivalDatestring nullable required
targetArrivalDatestring nullable required
estimatedArrivalDatestring nullable required
customsClearedDatestring nullable required
customsClearedDateSourcestring nullable required
actualArrivalDatestring nullable required
actualArrivalDateSourcestring nullable required
cargoReadyDatestring nullable required
bookingReceivedDatestring nullable required
houseBillNumberstring nullable required
masterBillNumberstring nullable required
estimatedCoststring nullable required
finalCoststring nullable required
customsCoststring nullable required
costCurrencystring nullable required
conveyanceReferencestring nullable required
loadTypestring nullable required
loadUtilizationstring nullable required
originIdstring nullable required
dischargeLocationIdstring nullable required
destinationIdstring nullable required
pickupLocationIdstring nullable required
sourcestring nullable required
externalShipmentIdstring nullable required
externalStatusstring nullable required
externalBookingReferencestring nullable required
lastEventOccurredAtstring nullable required
brandOwnerIdstring nullable required
customFieldsSchema0 required(unresolved $ref)
createdAtstring required
updatedAtstring required

Changes

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