Sign in

815a5b6dbaa6

latestOpenAPI 3.0.0Apache License 2.02026-07-263171,5614.1 MB
Vendor Shipments v1

GetShipmentDetails

Returns the Details about Shipment, Carrier Details, status of the shipment, container details and other details related to shipment based on the filter parameters value that you specify.

Usage Plan:

Rate (requests per second)Burst
1010

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

get/vendor/shipping/v1/shipments

Query parameters

limitinteger

The limit to the number of records returned. Default value is 50 records.

sortOrder'ASC' | 'DESC'

Sort in ascending or descending order by purchase order creation date.

nextTokenstring

Used for pagination when there are more shipments than the specified result size limit.

createdAfterstring date-time

Get Shipment Details that became available after this timestamp will be included in the result. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.

createdBeforestring date-time

Get Shipment Details that became available before this timestamp will be included in the result. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.

shipmentConfirmedBeforestring date-time

Get Shipment Details by passing Shipment confirmed create Date Before. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.

shipmentConfirmedAfterstring date-time

Get Shipment Details by passing Shipment confirmed create Date After. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.

packageLabelCreatedBeforestring date-time

Get Shipment Details by passing Package label create Date by buyer. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.

packageLabelCreatedAfterstring date-time

Get Shipment Details by passing Package label create Date After by buyer. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.

shippedBeforestring date-time

Get Shipment Details by passing Shipped Date Before. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.

shippedAfterstring date-time

Get Shipment Details by passing Shipped Date After. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.

estimatedDeliveryBeforestring date-time

Get Shipment Details by passing Estimated Delivery Date Before. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.

estimatedDeliveryAfterstring date-time

Get Shipment Details by passing Estimated Delivery Date After. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.

shipmentDeliveryBeforestring date-time

Get Shipment Details by passing Shipment Delivery Date Before. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.

shipmentDeliveryAfterstring date-time

Get Shipment Details by passing Shipment Delivery Date After. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.

requestedPickUpBeforestring date-time

Get Shipment Details by passing Before Requested pickup date. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.

requestedPickUpAfterstring date-time

Get Shipment Details by passing After Requested pickup date. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.

scheduledPickUpBeforestring date-time

Get Shipment Details by passing Before scheduled pickup date. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.

scheduledPickUpAfterstring date-time

Get Shipment Details by passing After Scheduled pickup date. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.

currentShipmentStatusstring

Get Shipment Details by passing Current shipment status.

vendorShipmentIdentifierstring

Get Shipment Details by passing Vendor Shipment ID

buyerReferenceNumberstring

Get Shipment Details by passing buyer Reference ID

buyerWarehouseCodestring

Get Shipping Details based on buyer warehouse code. This value should be same as 'shipToParty.partyId' in the Shipment.

sellerWarehouseCodestring

Get Shipping Details based on vendor warehouse code. This value should be same as 'sellingParty.partyId' in the Shipment.

Response

Success.