API docs by Redocly

Selling Partner API for Orders (v0)

Download OpenAPI specification:Download

URL: https://sellercentral.amazon.com/gp/mws/contactus.html

The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.

ordersV0

getOrders

Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria.

Usage Plan:

Rate (requests per second) Burst
0.0167 20

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

query Parameters
CreatedAfter
string

A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. Either the CreatedAfter parameter or the LastUpdatedAfter parameter is required. Both cannot be empty. The date must be in ISO 8601 format.

CreatedBefore
string

A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in ISO 8601 format.

LastUpdatedAfter
string

A date used for selecting orders that were last updated after (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in ISO 8601 format.

LastUpdatedBefore
string

A date used for selecting orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in ISO 8601 format.

OrderStatuses
Array of strings

A list of OrderStatus values used to filter the results.

Possible values:

  • PendingAvailability (This status is available for pre-orders only. The order has been placed, payment has not been authorized, and the release date of the item is in the future.)
  • Pending (The order has been placed but payment has not been authorized.)
  • Unshipped (Payment has been authorized and the order is ready for shipment, but no items in the order have been shipped.)
  • PartiallyShipped (One or more, but not all, items in the order have been shipped.)
  • Shipped (All items in the order have been shipped.)
  • InvoiceUnconfirmed (All items in the order have been shipped. The seller has not yet given confirmation to Amazon that the invoice has been shipped to the buyer.)
  • Canceled (The order has been canceled.)
  • Unfulfillable (The order cannot be fulfilled. This state applies only to Multi-Channel Fulfillment orders.)
MarketplaceIds
required
Array of strings <= 50 items

A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces.

See the Selling Partner API Developer Guide for a complete list of marketplaceId values.

FulfillmentChannels
Array of strings

A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. Possible values: AFN (Fulfillment by Amazon); MFN (Fulfilled by the seller).

PaymentMethods
Array of strings

A list of payment method values. Used to select orders paid using the specified payment methods. Possible values: COD (Cash on delivery); CVS (Convenience store payment); Other (Any payment method other than COD or CVS).

BuyerEmail
string

The email address of a buyer. Used to select orders that contain the specified email address.

SellerOrderId
string

An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If SellerOrderId is specified, then FulfillmentChannels, OrderStatuses, PaymentMethod, LastUpdatedAfter, LastUpdatedBefore, and BuyerEmail cannot be specified.

MaxResultsPerPage
integer <int32>

A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100.

EasyShipShipmentStatuses
Array of strings

A list of EasyShipShipmentStatus values. Used to select Easy Ship orders with statuses that match the specified values. If EasyShipShipmentStatus is specified, only Amazon Easy Ship orders are returned.

Possible values:

  • PendingSchedule (The package is awaiting the schedule for pick-up.)
  • PendingPickUp (Amazon has not yet picked up the package from the seller.)
  • PendingDropOff (The seller will deliver the package to the carrier.)
  • LabelCanceled (The seller canceled the pickup.)
  • PickedUp (Amazon has picked up the package from the seller.)
  • DroppedOff (The package is delivered to the carrier by the seller.)
  • AtOriginFC (The packaged is at the origin fulfillment center.)
  • AtDestinationFC (The package is at the destination fulfillment center.)
  • Delivered (The package has been delivered.)
  • RejectedByBuyer (The package has been rejected by the buyer.)
  • Undeliverable (The package cannot be delivered.)
  • ReturningToSeller (The package was not delivered and is being returned to the seller.)
  • ReturnedToSeller (The package was not delivered and was returned to the seller.)
  • Lost (The package is lost.)
  • OutForDelivery (The package is out for delivery.)
  • Damaged (The package was damaged by the carrier.)
ElectronicInvoiceStatuses
Array of strings

A list of ElectronicInvoiceStatus values. Used to select orders with electronic invoice statuses that match the specified values.

Possible values:

  • NotRequired (Electronic invoice submission is not required for this order.)
  • NotFound (The electronic invoice was not submitted for this order.)
  • Processing (The electronic invoice is being processed for this order.)
  • Errored (The last submitted electronic invoice was rejected for this order.)
  • Accepted (The last submitted electronic invoice was submitted and accepted.)
NextToken
string

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

AmazonOrderIds
Array of strings <= 50 items

A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format.

ActualFulfillmentSupplySourceId
string

Denotes the recommended sourceId where the order should be fulfilled from.

IsISPU
boolean

When true, this order is marked to be picked up from a store rather than delivered.

StoreChainStoreId
string

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

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "errors": [
    ]
}

getOrder

Returns the order that you specify.

Usage Plan:

Rate (requests per second) Burst
0.0167 20

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

path Parameters
orderId
required
string

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

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "errors": [
    ]
}

getOrderBuyerInfo

Returns buyer information for the order that you specify.

Usage Plan:

Rate (requests per second) Burst
0.0167 20

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

path Parameters
orderId
required
string

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

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

getOrderAddress

Returns the shipping address for the order that you specify.

Usage Plan:

Rate (requests per second) Burst
0.0167 20

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

path Parameters
orderId
required
string

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

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

path Parameters
orderId
required
string

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

query Parameters
NextToken
string

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

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

getOrderItemsBuyerInfo

Returns buyer information for the order items in the order that you specify.

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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

path Parameters
orderId
required
string

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

query Parameters
NextToken
string

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

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "errors": [
    ]
}

getOrderRegulatedInfo

Returns regulated information for the order that you specify.

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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

path Parameters
orderId
required
string

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

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "errors": [
    ]
}

updateVerificationStatus

Updates (approves or rejects) the verification status of an order containing regulated products.

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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

path Parameters
orderId
required
string

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

Request Body schema: application/json

The request body for the updateVerificationStatus operation.

required
object (UpdateVerificationStatusRequestBody)

The updated values of the VerificationStatus field.

Responses

Request samples

Content type
application/json
{
  • "regulatedOrderVerificationStatus": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

shipment

updateShipmentStatus

Update the shipment status for an order that you specify.

Usage Plan:

Rate (requests per second) Burst
5 15

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

path Parameters
orderId
required
string

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

Request Body schema: application/json

The request body for the updateShipmentStatus operation.

marketplaceId
required
string

The unobfuscated marketplace identifier.

shipmentStatus
required
string (ShipmentStatus)
Enum: "ReadyForPickup" "PickedUp" "RefusedPickup"

The shipment status to apply.

Array of objects (OrderItem2)

For partial shipment status updates, the list of order items and quantities to be updated.

Responses

Request samples

Content type
application/json
{
  • "marketplaceId": "string",
  • "shipmentStatus": "ReadyForPickup",
  • "orderItems": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}