Amazon Services
Amazon Marketplace Web Service (Amazon MWS) Documentation
Amazon MWS Documentation

ListInboundShipments

Returns a list of inbound shipments based on criteria that you specify.

Description

The ListInboundShipments operation returns a list of inbound shipments based on request parameters that you specify. You can use the ShipmentIdList request parameter to request inbound shipments by their ShipmentId values. You can also request inbound shipments based on their shipment status and by when they were last updated.

A ShipmentId is generated by submitting the CreateInboundShipmentPlan operation and remains the primary identifier for an inbound shipment throughout the inbound shipment process.

The ListInboundShipments operation returns a maximum of 50 inbound shipments. If there are additional inbound shipments to return, NextToken is returned in the response. To retrieve all of the inbound shipments, pass the value of NextToken to the ListInboundShipmentsByNextToken operation and repeat until NextToken is no longer returned.

Availability

This operation is available in all marketplaces except Brazil.

Throttling

The ListInboundShipments and ListInboundShipmentsByNextToken operations together share a maximum request quota of 30 and a restore rate of two requests every second. For definitions of throttling terminology and for a complete explanation of throttling, see Throttling: Limits to how often you can submit requests in the Amazon MWS Developer Guide.

Request parameters

For more information about the request parameters that are required for all Amazon MWS operations, see Required request parameters in the Amazon MWS Developer Guide.

Name Description Required Values
ShipmentStatusList A list of ShipmentStatusvalues. Used to select shipments with a current status that matches the status values that you specify. Yes, if ShipmentIdList is not specified.

If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned.

ShipmentStatus values:
  • WORKING - The shipment was created by the seller, but has not yet shipped.
  • SHIPPED - The shipment was picked up by the carrier.
  • IN_TRANSIT - The carrier has notified the Amazon fulfillment center that it is aware of the shipment.
  • DELIVERED - The shipment was delivered by the carrier to the Amazon fulfillment center.
  • CHECKED_IN - The shipment was checked-in at the receiving dock of the Amazon fulfillment center.
  • RECEIVING - The shipment has arrived at the Amazon fulfillment center, but not all items have been marked as received.
  • CLOSED - The shipment has arrived at the Amazon fulfillment center and all items have been marked as received.
  • CANCELLED - The shipment was cancelled by the seller after the shipment was sent to the Amazon fulfillment center.
  • DELETED - The shipment was cancelled by the seller before the shipment was sent to the Amazon fulfillment center.
  • ERROR - There was an error with the shipment and it was not processed by Amazon.

Type: List of type: xs:string

ShipmentIdList A list of ShipmentId values. Used to select shipments with ShipmentId values that match the ShipmentId values that you specify. Yes, if ShipmentStatusList is not specified.

If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned.

Type: List of type: xs:string
LastUpdatedAfter A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller. No

If LastUpdatedBefore is specified, then LastUpdatedAfter must be specified.

Must be earlier than LastUpdatedBefore.

In ISO 8601 date time format.

Type: xs:dateTime

LastUpdatedBefore A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller. No

If LastUpdatedAfter is specified, then LastUpdatedBefore must be specified.

Must be later than LastUpdatedAfter.

In ISO 8601 date time format.

Type: xs:dateTime

Response elements

Name Description
NextToken A generated string used to pass information to your next request. If NextToken is returned, pass the value of NextToken to ListInboundShipmentsByNextToken. If NextToken is not returned, there are no more inbound shipments to return.

Optional

Type: xs:string
ShipmentData Information about your inbound shipments. The ShipmentData response element does not include item information.

Type: InboundShipmentInfo

Examples

Example query request

For information about standard request requirements, see Required request parameters.

Show example code Hide example code

http://mws.amazonaws.com/FulfillmentInboundShipment/2010-10-01
  ?AWSAccessKeyId=AKIAJGUVGFGHNKE2NVUA
  &Action=ListInboundShipments
  &MWSAuthToken=amzn.mws.4ea38b7b-f563-7709-4bae-87aeaEXAMPLE
  &SignatureVersion=2
  &Timestamp=2015-12-02T02:40:36Z
  &Version=2010-10-01
  &Signature=COwchWurFSmkpQ9OOCoZy5THApVmrpf0mtyxk5ShtrI%3D
  &SignatureMethod=HmacSHA256
  &ShipmentStatusList.member.1=WORKING
  &SellerId=A2NKEXAMPLEF53
  &LastUpdatedAfter=2015-10-02T12%3A00%3A54Z
  $LastUpdatedBefore=2015-11-02T12%3A00%3A54Z
  &ShipmentStatusList.member.2=CLOSED
  &ShipmentIdList.member.1=FBA44JV8R
  &ShipmentIdList.member.2=FBA4X8YLS
  &ShipmentIdList.member.3=FBA4X9FML

↑ Top

Example response

For information about standard response formatting, see Response format.

Show example code Hide example code

<?xml version="1.0"?>
<ListInboundShipmentsResponse
    xmlns="http://mws.amazonaws.com/FulfillmentInboundShipment/2010-10-01/">
    <ListInboundShipmentsResult>
        <ShipmentData>
            <member>
                <ShipFromAddress>
                    <PostalCode>V5V 1A1</PostalCode>
                    <Name>jsowprni Devo CA20</Name>
                    <CountryCode>CA</CountryCode>
                    <StateOrProvinceCode>BC</StateOrProvinceCode>
                    <AddressLine1>Address Line 1</AddressLine1>
                    <City>Vancouver</City>
                </ShipFromAddress>
                <ShipmentId>FBAN4QNH</ShipmentId>
                <ShipmentName>FBA (8/27/12 1:55 PM)</ShipmentName>
                <ShipmentStatus>WORKING</ShipmentStatus>
                <LabelPrepType>NO_LABEL</LabelPrepType>
                <DestinationFulfillmentCenterId>YYZ1</DestinationFulfillmentCenterId>
            </member>
            <member>
                <ShipFromAddress>
                    <PostalCode>V5V 1A1</PostalCode>
                    <Name>Janani Arvind FBA QA</Name>
                    <CountryCode>CA</CountryCode>
                    <StateOrProvinceCode>BC</StateOrProvinceCode>
                    <AddressLine1>Address 1</AddressLine1>
                    <City>Vancouver</City>
                </ShipFromAddress>
                <ShipmentId>FBA1123</ShipmentId>
                <ShipmentName>Test MWS CA Shipment 1</ShipmentName>
                <ShipmentStatus>WORKING</ShipmentStatus>
                <LabelPrepType>NO_LABEL</LabelPrepType>
                <DestinationFulfillmentCenterId>RIC2</DestinationFulfillmentCenterId>
                <BoxContentsSource>NONE</BoxContentsSource>
                <EstimatedBoxContentsFee>
                    <TotalUnits>10</TotalUnits>
                    <FeePerUnit>
                        <CurrencyCode>USD</CurrencyCode>
                        <Value>0.10</Value>
                    </FeePerUnit>
                    <TotalFee>
                        <CurrencyCode>USD</CurrencyCode>
                        <Value>10.0</Value>
                    </TotalFee>
                </EstimatedBoxContentsFee>
            </member>
        </ShipmentData>
    </ListInboundShipmentsResult>
</ListInboundShipmentsResponse>

↑ Top