HomeDocumentationCode SamplesAPI ReferenceAnnouncementsModelsRelease NotesFAQGitHubVideos
Developer HubAPI StatusSupport
API Reference
Developer HubAPI StatusSupport
Start typing to search…

GetShipmentDetails

get https://sellingpartnerapi-na.amazon.com/vendor/shipping/v1/shipments

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.

Query Params
int64
1 to 50

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

string

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

string

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

date-time

Get Shipment Details that became available after this timestamp will be included in the result. Must be in ISO 8601 format.

date-time

Get Shipment Details that became available before this timestamp will be included in the result. Must be in ISO 8601 format.

date-time

Get Shipment Details by passing Shipment confirmed create Date Before. Must be in ISO 8601 format.

date-time

Get Shipment Details by passing Shipment confirmed create Date After. Must be in ISO 8601 format.

date-time

Get Shipment Details by passing Package label create Date by buyer. Must be in ISO 8601 format.

date-time

Get Shipment Details by passing Package label create Date After by buyer. Must be in ISO 8601 format.

date-time

Get Shipment Details by passing Shipped Date Before. Must be in ISO 8601 format.

date-time

Get Shipment Details by passing Shipped Date After. Must be in ISO 8601 format.

date-time

Get Shipment Details by passing Estimated Delivery Date Before. Must be in ISO 8601 format.

date-time

Get Shipment Details by passing Estimated Delivery Date Before. Must be in ISO 8601 format.

date-time

Get Shipment Details by passing Shipment Delivery Date Before. Must be in ISO 8601 format.

date-time

Get Shipment Details by passing Shipment Delivery Date After. Must be in ISO 8601 format.

date-time

Get Shipment Details by passing Before Requested pickup date. Must be in ISO 8601 format.

date-time

Get Shipment Details by passing After Requested pickup date. Must be in ISO 8601 format.

date-time

Get Shipment Details by passing Before scheduled pickup date. Must be in ISO 8601 format.

date-time

Get Shipment Details by passing After Scheduled pickup date. Must be in ISO 8601 format.

string

Get Shipment Details by passing Current shipment status.

string

Get Shipment Details by passing Vendor Shipment ID

string

Get Shipment Details by passing buyer Reference ID

string

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

string

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

Responses

Response body
object
payload
object

The request schema for the GetShipmentDetails operation.

pagination
object

The pagination elements required to retrieve the remaining data.

shipments
array of objects

A list of one or more shipments with underlying details.

shipments
object
string
required

Unique Transportation ID created by Vendor (Should not be used over the last 365 days).

string
required

Indicates the type of transportation request such as (New,Cancel,Confirm and PackageLabelRequest). Each transactiontype has a unique set of operation and there are corresponding details to be populated for each operation.

New Cancel

Show Details
NewInitial shipment Request.
CancelCancel existing shipment Request message. should be used only to cancel Shipment request
ConfirmConfirm the original Transport Request confirmation message.
PackageLabelRequestLabel request the original Transport Request confirmation message.
string

The buyer Reference Number is a unique identifier generated by buyer for all Collect/WePay shipments when you submit a transportation request. This field is mandatory for Collect/WePay shipments.

date-time
required

Date on which the transportation request was submitted.

string

Indicates the current shipment status.

Created TransportationRequested CarrierAssigned Shipped

Show Details
CreatedShipment request was received by buyer.
Transportation requestedBuyer to confirm with the carrier for pickup
Carrier assignedShipment is assigned to a carrier for pickup from vendor warehouse to Buyer FC / Warehouse.
ShippedShipment sent to buyer warehouse.
date-time

Date and time when the last status was updated.

shipmentStatusDetails
array of objects

Indicates the list of current shipment status details and when the last update was received from carrier this is available on shipment Details response.

shipmentStatusDetails
object
string

Current status of the shipment on whether it is picked up or scheduled.

Created TransportationRequested CarrierAssigned Shipped

Show Details
CreatedShipment request was received by buyer.
Transportation requestedBuyer to confirm with the carrier for pickup
Carrier assignedShipment is assigned to a carrier for pickup from vendor warehouse to Buyer FC / Warehouse.
ShippedShipment done to buyer warehouse.
date-time

Date and time on last status update received for the shipment

date-time

The date and time of the shipment request created by vendor.

date-time

The date and time of the departure of the shipment from the vendor's location. Vendors are requested to send ASNs within 30 minutes of departure from their warehouse/distribution center or at least 6 hours prior to the appointment time at the Buyer destination warehouse, whichever is sooner. Shipped date mentioned in the shipment confirmation should not be in the future.

