ListInboundShipmentItems

Description

The ListInboundShipmentItems operation requests the first set of inbound shipment items for a given ShipmentId. A NextToken is also returned to further iterate through your remaining inbound shipment items. The service returns between one and N number of shipment items, where N is the value in the MaxCount parameter. Please check the value of HasNext to determine whether some items were not returned. To get the next set of inbound shipment items, you must call ListInboundShipmentItemsByNextToken and pass in the NextToken this call returned.

Request Parameters

Name Description Required

Name	Description	Required
`ShipmentId`	The shipment identifier for your shipment. Type: String Default: None Constraints: Must be a valid shipment identifier from GetInboundShipmentPreview.	Yes
`MaxCount`	Sets the maximum number of items to send back for each request. For example, if you set this value to `5`, the operation returns five items for each request until there are no more items to list. If you set the value to anything outside the range of [1,1000], the default value of 1,000 is used instead. Type: Integer Default: 1000 Constraints: 1 - 1000.	Yes

ShipmentId

The shipment identifier for your shipment.

Type: String

Default: None

Constraints: Must be a valid shipment identifier from GetInboundShipmentPreview.

Yes

MaxCount

Sets the maximum number of items to send back for each request. For example, if you set this value to 5, the operation returns five items for each request until there are no more items to list. If you set the value to anything outside the range of [1,1000], the default value of 1,000 is used instead.

Type: Integer

Default: 1000

Constraints: 1 - 1000.

Yes

Response Elements

Name Description

Name	Description
`HasNext`	Boolean to indicate whether there are more items returned. `True` means there are more items to retrieve using the next token version of this operation. `False` means there are no more items to retrieve. Type: Boolean
`NextToken`	Text string used to support pagination. Use the `NextToken` to perform an additional operation if the `HasNext` parameter is `True`. Type: String
`InboundShipmentItem`	Information about an item in a shipment. Type: InboundShipmentItem

HasNext

Boolean to indicate whether there are more items returned. True means there are more items to retrieve using the next token version of this operation. False means there are no more items to retrieve.

Type: Boolean

NextToken

Text string used to support pagination. Use the NextToken to perform an additional operation if the HasNext parameter is True.

Type: String

InboundShipmentItem

Information about an item in a shipment.

Type: InboundShipmentItem

Examples

Example SOAP Request

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soapenv:Header>
        <aws:AWSAccessKeyId
            soapenv:actor="http://schemas.xmlsoap.org/soap/actor/next"
            soapenv:mustUnderstand="0"
            xmlns:aws="http://security.amazonaws.com/doc/2007-01-01/"
            >1QZHP81N5R44N89PWYR2</aws:AWSAccessKeyId>
        <aws:Signature
            soapenv:actor="http://schemas.xmlsoap.org/soap/actor/next"
            soapenv:mustUnderstand="0"
            xmlns:aws="http://security.amazonaws.com/doc/2007-01-01/"
            >VY6sqvdk01VEG0V+h4oj3FB2TSY=</aws:Signature>
        <aws:Timestamp
            soapenv:actor="http://schemas.xmlsoap.org/soap/actor/next"
            soapenv:mustUnderstand="0"
            xmlns:aws="http://security.amazonaws.com/doc/2007-01-01/"
            >2009-02-21T02:40:36Z</aws:Timestamp>
    </soapenv:Header>
    <soapenv:Body>
        <ListInboundShipmentItems
            xmlns="http://fba-inbound.amazonaws.com/doc/2007-05-10/">
            <ShipmentId>SSFI9ASOZZJH1J</ShipmentId>
            <MaxCount>1000</MaxCount>
        </ListInboundShipmentItems>
    </soapenv:Body>
</soapenv:Envelope>

Example Query Request

https://fba-inbound.amazonaws.com/
?Action=ListInboundShipmentsItems
&Version=2007-05-10
&AWSAccessKeyId=1QZHP81N5R44N89PWYR2
&Signature=VY6sqvdk01VEG0V+h4oj3FB2TSY=
&Timestamp=2009-02-21T02:40:36Z
&ShipmentId=SSFI9ASOZZJH1J
&MaxCount=1000

Response (No Further Items)

<?xml version="1.0"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns1:ListInboundShipmentItemsResponse
            xmlns:ns1="http://fba-inbound.amazonaws.com/doc/2007-05-10/">
            <ns1:ListInboundShipmentItemsResult>
                <ns1:NextToken/>
                <ns1:HasNext>false</ns1:HasNext>
                <ns1:ShipmentItem>
                    <ns1:QuantityShipped>5</ns1:QuantityShipped>
                    <ns1:QuantityReceived>0</ns1:QuantityReceived>
                    <ns1:FulfillmentNetworkSKU>X00002GBED</ns1:FulfillmentNetworkSKU>
                    <ns1:MerchantSKU>ssof_dev_drt_afn_item</ns1:MerchantSKU>
                </ns1:ShipmentItem>
                <ns1:ShipmentItem>
                    <ns1:QuantityShipped>5</ns1:QuantityShipped>
                    <ns1:QuantityReceived>0</ns1:QuantityReceived>
                    <ns1:FulfillmentNetworkSKU>X00002HLRT</ns1:FulfillmentNetworkSKU>
                    <ns1:MerchantSKU>MSKUNikonD70</ns1:MerchantSKU>
                </ns1:ShipmentItem>
            </ns1:ListInboundShipmentItemsResult>
            <ns1:ResponseMetadata>
                <ns1:RequestId>ce70ec11-40c1-4f85-a350-b3c12267a415</ns1:RequestId>
            </ns1:ResponseMetadata>
        </ns1:ListInboundShipmentItemsResponse>
    </soapenv:Body>
</soapenv:Envelope>

Response (Further Items)

<?xml version="1.0"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns1:ListInboundShipmentItemsResponse
            xmlns:ns1="http://fba-inbound.amazonaws.com/doc/2007-05-10/">
            <ns1:ListInboundShipmentItemsResult>
                <ns1:NextToken>QTIzNEU5MVZQUEtKVFl8U1NGSTlBU09aWkpHVVB8MXxYMDAwMDJHQkVE</ns1:NextToken>
                <ns1:HasNext>true</ns1:HasNext>
                <ns1:ShipmentItem>
                    <ns1:QuantityShipped>5</ns1:QuantityShipped>
                    <ns1:QuantityReceived>0</ns1:QuantityReceived>
                    <ns1:FulfillmentNetworkSKU>X00002GBED</ns1:FulfillmentNetworkSKU>
                    <ns1:MerchantSKU>ssof_dev_drt_afn_item</ns1:MerchantSKU>
                </ns1:ShipmentItem>
            </ns1:ListInboundShipmentItemsResult>
            <ns1:ResponseMetadata>
                <ns1:RequestId>e2546a89-674f-4b7a-a912-0ca3d511794e</ns1:RequestId>
            </ns1:ResponseMetadata>
        </ns1:ListInboundShipmentItemsResponse>
    </soapenv:Body>
</soapenv:Envelope>

ListInboundShipmentItemsByNextToken