HomeDocumentationCode SamplesAPI ReferenceAnnouncementsModelsRelease NotesFAQGitHubVideos
Developer HubAPI StatusSupport
API Reference
Developer HubAPI StatusSupport

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.530

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.

Path Params
string
required

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

Query Params
string

A string token returned in the response of your previous request.

Responses

Response body
object
payload
object

The order items list along with the order ID.

OrderItems
array of objects
required

A list of order items.

OrderItems*
object
string
required

The item's Amazon Standard Identification Number (ASIN).

string

The item's seller stock keeping unit (SKU).

string
required

An Amazon-defined order item identifier.

AssociatedItems
array of objects

A list of associated items that a customer has purchased with a product. For example, a tire installation service purchased with tires.

AssociatedItems
object
string

The order item's order identifier, in 3-7-7 format.

string

An Amazon-defined item identifier for the associated item.

string

The type of association an item has with an order item.

VALUE_ADD_SERVICE

Show Details
VALUE_ADD_SERVICEThe associated item is a service order.
string

The item's name.

integer
required

The number of items in the order.

integer

The number of items shipped.

ProductInfo
object

Product information on the number of items.

PointsGranted
object

The number of Amazon Points offered with the purchase of an item, and their monetary value.

ItemPrice
object

The monetary value of the order.

ShippingPrice
object

The monetary value of the order.

ItemTax
object

The monetary value of the order.

ShippingTax
object

The monetary value of the order.

ShippingDiscount
object

The monetary value of the order.

ShippingDiscountTax
object

The monetary value of the order.

PromotionDiscount
object

The monetary value of the order.

PromotionDiscountTax
object

The monetary value of the order.

PromotionIds
array of strings

A list of promotion identifiers provided by the seller when the promotions were created.

PromotionIds
CODFee
object

The monetary value of the order.

CODFeeDiscount
object

The monetary value of the order.

string

Indicates whether the item is a gift.

Possible values: true and false.

string

The condition of the item, as described by the seller.

string

The condition of the item.

Possible values: New, Used, Collectible, Refurbished, Preorder, and Club.

string

The subcondition of the item.

Possible values: New, Mint, Very Good, Good, Acceptable, Poor, Club, OEM, Warranty, Refurbished Warranty, Refurbished, Open Box, Any, and Other.

string

The start date of the scheduled delivery window in the time zone for the order destination. In ISO 8601 date time format.

string

The end date of the scheduled delivery window in the time zone for the order destination. In ISO 8601 date time format.

string

Indicates that the selling price is a special price that is only available for Amazon Business orders. For more information about the Amazon Business Seller Program, refer to the Amazon Business website.

Possible values: BusinessPrice

TaxCollection
object

Information about withheld taxes.

boolean

When true, the product type for this item has a serial number.

Only returned for Amazon Easy Ship orders.

boolean

When true, the ASIN is enrolled in Transparency. The Transparency serial number that you must submit is determined by:

1D or 2D Barcode: This has a T logo. Submit either the 29-character alpha-numeric identifier beginning with AZ or ZA, or the 38-character Serialized Global Trade Item Number (SGTIN).
2D Barcode SN: Submit the 7- to 20-character serial number barcode, which likely has the prefix SN. The serial number is applied to the same side of the packaging as the GTIN (UPC/EAN/ISBN) barcode.
QR code SN: Submit the URL that the QR code generates.

string

The IOSS number of the marketplace. Sellers shipping to the EU from outside the EU must provide this IOSS number to their carrier when Amazon has collected the VAT on the sale.

string

The store chain store identifier. Linked to a specific store in a store chain.

string

The category of deemed reseller. This applies to selling partners that are not based in the EU and is used to help them meet the VAT Deemed Reseller tax laws in the EU and UK.

IOSS UOSS

Show Details
IOSSImport one stop shop. The item being purchased is not held in the EU for shipment.
UOSSUnion one stop shop. The item being purchased is held in the EU for shipment.
BuyerInfo
object

A single item's buyer information.

BuyerRequestedCancel
object

Information about whether or not a buyer requested cancellation.

SerialNumbers
array of strings

A list of serial numbers for electronic products that are shipped to customers. Returned for FBA orders only.

SerialNumbers
SubstitutionPreferences
object

Substitution preferences for an order item.

Measurement
object

Measurement information for an order item.

ShippingConstraints
object

Delivery constraints applicable to this order.

AmazonPrograms
object

Contains the list of programs that are associated with an item.

Possible programs are:

  • Subscribe and Save: Offers recurring, scheduled deliveries to Amazon customers and Amazon Business customers for their frequently ordered products.
ExportInfo
object

Contains information that is related to the export of an order item.

string

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

string
required

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

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.

Language