date-time

The date and time of the package label created for the shipment by buyer.

string

Indicates if this transportation request is WePay/Collect or TheyPay/Prepaid. This is a mandatory information.

Collect Prepaid

Show Details
CollectBuyer Pays / We Pay for the the transportation. Buyer pays for the shipment and provides Vendor and picks up shipment from vendor warehouse / location
PrepaidVendor pays / They Pay for the transportation. Vendor pays for the shipment and ships the goods to buyer warehouse / location
sellingParty
object
required

Name/Address and tax details of the party.

shipFromParty
object
required

Name/Address and tax details of the party.

shipToParty
object
required

Name/Address and tax details of the party.

shipmentMeasurements
object

Shipment measurement details.

collectFreightPickupDetails
object

Transport Request pickup date from Vendor Warehouse by Buyer

purchaseOrders
array of objects

Indicates the purchase orders involved for the transportation request. This group is an array create 1 for each PO and list their corresponding items. This information is used for deciding the route,truck allocation and storage efficiently. This is a mandatory information for Buyer performing transportation from vendor warehouse (WePay/Collect)

purchaseOrders
object
string

Purchase order numbers involved in this shipment, list all the PO that are involved as part of this shipment.

date-time

Purchase order numbers involved in this shipment, list all the PO that are involved as part of this shipment.

string

Date range in which shipment is expected for these purchase orders.

items
array of objects

A list of the items that are associated to the PO in this transport and their associated details.

items
object
string
required

Item sequence number for the item. The first item will be 001, the second 002, and so on. This number is used as a reference to refer to this item from the carton or pallet level.

string

Amazon Standard Identification Number (ASIN) for a SKU

string

The vendor selected product identification of the item. Should be the same as was sent in the purchase order.

shippedQuantity
object
required

Details of item quantity.

maximumRetailPrice
object

An amount of money, including units in the form of currency.

importDetails
object

Provide these fields only if this shipment is a direct import.

containers
array of objects

A list of the items in this transportation and their associated inner container details. If any of the item detail fields are common at a carton or a pallet level, provide them at the corresponding carton or pallet level.

containers
object
string
required

The type of container.

carton pallet

Show Details
cartonA carton is a box or container usually made of liquid packaging board, paperboard and sometimes of corrugated fiberboard
palletA flat transport structure which supports goods in a stable fashion while being lifted by a forklift.
string

An integer that must be submitted for multi-box shipments only, where one item may come in separate packages.

containerIdentifiers
array of objects
required

A list of carton identifiers.

containerIdentifiers*
object
string
required

The container identification type.

SSCC AMZNCC GTIN BPS CID

Show Details
SSCC2 Digit Application Identifier (00) followed by unique 18-digit Serial Shipment Container Code (SSCC) to be included to define a pallet/carton and to identify its contents.
AMZNCCAmazon Container Code - a substitute for a SSCC that is generated by Amazon for small vendors and associated with a pallet/carton label.
GTINGlobal Trade Identification Number (part of the standard GS1 barcoding and product identification system).
BPSBarcode Packing Slip.
CIDContainer identifier for import shipments.
string
required

Container identification number that adheres to the definition of the container identification type.

string

The tracking number used for identifying the shipment.

dimensions
object

Physical dimensional measurements of a container.

weight
object

The weight of the shipment.

integer

Number of layers per pallet.

integer

Number of cartons per layer on the pallet.

innerContainersDetails
object

Details of the innerContainersDetails.

packedItems
array of objects

A list of packed items.

packedItems
object
string

Item sequence number for the item. The first item will be 001, the second 002, and so on. This number is used as a reference to refer to this item from the carton or pallet level.

string

Buyer Standard Identification Number (ASIN) of an item.

string

The vendor selected product identification of the item. Should be the same as was sent in the purchase order.

packedQuantity
object

Details of item quantity.

itemDetails
object

Item details for be provided for every item in shipment at either the item or carton or pallet level, whichever is appropriate.

transportationDetails
object

Transportation details for this shipment.

errors
array of objects

A list of error responses returned when a request is unsuccessful.

errors
object
string
required

An error code that identifies the type of error that occurred.

string
required

A message that describes the error condition.

string

Additional details that can help the caller understand or fix the issue.

Headers
object
string

Your rate limit (requests per second) for this operation.

string

Unique request reference identifier.

Updated 3 months ago

Did this page help you?
Language

Updated 3 months ago

Did this page help you?