HomeDocumentationCode SamplesAPI ReferenceAnnouncementsModelsRelease NotesFAQGitHubVideos
Developer HubAPI StatusSupport
API Reference
Developer HubAPI StatusSupport
Start typing to search…

getOrders

get https://sellingpartnerapi-na.amazon.com/orders/v0/orders

Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. NextToken doesn't affect any filters that you include in your request; it only impacts the pagination for the filtered orders response.

Usage Plan:

Rate (requests per second)Burst
0.016720

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that are 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 in the Selling Partner API documentation.

Query Params
string

Use this date to select orders created after (or at) a specified time. Only orders placed after the specified time are returned. The date must be in ISO 8601 format.

Note: Either the CreatedAfter parameter or the LastUpdatedAfter parameter is required. Both cannot be empty. LastUpdatedAfter and LastUpdatedBefore cannot be set when CreatedAfter is set.

string

Use this date to select 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.

Note: CreatedBefore is optional when CreatedAfter is set. If specified, CreatedBefore must be equal to or after the CreatedAfter date and at least two minutes before current time.

string

Use this date to select 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.

Note: Either the CreatedAfter parameter or the LastUpdatedAfter parameter is required. Both cannot be empty. CreatedAfter or CreatedBefore cannot be set when LastUpdatedAfter is set.

string

Use this date to select 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.

Note: LastUpdatedBefore is optional when LastUpdatedAfter is set. But if specified, LastUpdatedBefore must be equal to or after the LastUpdatedAfter date and at least two minutes before current time.

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.)
OrderStatuses
MarketplaceIds
array of strings
required
length ≤ 50

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

Refer to Marketplace IDs for a complete list of marketplaceId values.

MarketplaceIds*
FulfillmentChannels
array of strings

A list that indicates how an order was fulfilled. Filters the results by fulfillment channel.

Possible values: AFN (fulfilled by Amazon), MFN (fulfilled by seller).

FulfillmentChannels
PaymentMethods
array of strings

A list of payment method values. Use this field to select orders that were paid with the specified payment methods.

Possible values: COD (cash on delivery), CVS (convenience store), Other (Any payment method other than COD or CVS).

PaymentMethods
string

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

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.

integer

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.)
EasyShipShipmentStatuses
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.)
ElectronicInvoiceStatuses
string

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

AmazonOrderIds
array of strings
length ≤ 50

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

AmazonOrderIds
string

The sourceId of the location from where you want the order fulfilled.

boolean

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

string

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

string

Use this date to select orders with a earliest delivery date before (or at) a specified time. The date must be in ISO 8601 format.

string

Use this date to select orders with a earliest delivery date after (or at) a specified time. The date must be in ISO 8601 format.

string

Use this date to select orders with a latest delivery date before (or at) a specified time. The date must be in ISO 8601 format.

string

Use this date to select orders with a latest delivery date after (or at) a specified time. The date must be in ISO 8601 format.

Responses

Response body
object
payload
object

A list of orders along with additional information to make subsequent API calls.

Orders
array of objects
required

A list of orders.

Orders*
object
string
required

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

string

A seller-defined order identifier.

string
required

The date when the order was created.

string
required

The date when the order was last updated.

Note: LastUpdateDate is returned with an incorrect date for orders that were last updated before 2009-04-01.

string
required

The current order status.

Pending Unshipped PartiallyShipped Shipped Canceled Unfulfillable InvoiceUnconfirmed PendingAvailability

Show Details
PendingThe order has been placed but payment has not been authorized. The order is not ready for shipment. Note that for orders with `OrderType = Standard`, the initial order status is Pending. For orders with `OrderType = Preorder`, the initial order status is `PendingAvailability`, and the order passes into the Pending status when the payment authorization process begins.
UnshippedPayment has been authorized and order is ready for shipment, but no items in the order have been shipped.
PartiallyShippedOne or more (but not all) items in the order have been shipped.
ShippedAll items in the order have been shipped.
CanceledThe order was canceled.
UnfulfillableThe order cannot be fulfilled. This state applies only to Amazon-fulfilled orders that were not placed on Amazon's retail web site.
InvoiceUnconfirmedAll 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.
PendingAvailabilityThis status is available for pre-orders only. The order has been placed, payment has not been authorized, and the release date for the item is in the future. The order is not ready for shipment.
string

