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

ListOrderItems

Returns order items based on the AmazonOrderId that you specify.

Description

The ListOrderItems operation returns order item information for an AmazonOrderId that you specify. The order item information includes Title, ASIN, SellerSKU, ItemPrice, ShippingPrice, as well as tax and promotion information.

You can retrieve order item information by first using the ListOrders operation to find orders created or updated during a time frame that you specify. An AmazonOrderId is included with each order that is returned. You can then use these AmazonOrderId values with the ListOrderItems operation to get detailed order item information for each order.

Note: When an order is in the Pending state (the order has been placed but payment has not been authorized), the ListOrderItems operation does not return information about pricing, taxes, shipping charges, gift wrapping, or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the ListOrderItems operation returns information about pricing, taxes, shipping charges, gift wrapping, and promotions for the order items in the order.

The following response elements are not available for orders with an OrderStatus of Pending but are available for orders with an OrderStatus of Unshipped, Partially Shipped, or Shipped state:

  • ItemTax
  • GiftWrapPrice
  • ItemPrice
  • PromotionDiscount
  • GiftWrapTax
  • ShippingTax
  • ShippingPrice
  • ShippingDiscount

Availability

This operation is available in all marketplaces.

Throttling

The ListOrderItems and ListOrderItemsByNextToken operations together share a maximum request quota of 30 and a restore rate of one request every two seconds. For definitions of throttling terminology, see Orders API.

Request parameters

Name Description Required Values
AmazonOrderId An Amazon-defined order identifier, in 3-7-7 format. Yes Type: xs:string

Response elements

Name Description Required Values
NextToken A generated string used to pass information to your next request. If NextToken is returned, pass the value of NextToken to ListOrderItemsByNextToken. If NextToken is not returned, there are no more order items to return. No Type: xs:string
AmazonOrderId An Amazon-defined order identifier, in 3-7-7 format. Yes Type: xs:string
OrderItems A list of order items. Yes Type: List of OrderItem

Examples

Example query request

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

Show example code Hide example code

https://mws.amazonservices.jp/Orders/2013-09-01
  ?AWSAccessKeyId=0PB842EXAMPLE7N4ZTR2
  &Action=ListOrderItems
  &MWSAuthToken=amzn.mws.4ea38b7b-f563-7709-4bae-87aeaEXAMPLE
  &SellerId=A1XEXAMPLE5E6
  &AmazonOrderId=058-1233752-8214740
  &Signature=ZQLpf8vEXAMPLE0iC265pf18n0%3D
  &SignatureVersion=2
  &SignatureMethod=HmacSHA256
  &Timestamp=2013-09-05T18%3A12%3A21.687Z
  &Version=2013-09-01 

↑ Top

Example response

For information about standard response formatting, see Response format.

Show example code Hide example code

<ListOrderItemsResponse xmlns="https://mws.amazonservices.com/Orders/2013-09-01">
    <ListOrderItemsResult>
        <NextToken>MRgZW55IGNhcm5hbCBwbGVhc3VyZS6=</NextToken>
        <AmazonOrderId>058-1233752-8214740</AmazonOrderId>
        <OrderItems>
            <OrderItem>
                <ASIN>BT0093TELA</ASIN>
                <OrderItemId>68828574383266</OrderItemId>
                <BuyerCustomizedInfo>
                    <CustomizedURL>https://zme-caps.amazon.com/t/bR6qHkzSOxuB/J8nbWhze0Bd3DkajkOdY-XQbWkFralegp2sr_QZiKEE/1</CustomizedURL>
                </BuyerCustomizedInfo>
                <SellerSKU>CBA_OTF_1</SellerSKU>
                <Title>Example item name</Title>
                <QuantityOrdered>1</QuantityOrdered>
                <QuantityShipped>1</QuantityShipped>
                <ProductInfo>
                    <NumberOfItems>12</NumberOfItems>
                </ProductInfo>
                <PointsGranted>
                    <PointsNumber>10</PointsNumber>
                    <PointsMonetaryValue>
                        <CurrencyCode>JPY</CurrencyCode>
                        <Amount>10.00</Amount>
                    </PointsMonetaryValue>
                </PointsGranted>
                <ItemPrice>
                    <CurrencyCode>JPY</CurrencyCode>
                    <Amount>25.99</Amount>
                </ItemPrice>
                <ShippingPrice>
                    <CurrencyCode>JPY</CurrencyCode>
                    <Amount>1.26</Amount>
                </ShippingPrice>
                <ScheduledDeliveryEndDate>2013-09-09T01:30:00.000-06:00 </ScheduledDeliveryEndDate>
                <ScheduledDeliveryStartDate>2013-09-071T02:00:00.000-06:00 </ScheduledDeliveryStartDate>
                <CODFee>
                    <CurrencyCode>JPY</CurrencyCode>
                    <Amount>10.00</Amount>
                </CODFee>
                <CODFeeDiscount>
                    <CurrencyCode>JPY</CurrencyCode>
                    <Amount>1.00</Amount>
                </CODFeeDiscount>
                <IsGift>false</IsGift>
                <IsTransparency>true</IsTransparency>
                <GiftMessageText>For you!</GiftMessageText>
                <GiftWrapPrice>
                    <CurrencyCode>JPY</CurrencyCode>
                    <Amount>1.99</Amount>
                </GiftWrapPrice>
                <GiftWrapLevel>Classic</GiftWrapLevel>
                <PriceDesignation>BusinessPrice</PriceDesignation>
            </OrderItem>
            <OrderItem>
                <ASIN>BCTU1104UEFB</ASIN>
                <OrderItemId>79039765272157</OrderItemId>
                <SellerSKU>CBA_OTF_5</SellerSKU>
                <Title>Example item name</Title>
                <QuantityOrdered>2</QuantityOrdered>
                <ItemPrice>
                    <CurrencyCode>JPY</CurrencyCode>
                    <Amount>17.95</Amount>
                </ItemPrice>
                <PromotionIds>
                    <PromotionId>FREESHIP</PromotionId>
                </PromotionIds>
                <ConditionId>Used</ConditionId>
                <ConditionSubtypeId>Mint</ConditionSubtypeId>
                <ConditionNote>Example ConditionNote</ConditionNote>
                <IsGift>false</IsGift>
                <IsTransparency>false</IsTransparency>
                <PriceDesignation>BusinessPrice</PriceDesignation>
                <TaxCollection>
                    <Model>MarketplaceFacilitator</Model>
                    <ResponsibleParty>Amazon Services, Inc.</ResponsibleParty>
                </TaxCollection>
            </OrderItem>
        </OrderItems>
    </ListOrderItemsResult>
    <ResponseMetadata>
        <RequestId>88faca76-b600-46d2-b53c-0c8c4533e43a</RequestId>
    </ResponseMetadata>
</ListOrderItemsResponse>

↑ Top