POST api/mws/orders/ListOrderItems

Returns order items based on the AmazonOrderId that you specify. 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. 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.

Request Information

URI Parameters

None.

Body Parameters

Request parameters to get list of order items based on the AmazonOrderId that you specify.

SuiteBridge.Models.AmazonMWS.AmzListOrderItemsRequest

Name	Description	Type	Additional information
AmazonOrderId	An Amazon-defined order identifier, in 3-7-7 format.	string	Required Max length: 50

Name

Description

Type

Additional information

AmazonOrderId

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

string

Required

Max length: 50

Request Formats

application/json, text/json

Sample:

{
  "AmazonOrderId": "sample string 1"
}

application/xml, text/xml

Sample:

<AmzListOrderItemsRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <AmazonOrderId>sample string 1</AmazonOrderId>
</AmzListOrderItemsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

List Orders Items Response

MarketplaceWebServiceOrders.Model.ListOrderItemsResponse

Name	Description	Type	Additional information
ListOrderItemsResult	Gets and sets the ListOrderItemsResult property.	MarketplaceWebServiceOrders.Model.ListOrderItemsResult	None.
ResponseMetadata	Gets and sets the ResponseMetadata property.	MarketplaceWebServiceOrders.Model.ResponseMetadata	None.
ResponseHeaderMetadata	Gets and sets the ResponseHeaderMetadata property.	MarketplaceWebServiceOrders.Model.ResponseHeaderMetadata	None.

Response Formats

application/json, text/json

Sample:

{
  "ListOrderItemsResult": {
    "NextToken": "sample string 1",
    "AmazonOrderId": "sample string 2",
    "OrderItems": [
      {
        "ASIN": "sample string 1",
        "SellerSKU": "sample string 2",
        "OrderItemId": "sample string 3",
        "Title": "sample string 4",
        "QuantityOrdered": 5.0,
        "QuantityShipped": 6.0,
        "PointsGranted": {
          "PointsNumber": 1.0,
          "PointsMonetaryValue": {
            "CurrencyCode": "sample string 1",
            "Amount": "sample string 2"
          }
        },
        "ItemPrice": {
          "CurrencyCode": "sample string 1",
          "Amount": "sample string 2"
        },
        "ShippingPrice": {
          "CurrencyCode": "sample string 1",
          "Amount": "sample string 2"
        },
        "GiftWrapPrice": {
          "CurrencyCode": "sample string 1",
          "Amount": "sample string 2"
        },
        "ItemTax": {
          "CurrencyCode": "sample string 1",
          "Amount": "sample string 2"
        },
        "ShippingTax": {
          "CurrencyCode": "sample string 1",
          "Amount": "sample string 2"
        },
        "GiftWrapTax": {
          "CurrencyCode": "sample string 1",
          "Amount": "sample string 2"
        },
        "ShippingDiscount": {
          "CurrencyCode": "sample string 1",
          "Amount": "sample string 2"
        },
        "PromotionDiscount": {
          "CurrencyCode": "sample string 1",
          "Amount": "sample string 2"
        },
        "PromotionIds": [
          "sample string 1",
          "sample string 2"
        ],
        "CODFee": {
          "CurrencyCode": "sample string 1",
          "Amount": "sample string 2"
        },
        "CODFeeDiscount": {
          "CurrencyCode": "sample string 1",
          "Amount": "sample string 2"
        },
        "GiftMessageText": "sample string 7",
        "GiftWrapLevel": "sample string 8",
        "InvoiceData": {
          "InvoiceRequirement": "sample string 1",
          "BuyerSelectedInvoiceCategory": "sample string 2",
          "InvoiceTitle": "sample string 3",
          "InvoiceInformation": "sample string 4"
        },
        "ConditionNote": "sample string 9",
        "ConditionId": "sample string 10",
        "ConditionSubtypeId": "sample string 11",
        "ScheduledDeliveryStartDate": "sample string 12",
        "ScheduledDeliveryEndDate": "sample string 13",
        "PriceDesignation": "sample string 14",
        "BuyerCustomizedInfo": {
          "CustomizedURL": "sample string 1"
        }
      },
      {
        "ASIN": "sample string 1",
        "SellerSKU": "sample string 2",
        "OrderItemId": "sample string 3",
        "Title": "sample string 4",
        "QuantityOrdered": 5.0,
        "QuantityShipped": 6.0,
        "PointsGranted": {
          "PointsNumber": 1.0,
          "PointsMonetaryValue": {
            "CurrencyCode": "sample string 1",
            "Amount": "sample string 2"
          }
        },
        "ItemPrice": {
          "CurrencyCode": "sample string 1",
          "Amount": "sample string 2"
        },
        "ShippingPrice": {
          "CurrencyCode": "sample string 1",
          "Amount": "sample string 2"
        },
        "GiftWrapPrice": {
          "CurrencyCode": "sample string 1",
          "Amount": "sample string 2"
        },
        "ItemTax": {
          "CurrencyCode": "sample string 1",
          "Amount": "sample string 2"
        },
        "ShippingTax": {
          "CurrencyCode": "sample string 1",
          "Amount": "sample string 2"
        },
        "GiftWrapTax": {
          "CurrencyCode": "sample string 1",
          "Amount": "sample string 2"
        },
        "ShippingDiscount": {
          "CurrencyCode": "sample string 1",
          "Amount": "sample string 2"
        },
        "PromotionDiscount": {
          "CurrencyCode": "sample string 1",
          "Amount": "sample string 2"
        },
        "PromotionIds": [
          "sample string 1",
          "sample string 2"
        ],
        "CODFee": {
          "CurrencyCode": "sample string 1",
          "Amount": "sample string 2"
        },
        "CODFeeDiscount": {
          "CurrencyCode": "sample string 1",
          "Amount": "sample string 2"
        },
        "GiftMessageText": "sample string 7",
        "GiftWrapLevel": "sample string 8",
        "InvoiceData": {
          "InvoiceRequirement": "sample string 1",
          "BuyerSelectedInvoiceCategory": "sample string 2",
          "InvoiceTitle": "sample string 3",
          "InvoiceInformation": "sample string 4"
        },
        "ConditionNote": "sample string 9",
        "ConditionId": "sample string 10",
        "ConditionSubtypeId": "sample string 11",
        "ScheduledDeliveryStartDate": "sample string 12",
        "ScheduledDeliveryEndDate": "sample string 13",
        "PriceDesignation": "sample string 14",
        "BuyerCustomizedInfo": {
          "CustomizedURL": "sample string 1"
        }
      }
    ]
  },
  "ResponseMetadata": {
    "RequestId": "sample string 1"
  },
  "ResponseHeaderMetadata": {
    "RequestId": null,
    "ResponseContext": "",
    "Timestamp": null,
    "QuotaMax": null,
    "QuotaRemaining": null,
    "QuotaResetsAt": null
  }
}