Whether the order was fulfilled by Amazon (AFN) or by the seller (MFN).

MFN AFN

Show Details
MFNFulfilled by the seller.
AFNFulfilled by Amazon.
string

The sales channel for the first item in the order.

string

The order channel for the first item in the order.

string

The order's shipment service level.

OrderTotal
object

The monetary value of the order.

integer

The number of items shipped.

integer

The number of items unshipped.

PaymentExecutionDetail
array of objects

A list of payment execution detail items.

PaymentExecutionDetail
object
Payment
object
required

The monetary value of the order.

string
required

A sub-payment method for a COD order.

Possible values:

  • COD: Cash on delivery
  • GC: Gift card
  • PointsAccount: Amazon Points
  • Invoice: Invoice
string

The payment method for the order. This property is limited to COD and CVS payment methods. Unless you need the specific COD payment information provided by the PaymentExecutionDetailItem object, we recommend using the PaymentMethodDetails property to get payment method information.

COD CVS Other

Show Details
CODCash on delivery.
CVSConvenience store.
OtherA payment method other than COD and CVS.
PaymentMethodDetails
array of strings

A list of payment method detail items.

PaymentMethodDetails
string

The identifier for the marketplace where the order was placed.

string

The shipment service level category for the order.

Possible values: Expedited, FreeEconomy, NextDay, Priority, SameDay, SecondDay, Scheduled, and Standard.

string

The status of the Amazon Easy Ship order. This property is only included for Amazon Easy Ship orders.

PendingSchedule PendingPickUp PendingDropOff LabelCanceled PickedUp DroppedOff AtOriginFC AtDestinationFC Delivered RejectedByBuyer Undeliverable ReturningToSeller ReturnedToSeller Lost OutForDelivery Damaged

Show Details
PendingScheduleThe package is awaiting the schedule for pick-up.
PendingPickUpAmazon has not yet picked up the package from the seller.
PendingDropOffThe seller will deliver the package to the carrier.
LabelCanceledThe seller canceled the pickup.
PickedUpAmazon has picked up the package from the seller.
DroppedOffThe package was delivered to the carrier by the seller.
AtOriginFCThe package is at the origin fulfillment center.
AtDestinationFCThe package is at the destination fulfillment center.
DeliveredThe package has been delivered.
RejectedByBuyerThe package has been rejected by the buyer.
UndeliverableThe package cannot be delivered.
ReturningToSellerThe package was not delivered and is being returned to the seller.
ReturnedToSellerThe package was not delivered and was returned to the seller.
LostThe package is lost.
OutForDeliveryThe package is out for delivery.
DamagedThe package was damaged by the carrier.
string

Custom ship label for Checkout by Amazon (CBA).

string

The order's type.

StandardOrder LongLeadTimeOrder Preorder BackOrder SourcingOnDemandOrder

Show Details
StandardOrderAn order that contains items for which the selling partner currently has inventory in stock.
LongLeadTimeOrderAn order that contains items that have a long lead time to ship.
PreorderAn order that contains items with a release date that is in the future.
BackOrderAn order that contains items that already have been released in the market but are currently out of stock and will be available in the future.
SourcingOnDemandOrderA Sourcing On Demand order.
string

The start of the time period within which you have committed to ship the order. In ISO 8601 date time format. Only returned for seller-fulfilled orders.

Note: EarliestShipDate might not be returned for orders placed before February 1, 2013.

string

