getOrderItems

Returns detailed order item information for the order that you specify. If NextToken is provided, it's used to retrieve the next page of order items.

Note: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status 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 getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order.

Usage Plan:

Rate (requests per second)	Burst
0.5	30

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

Responses

🟢200OK

application/json

Success.

Headers

x-amzn-RateLimit-Limit

string

optional

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

x-amzn-RequestId

string

optional

Unique request reference identifier.

Body

The response schema for the `getOrderItems` operation.

payload

object (OrderItemsList)

optional

The order items list along with the order ID.

OrderItems

array[object (OrderItem) {7}]

required

A list of order items.

NextToken

string

optional

When present and not empty, pass this string token in the next request to return the next response page.

AmazonOrderId

string

required

An Amazon-defined order identifier, in 3-7-7 format.

errors

array[object (Error) {3}]

optional

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

code

string

required

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

message

string

required

A message that describes the error condition.

details

string

optional

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

Example

{
    "payload": {
        "AmazonOrderId": "903-1671087-0812628",
        "NextToken": "2YgYW55IGNhcm5hbCBwbGVhc3VyZS4",
        "OrderItems": [
            {
                "ASIN": "BT0093TELA",
                "OrderItemId": "68828574383266",
                "SellerSKU": "CBA_OTF_1",
                "Title": "Example item name",
                "QuantityOrdered": 1,
                "QuantityShipped": 1,
                "PointsGranted": {
                    "PointsNumber": 10,
                    "PointsMonetaryValue": {
                        "CurrencyCode": "JPY",
                        "Amount": "10.00"
                    }
                },
                "ItemPrice": {
                    "CurrencyCode": "JPY",
                    "Amount": "25.99"
                },
                "ShippingPrice": {
                    "CurrencyCode": "JPY",
                    "Amount": "1.26"
                },
                "ScheduledDeliveryEndDate": "2013-09-09T01:30:00Z",
                "ScheduledDeliveryStartDate": "2013-09-07T02:00:00Z",
                "CODFee": {
                    "CurrencyCode": "JPY",
                    "Amount": "10.00"
                },
                "CODFeeDiscount": {
                    "CurrencyCode": "JPY",
                    "Amount": "1.00"
                },
                "PriceDesignation": "BusinessPrice",
                "BuyerInfo": {
                    "BuyerCustomizedInfo": {
                        "CustomizedURL": "https://zme-caps.amazon.com/t/bR6qHkzSOxuB/J8nbWhze0Bd3DkajkOdY-XQbWkFralegp2sr_QZiKEE/1"
                    },
                    "GiftMessageText": "For you!",
                    "GiftWrapPrice": {
                        "CurrencyCode": "GBP",
                        "Amount": "41.99"
                    },
                    "GiftWrapLevel": "Classic"
                },
                "BuyerRequestedCancel": {
                    "IsBuyerRequestedCancel": "true",
                    "BuyerCancelReason": "Found cheaper somewhere else."
                },
                "SerialNumbers": [
                    "854"
                ]
            },
            {
                "ASIN": "BCTU1104UEFB",
                "OrderItemId": "79039765272157",
                "SellerSKU": "CBA_OTF_5",
                "Title": "Example item name",
                "QuantityOrdered": 2,
                "ItemPrice": {
                    "CurrencyCode": "JPY",
                    "Amount": "17.95"
                },
                "PromotionIds": [
                    "FREESHIP"
                ],
                "ConditionId": "Used",
                "ConditionSubtypeId": "Mint",
                "ConditionNote": "Example ConditionNote",
                "PriceDesignation": "BusinessPrice",
                "BuyerInfo": {
                    "BuyerCustomizedInfo": {
                        "CustomizedURL": "https://zme-caps.amazon.com/t/bR6qHkzSOxuB/J8nbWhze0Bd3DkajkOdY-XQbWkFralegp2sr_QZiKEE/1"
                    },
                    "GiftMessageText": "For you!",
                    "GiftWrapPrice": {
                        "CurrencyCode": "JPY",
                        "Amount": "1.99"
                    },
                    "GiftWrapLevel": "Classic"
                },
                "BuyerRequestedCancel": {
                    "IsBuyerRequestedCancel": "true",
                    "BuyerCancelReason": "Found cheaper somewhere else."
                }
            }
        ]
    }
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠429429

🔴500Server Error

🔴503Service Unavailable

Request

Request samples

Responses