application/xml, text/xml

Sample:

<ListOrderItemsResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ListOrderItemsResult>
    <NextToken>sample string 1</NextToken>
    <AmazonOrderId>sample string 2</AmazonOrderId>
    <OrderItems>
      <OrderItem>
        <ASIN>sample string 1</ASIN>
        <SellerSKU>sample string 2</SellerSKU>
        <OrderItemId>sample string 3</OrderItemId>
        <Title>sample string 4</Title>
        <QuantityOrdered>5</QuantityOrdered>
        <QuantityShipped>6</QuantityShipped>
        <PointsGranted>
          <PointsNumber>1</PointsNumber>
          <PointsMonetaryValue>
            <CurrencyCode>sample string 1</CurrencyCode>
            <Amount>sample string 2</Amount>
          </PointsMonetaryValue>
        </PointsGranted>
        <ItemPrice>
          <CurrencyCode>sample string 1</CurrencyCode>
          <Amount>sample string 2</Amount>
        </ItemPrice>
        <ShippingPrice>
          <CurrencyCode>sample string 1</CurrencyCode>
          <Amount>sample string 2</Amount>
        </ShippingPrice>
        <GiftWrapPrice>
          <CurrencyCode>sample string 1</CurrencyCode>
          <Amount>sample string 2</Amount>
        </GiftWrapPrice>
        <ItemTax>
          <CurrencyCode>sample string 1</CurrencyCode>
          <Amount>sample string 2</Amount>
        </ItemTax>
        <ShippingTax>
          <CurrencyCode>sample string 1</CurrencyCode>
          <Amount>sample string 2</Amount>
        </ShippingTax>
        <GiftWrapTax>
          <CurrencyCode>sample string 1</CurrencyCode>
          <Amount>sample string 2</Amount>
        </GiftWrapTax>
        <ShippingDiscount>
          <CurrencyCode>sample string 1</CurrencyCode>
          <Amount>sample string 2</Amount>
        </ShippingDiscount>
        <PromotionDiscount>
          <CurrencyCode>sample string 1</CurrencyCode>
          <Amount>sample string 2</Amount>
        </PromotionDiscount>
        <PromotionIds>
          <string>sample string 1</string>
          <string>sample string 2</string>
        </PromotionIds>
        <CODFee>
          <CurrencyCode>sample string 1</CurrencyCode>
          <Amount>sample string 2</Amount>
        </CODFee>
        <CODFeeDiscount>
          <CurrencyCode>sample string 1</CurrencyCode>
          <Amount>sample string 2</Amount>
        </CODFeeDiscount>
        <GiftMessageText>sample string 7</GiftMessageText>
        <GiftWrapLevel>sample string 8</GiftWrapLevel>
        <InvoiceData>
          <InvoiceRequirement>sample string 1</InvoiceRequirement>
          <BuyerSelectedInvoiceCategory>sample string 2</BuyerSelectedInvoiceCategory>
          <InvoiceTitle>sample string 3</InvoiceTitle>
          <InvoiceInformation>sample string 4</InvoiceInformation>
        </InvoiceData>
        <ConditionNote>sample string 9</ConditionNote>
        <ConditionId>sample string 10</ConditionId>
        <ConditionSubtypeId>sample string 11</ConditionSubtypeId>
        <ScheduledDeliveryStartDate>sample string 12</ScheduledDeliveryStartDate>
        <ScheduledDeliveryEndDate>sample string 13</ScheduledDeliveryEndDate>
        <PriceDesignation>sample string 14</PriceDesignation>
        <BuyerCustomizedInfo>
          <CustomizedURL>sample string 1</CustomizedURL>
        </BuyerCustomizedInfo>
      </OrderItem>
      <OrderItem>
        <ASIN>sample string 1</ASIN>
        <SellerSKU>sample string 2</SellerSKU>
        <OrderItemId>sample string 3</OrderItemId>
        <Title>sample string 4</Title>
        <QuantityOrdered>5</QuantityOrdered>
        <QuantityShipped>6</QuantityShipped>
        <PointsGranted>
          <PointsNumber>1</PointsNumber>
          <PointsMonetaryValue>
            <CurrencyCode>sample string 1</CurrencyCode>
            <Amount>sample string 2</Amount>
          </PointsMonetaryValue>
        </PointsGranted>
        <ItemPrice>
          <CurrencyCode>sample string 1</CurrencyCode>
          <Amount>sample string 2</Amount>
        </ItemPrice>
        <ShippingPrice>
          <CurrencyCode>sample string 1</CurrencyCode>
          <Amount>sample string 2</Amount>
        </ShippingPrice>
        <GiftWrapPrice>
          <CurrencyCode>sample string 1</CurrencyCode>
          <Amount>sample string 2</Amount>
        </GiftWrapPrice>
        <ItemTax>
          <CurrencyCode>sample string 1</CurrencyCode>
          <Amount>sample string 2</Amount>
        </ItemTax>
        <ShippingTax>
          <CurrencyCode>sample string 1</CurrencyCode>
          <Amount>sample string 2</Amount>
        </ShippingTax>
        <GiftWrapTax>
          <CurrencyCode>sample string 1</CurrencyCode>
          <Amount>sample string 2</Amount>
        </GiftWrapTax>
        <ShippingDiscount>
          <CurrencyCode>sample string 1</CurrencyCode>
          <Amount>sample string 2</Amount>
        </ShippingDiscount>
        <PromotionDiscount>
          <CurrencyCode>sample string 1</CurrencyCode>
          <Amount>sample string 2</Amount>
        </PromotionDiscount>
        <PromotionIds>
          <string>sample string 1</string>
          <string>sample string 2</string>
        </PromotionIds>
        <CODFee>
          <CurrencyCode>sample string 1</CurrencyCode>
          <Amount>sample string 2</Amount>
        </CODFee>
        <CODFeeDiscount>
          <CurrencyCode>sample string 1</CurrencyCode>
          <Amount>sample string 2</Amount>
        </CODFeeDiscount>
        <GiftMessageText>sample string 7</GiftMessageText>
        <GiftWrapLevel>sample string 8</GiftWrapLevel>
        <InvoiceData>
          <InvoiceRequirement>sample string 1</InvoiceRequirement>
          <BuyerSelectedInvoiceCategory>sample string 2</BuyerSelectedInvoiceCategory>
          <InvoiceTitle>sample string 3</InvoiceTitle>
          <InvoiceInformation>sample string 4</InvoiceInformation>
        </InvoiceData>
        <ConditionNote>sample string 9</ConditionNote>
        <ConditionId>sample string 10</ConditionId>
        <ConditionSubtypeId>sample string 11</ConditionSubtypeId>
        <ScheduledDeliveryStartDate>sample string 12</ScheduledDeliveryStartDate>
        <ScheduledDeliveryEndDate>sample string 13</ScheduledDeliveryEndDate>
        <PriceDesignation>sample string 14</PriceDesignation>
        <BuyerCustomizedInfo>
          <CustomizedURL>sample string 1</CustomizedURL>
        </BuyerCustomizedInfo>
      </OrderItem>
    </OrderItems>
  </ListOrderItemsResult>
  <ResponseMetadata>
    <RequestId>sample string 1</RequestId>
  </ResponseMetadata>
  <ResponseHeaderMetadata />
</ListOrderItemsResponse>