The end of the time period within which you have committed to ship the order. In ISO 8601 date time format. Only returned for seller-fulfilled orders.

Note: LatestShipDate might not be returned for orders placed before February 1, 2013.

string

The start of the time period within which you have committed to fulfill the order. In ISO 8601 date time format. Only returned for seller-fulfilled orders.

string

The end of the time period within which you have committed to fulfill the order. In ISO 8601 date time format. Only returned for seller-fulfilled orders that do not have a PendingAvailability, Pending, or Canceled status.

boolean

When true, the order is an Amazon Business order. An Amazon Business order is an order where the buyer is a Verified Business Buyer.

boolean

When true, the order is a seller-fulfilled Amazon Prime order.

boolean

When true, the order has a Premium Shipping Service Level Agreement. For more information about Premium Shipping orders, refer to "Premium Shipping Options" in the Seller Central Help for your marketplace.

boolean

When true, the order is a GlobalExpress order.

string

The order ID value for the order that is being replaced. Returned only if IsReplacementOrder = true.

boolean

When true, this is a replacement order.

string

Indicates the date by which the seller must respond to the buyer with an estimated ship date. Only returned for Sourcing on Demand orders.

boolean

When true, the estimated ship date is set for the order. Only returned for Sourcing on Demand orders.

boolean

When true, the item within this order was bought and re-sold by Amazon Business EU SARL (ABEU). By buying and instantly re-selling your items, ABEU becomes the seller of record, making your inventory available for sale to customers who would not otherwise purchase from a third-party seller.

boolean

When true, the item within this order was bought and re-sold by Amazon Business EU SARL (ABEU). By buying and instantly re-selling your items, ABEU becomes the seller of record, making your inventory available for sale to customers who would not otherwise purchase from a third-party seller.

DefaultShipFromLocationAddress
object

The shipping address for the order.

string

The buyer's invoicing preference. Sellers can use this data to issue electronic invoices for orders in Turkey.

Note: This attribute is only available in the Turkey marketplace.

INDIVIDUAL BUSINESS

Show Details
INDIVIDUALIssues an individual invoice to the buyer.
BUSINESSIssues a business invoice to the buyer. Tax information is available in `BuyerTaxInformation`.
BuyerTaxInformation
object

Contains the business invoice tax information. Available only in the TR marketplace.

FulfillmentInstruction
object

Contains the instructions about the fulfillment, such as the location from where you want the order filled.

boolean

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

boolean

When true, this order is marked to be delivered to an Access Point. The access location is chosen by the customer. Access Points include Amazon Hub Lockers, Amazon Hub Counters, and pickup points operated by carriers.

MarketplaceTaxInfo
object

Tax information about the marketplace.

string

The seller’s friendly name registered in the marketplace where the sale took place. Sellers can use this data to issue electronic invoices for orders in Brazil.

Note: This attribute is only available in the Brazil marketplace for the orders with Pending or Unshipped status.

ShippingAddress
object

The shipping address for the order.

BuyerInfo
object

Buyer information.

AutomatedShippingSettings
object

Contains information regarding the Shipping Settings Automation program, such as whether the order's shipping settings were generated automatically, and what those settings are.

boolean

Whether the order contains regulated items which may require additional approval steps before being fulfilled.

string

The status of the electronic invoice. Only available for Easy Ship orders and orders in the BR marketplace.

NotRequired NotFound Processing Errored Accepted

Show Details
NotRequiredThe order does not require an electronic invoice to be uploaded.
NotFoundThe order requires an electronic invoice but it is not uploaded.
ProcessingThe required electronic invoice was uploaded and is processing.
ErroredThe uploaded electronic invoice was not accepted.
AcceptedThe uploaded electronic invoice was accepted.
string

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

string

Use this date to select 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. All dates must be in ISO 8601 format.

string

Use this date to select 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.

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.

Updated 3 months ago

Did this page help you?
Language

Updated 3 months ago

Did this page help you?