getOrder

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

Returns 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 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

Response body

object

payload

object

Order information.

AmazonOrderId

string

required

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

SellerOrderId

string

A seller-defined order identifier.

PurchaseDate

string

required

The date when the order was created.

LastUpdateDate

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.

OrderStatus

string

required

The current order status.

Pending Unshipped PartiallyShipped Shipped Canceled Unfulfillable InvoiceUnconfirmed PendingAvailability

Show Details

Pending	The 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.
Unshipped	Payment has been authorized and 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.
Canceled	The order was canceled.
Unfulfillable	The order cannot be fulfilled. This state applies only to Amazon-fulfilled orders that were not placed on Amazon's retail web site.
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.
PendingAvailability	This 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.

FulfillmentChannel

string

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

MFN AFN

Show Details

MFN	Fulfilled by the seller.
AFN	Fulfilled by Amazon.

SalesChannel

string

The sales channel for the first item in the order.

OrderChannel

string

The order channel for the first item in the order.

ShipServiceLevel

string

The order's shipment service level.

OrderTotal

object

The monetary value of the order.

NumberOfItemsShipped

integer

The number of items shipped.

NumberOfItemsUnshipped

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.

PaymentMethod

string

required

A sub-payment method for a COD order.

Possible values:

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

PaymentMethod

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

COD	Cash on delivery.
CVS	Convenience store.
Other	A payment method other than COD and CVS.

PaymentMethodDetails

array of strings

A list of payment method detail items.

PaymentMethodDetails

MarketplaceId

string

The identifier for the marketplace where the order was placed.

ShipmentServiceLevelCategory

string

The shipment service level category for the order.

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

EasyShipShipmentStatus

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

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 was delivered to the carrier by the seller.
AtOriginFC	The package 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.

CbaDisplayableShippingLabel

string

Custom ship label for Checkout by Amazon (CBA).

OrderType

string

The order's type.

StandardOrder LongLeadTimeOrder Preorder BackOrder SourcingOnDemandOrder

Show Details

StandardOrder	An order that contains items for which the selling partner currently has inventory in stock.
LongLeadTimeOrder	An order that contains items that have a long lead time to ship.
Preorder	An order that contains items with a release date that is in the future.
BackOrder	An 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.
SourcingOnDemandOrder	A Sourcing On Demand order.

EarliestShipDate

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.

LatestShipDate

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.

EarliestDeliveryDate

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.

LatestDeliveryDate

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.

IsBusinessOrder

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.

IsPrime

boolean

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

IsPremiumOrder

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.

IsGlobalExpressEnabled

boolean

When true, the order is a GlobalExpress order.

ReplacedOrderId

string

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

IsReplacementOrder

boolean

When true, this is a replacement order.

PromiseResponseDueDate

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.

IsEstimatedShipDateSet

boolean

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

IsSoldByAB

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.

IsIBA

boolean

DefaultShipFromLocationAddress

object

The shipping address for the order.

BuyerInvoicePreference

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

INDIVIDUAL	Issues an individual invoice to the buyer.
BUSINESS	Issues 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.

IsISPU

boolean

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

IsAccessPointOrder

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.

SellerDisplayName

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.

HasRegulatedItems

boolean

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

ElectronicInvoiceStatus

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

NotRequired	The order does not require an electronic invoice to be uploaded.
NotFound	The order requires an electronic invoice but it is not uploaded.
Processing	The required electronic invoice was uploaded and is processing.
Errored	The uploaded electronic invoice was not accepted.
Accepted	The uploaded electronic invoice was accepted.

errors

array of objects

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

errors

object

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

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

Headers

object

x-amzn-RateLimit-Limit

string

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

x-amzn-RequestId

string

Unique request reference identifier.

Response body

object

payload

object

Order information.

AmazonOrderId

string

required

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

SellerOrderId

string

A seller-defined order identifier.

PurchaseDate

string

required

The date when the order was created.

LastUpdateDate

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.

OrderStatus

string

required

The current order status.

Pending Unshipped PartiallyShipped Shipped Canceled Unfulfillable InvoiceUnconfirmed PendingAvailability

Show Details

Pending	The 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.
Unshipped	Payment has been authorized and 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.
Canceled	The order was canceled.
Unfulfillable	The order cannot be fulfilled. This state applies only to Amazon-fulfilled orders that were not placed on Amazon's retail web site.
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.
PendingAvailability	This 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.

FulfillmentChannel

string

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

MFN AFN

Show Details

MFN	Fulfilled by the seller.
AFN	Fulfilled by Amazon.

SalesChannel

string

The sales channel for the first item in the order.

OrderChannel

string

The order channel for the first item in the order.

ShipServiceLevel

string

The order's shipment service level.

OrderTotal

object

The monetary value of the order.

NumberOfItemsShipped

integer

The number of items shipped.

NumberOfItemsUnshipped

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.

PaymentMethod

string

required

A sub-payment method for a COD order.

Possible values:

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

PaymentMethod

string

COD CVS Other

Show Details

COD	Cash on delivery.
CVS	Convenience store.
Other	A payment method other than COD and CVS.

PaymentMethodDetails

array of strings

A list of payment method detail items.

PaymentMethodDetails

MarketplaceId

string

The identifier for the marketplace where the order was placed.

ShipmentServiceLevelCategory

string

The shipment service level category for the order.

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

EasyShipShipmentStatus

string

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

Show Details

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 was delivered to the carrier by the seller.
AtOriginFC	The package 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.

CbaDisplayableShippingLabel

string

Custom ship label for Checkout by Amazon (CBA).

OrderType

string

The order's type.

StandardOrder LongLeadTimeOrder Preorder BackOrder SourcingOnDemandOrder

Show Details

StandardOrder	An order that contains items for which the selling partner currently has inventory in stock.
LongLeadTimeOrder	An order that contains items that have a long lead time to ship.
Preorder	An order that contains items with a release date that is in the future.
BackOrder	An 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.
SourcingOnDemandOrder	A Sourcing On Demand order.

EarliestShipDate

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.

LatestShipDate

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.

EarliestDeliveryDate

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.

LatestDeliveryDate

string

IsBusinessOrder

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.

IsPrime

boolean

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

IsPremiumOrder

boolean

IsGlobalExpressEnabled

boolean

When true, the order is a GlobalExpress order.

ReplacedOrderId

string

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

IsReplacementOrder

boolean

When true, this is a replacement order.

PromiseResponseDueDate

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.

IsEstimatedShipDateSet

boolean

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

IsSoldByAB

boolean

IsIBA

boolean

DefaultShipFromLocationAddress

object

The shipping address for the order.

BuyerInvoicePreference

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

INDIVIDUAL	Issues an individual invoice to the buyer.
BUSINESS	Issues 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.

IsISPU

boolean

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

IsAccessPointOrder

boolean

MarketplaceTaxInfo

object

Tax information about the marketplace.

SellerDisplayName

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.

HasRegulatedItems

boolean

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

ElectronicInvoiceStatus

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

NotRequired	The order does not require an electronic invoice to be uploaded.
NotFound	The order requires an electronic invoice but it is not uploaded.
Processing	The required electronic invoice was uploaded and is processing.
Errored	The uploaded electronic invoice was not accepted.
Accepted	The uploaded electronic invoice was accepted.

errors

array of objects

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

errors

object

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

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

Headers

object

x-amzn-RateLimit-Limit

string

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

x-amzn-RequestId

string

Unique request reference identifier.

Response body

object

payload

object

Order information.

AmazonOrderId

string

required

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

SellerOrderId

string

A seller-defined order identifier.

PurchaseDate

string

required

The date when the order was created.

LastUpdateDate

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.

OrderStatus

string

required

The current order status.

Pending Unshipped PartiallyShipped Shipped Canceled Unfulfillable InvoiceUnconfirmed PendingAvailability

Show Details

Pending	The 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.
Unshipped	Payment has been authorized and 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.
Canceled	The order was canceled.
Unfulfillable	The order cannot be fulfilled. This state applies only to Amazon-fulfilled orders that were not placed on Amazon's retail web site.
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.
PendingAvailability	This 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.

FulfillmentChannel

string

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

MFN AFN

Show Details

MFN	Fulfilled by the seller.
AFN	Fulfilled by Amazon.

SalesChannel

string

The sales channel for the first item in the order.

OrderChannel

string

The order channel for the first item in the order.

ShipServiceLevel

string

The order's shipment service level.

OrderTotal

object

The monetary value of the order.

NumberOfItemsShipped

integer

The number of items shipped.

NumberOfItemsUnshipped

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.

PaymentMethod

string

required

A sub-payment method for a COD order.

Possible values:

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

PaymentMethod

string

COD CVS Other

Show Details

COD	Cash on delivery.
CVS	Convenience store.
Other	A payment method other than COD and CVS.

PaymentMethodDetails

array of strings

A list of payment method detail items.

PaymentMethodDetails

MarketplaceId

string

The identifier for the marketplace where the order was placed.

ShipmentServiceLevelCategory

string

The shipment service level category for the order.

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

EasyShipShipmentStatus

string

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

Show Details

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 was delivered to the carrier by the seller.
AtOriginFC	The package 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.

CbaDisplayableShippingLabel

string

Custom ship label for Checkout by Amazon (CBA).

OrderType

string

The order's type.

StandardOrder LongLeadTimeOrder Preorder BackOrder SourcingOnDemandOrder

Show Details

StandardOrder	An order that contains items for which the selling partner currently has inventory in stock.
LongLeadTimeOrder	An order that contains items that have a long lead time to ship.
Preorder	An order that contains items with a release date that is in the future.
BackOrder	An 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.
SourcingOnDemandOrder	A Sourcing On Demand order.

EarliestShipDate

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.

LatestShipDate

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.

EarliestDeliveryDate

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.

LatestDeliveryDate

string

IsBusinessOrder

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.

IsPrime

boolean

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

IsPremiumOrder

boolean

IsGlobalExpressEnabled

boolean

When true, the order is a GlobalExpress order.

ReplacedOrderId

string

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

IsReplacementOrder

boolean

When true, this is a replacement order.

PromiseResponseDueDate

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.

IsEstimatedShipDateSet

boolean

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

IsSoldByAB

boolean

IsIBA

boolean

DefaultShipFromLocationAddress

object

The shipping address for the order.

BuyerInvoicePreference

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

INDIVIDUAL	Issues an individual invoice to the buyer.
BUSINESS	Issues 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.

IsISPU

boolean

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

IsAccessPointOrder

boolean

MarketplaceTaxInfo

object

Tax information about the marketplace.

SellerDisplayName

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.

HasRegulatedItems

boolean

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

ElectronicInvoiceStatus

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

NotRequired	The order does not require an electronic invoice to be uploaded.
NotFound	The order requires an electronic invoice but it is not uploaded.
Processing	The required electronic invoice was uploaded and is processing.
Errored	The uploaded electronic invoice was not accepted.
Accepted	The uploaded electronic invoice was accepted.

errors

array of objects

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

errors

object

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

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

Headers

object

x-amzn-RequestId

string

Unique request reference identifier.

Response body

object

payload

object

Order information.

AmazonOrderId

string

required

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

SellerOrderId

string

A seller-defined order identifier.

PurchaseDate

string

required

The date when the order was created.

LastUpdateDate

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.

OrderStatus

string

required

The current order status.

Pending Unshipped PartiallyShipped Shipped Canceled Unfulfillable InvoiceUnconfirmed PendingAvailability

Show Details

Pending	The 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.
Unshipped	Payment has been authorized and 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.
Canceled	The order was canceled.
Unfulfillable	The order cannot be fulfilled. This state applies only to Amazon-fulfilled orders that were not placed on Amazon's retail web site.
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.
PendingAvailability	This 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.

FulfillmentChannel

string

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

MFN AFN

Show Details

MFN	Fulfilled by the seller.
AFN	Fulfilled by Amazon.

SalesChannel

string

The sales channel for the first item in the order.

OrderChannel

string

The order channel for the first item in the order.

ShipServiceLevel

string

The order's shipment service level.

OrderTotal

object

The monetary value of the order.

NumberOfItemsShipped

integer

The number of items shipped.

NumberOfItemsUnshipped

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.

PaymentMethod

string

required

A sub-payment method for a COD order.

Possible values:

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

PaymentMethod

string

COD CVS Other

Show Details

COD	Cash on delivery.
CVS	Convenience store.
Other	A payment method other than COD and CVS.

PaymentMethodDetails

array of strings

A list of payment method detail items.

PaymentMethodDetails

MarketplaceId

string

The identifier for the marketplace where the order was placed.

ShipmentServiceLevelCategory

string

The shipment service level category for the order.

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

EasyShipShipmentStatus

string

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

Show Details

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 was delivered to the carrier by the seller.
AtOriginFC	The package 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.

CbaDisplayableShippingLabel

string

Custom ship label for Checkout by Amazon (CBA).

OrderType

string

The order's type.

StandardOrder LongLeadTimeOrder Preorder BackOrder SourcingOnDemandOrder

Show Details

StandardOrder	An order that contains items for which the selling partner currently has inventory in stock.
LongLeadTimeOrder	An order that contains items that have a long lead time to ship.
Preorder	An order that contains items with a release date that is in the future.
BackOrder	An 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.
SourcingOnDemandOrder	A Sourcing On Demand order.

EarliestShipDate

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.

LatestShipDate

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.

EarliestDeliveryDate

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.

LatestDeliveryDate

string

IsBusinessOrder

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.

IsPrime

boolean

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

IsPremiumOrder

boolean

IsGlobalExpressEnabled

boolean

When true, the order is a GlobalExpress order.

ReplacedOrderId

string

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

IsReplacementOrder

boolean

When true, this is a replacement order.

PromiseResponseDueDate

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.

IsEstimatedShipDateSet

boolean

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

IsSoldByAB

boolean

IsIBA

boolean

DefaultShipFromLocationAddress

object

The shipping address for the order.

BuyerInvoicePreference

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

INDIVIDUAL	Issues an individual invoice to the buyer.
BUSINESS	Issues 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.

IsISPU

boolean

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

IsAccessPointOrder

boolean

MarketplaceTaxInfo

object

Tax information about the marketplace.

SellerDisplayName

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.

HasRegulatedItems

boolean

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

ElectronicInvoiceStatus

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

NotRequired	The order does not require an electronic invoice to be uploaded.
NotFound	The order requires an electronic invoice but it is not uploaded.
Processing	The required electronic invoice was uploaded and is processing.
Errored	The uploaded electronic invoice was not accepted.
Accepted	The uploaded electronic invoice was accepted.

errors

array of objects

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

errors

object

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

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

Headers

object

x-amzn-RateLimit-Limit

string

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

x-amzn-RequestId

string

Unique request reference identifier.

Response body

object

payload

object

Order information.

AmazonOrderId

string

required

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

SellerOrderId

string

A seller-defined order identifier.

PurchaseDate

string

required

The date when the order was created.

LastUpdateDate

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.

OrderStatus

string

required

The current order status.

Pending Unshipped PartiallyShipped Shipped Canceled Unfulfillable InvoiceUnconfirmed PendingAvailability

Show Details

Pending	The 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.
Unshipped	Payment has been authorized and 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.
Canceled	The order was canceled.
Unfulfillable	The order cannot be fulfilled. This state applies only to Amazon-fulfilled orders that were not placed on Amazon's retail web site.
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.
PendingAvailability	This 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.

FulfillmentChannel

string

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

MFN AFN

Show Details

MFN	Fulfilled by the seller.
AFN	Fulfilled by Amazon.

SalesChannel

string

The sales channel for the first item in the order.

OrderChannel

string

The order channel for the first item in the order.

ShipServiceLevel

string

The order's shipment service level.

OrderTotal

object

The monetary value of the order.

NumberOfItemsShipped

integer

The number of items shipped.

NumberOfItemsUnshipped

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.

PaymentMethod

string

required

A sub-payment method for a COD order.

Possible values:

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

PaymentMethod

string

COD CVS Other

Show Details

COD	Cash on delivery.
CVS	Convenience store.
Other	A payment method other than COD and CVS.

PaymentMethodDetails

array of strings

A list of payment method detail items.

PaymentMethodDetails

MarketplaceId

string

The identifier for the marketplace where the order was placed.

ShipmentServiceLevelCategory

string

The shipment service level category for the order.

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

EasyShipShipmentStatus

string

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

Show Details

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 was delivered to the carrier by the seller.
AtOriginFC	The package 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.

CbaDisplayableShippingLabel

string

Custom ship label for Checkout by Amazon (CBA).

OrderType

string

The order's type.

StandardOrder LongLeadTimeOrder Preorder BackOrder SourcingOnDemandOrder

Show Details

StandardOrder	An order that contains items for which the selling partner currently has inventory in stock.
LongLeadTimeOrder	An order that contains items that have a long lead time to ship.
Preorder	An order that contains items with a release date that is in the future.
BackOrder	An 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.
SourcingOnDemandOrder	A Sourcing On Demand order.

EarliestShipDate

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.

LatestShipDate

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.

EarliestDeliveryDate

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.

LatestDeliveryDate

string

IsBusinessOrder

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.

IsPrime

boolean

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

IsPremiumOrder

boolean

IsGlobalExpressEnabled

boolean

When true, the order is a GlobalExpress order.

ReplacedOrderId

string

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

IsReplacementOrder

boolean

When true, this is a replacement order.

PromiseResponseDueDate

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.

IsEstimatedShipDateSet

boolean

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

IsSoldByAB

boolean

IsIBA

boolean

DefaultShipFromLocationAddress

object

The shipping address for the order.

BuyerInvoicePreference

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

INDIVIDUAL	Issues an individual invoice to the buyer.
BUSINESS	Issues 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.

IsISPU

boolean

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

IsAccessPointOrder

boolean

MarketplaceTaxInfo

object

Tax information about the marketplace.

SellerDisplayName

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.

HasRegulatedItems

boolean

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

ElectronicInvoiceStatus

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

NotRequired	The order does not require an electronic invoice to be uploaded.
NotFound	The order requires an electronic invoice but it is not uploaded.
Processing	The required electronic invoice was uploaded and is processing.
Errored	The uploaded electronic invoice was not accepted.
Accepted	The uploaded electronic invoice was accepted.

errors

array of objects

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

errors

object

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

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

Headers

object

x-amzn-RequestId

string

Unique request reference identifier.

Response body

object

payload

object

Order information.

AmazonOrderId

string

required

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

SellerOrderId

string

A seller-defined order identifier.

PurchaseDate

string

required

The date when the order was created.

LastUpdateDate

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.

OrderStatus

string

required

The current order status.

Pending Unshipped PartiallyShipped Shipped Canceled Unfulfillable InvoiceUnconfirmed PendingAvailability

Show Details

Pending	The 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.
Unshipped	Payment has been authorized and 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.
Canceled	The order was canceled.
Unfulfillable	The order cannot be fulfilled. This state applies only to Amazon-fulfilled orders that were not placed on Amazon's retail web site.
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.
PendingAvailability	This 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.

FulfillmentChannel

string

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

MFN AFN

Show Details

MFN	Fulfilled by the seller.
AFN	Fulfilled by Amazon.

SalesChannel

string

The sales channel for the first item in the order.

OrderChannel

string

The order channel for the first item in the order.

ShipServiceLevel

string

The order's shipment service level.

OrderTotal

object

The monetary value of the order.

NumberOfItemsShipped

integer

The number of items shipped.

NumberOfItemsUnshipped

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.

PaymentMethod

string

required

A sub-payment method for a COD order.

Possible values:

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

PaymentMethod

string

COD CVS Other

Show Details

COD	Cash on delivery.
CVS	Convenience store.
Other	A payment method other than COD and CVS.

PaymentMethodDetails

array of strings

A list of payment method detail items.

PaymentMethodDetails

MarketplaceId

string

The identifier for the marketplace where the order was placed.

ShipmentServiceLevelCategory

string

The shipment service level category for the order.

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

EasyShipShipmentStatus

string

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

Show Details

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 was delivered to the carrier by the seller.
AtOriginFC	The package 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.

CbaDisplayableShippingLabel

string

Custom ship label for Checkout by Amazon (CBA).

OrderType

string

The order's type.

StandardOrder LongLeadTimeOrder Preorder BackOrder SourcingOnDemandOrder

Show Details

StandardOrder	An order that contains items for which the selling partner currently has inventory in stock.
LongLeadTimeOrder	An order that contains items that have a long lead time to ship.
Preorder	An order that contains items with a release date that is in the future.
BackOrder	An 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.
SourcingOnDemandOrder	A Sourcing On Demand order.

EarliestShipDate

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.

LatestShipDate

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.

EarliestDeliveryDate

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.

LatestDeliveryDate

string

IsBusinessOrder

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.

IsPrime

boolean

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

IsPremiumOrder

boolean

IsGlobalExpressEnabled

boolean

When true, the order is a GlobalExpress order.

ReplacedOrderId

string

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

IsReplacementOrder

boolean

When true, this is a replacement order.

PromiseResponseDueDate

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.

IsEstimatedShipDateSet

boolean

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

IsSoldByAB

boolean

IsIBA

boolean

DefaultShipFromLocationAddress

object

The shipping address for the order.

BuyerInvoicePreference

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

INDIVIDUAL	Issues an individual invoice to the buyer.
BUSINESS	Issues 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.

IsISPU

boolean

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

IsAccessPointOrder

boolean

MarketplaceTaxInfo

object

Tax information about the marketplace.

SellerDisplayName

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.

HasRegulatedItems

boolean

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

ElectronicInvoiceStatus

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

NotRequired	The order does not require an electronic invoice to be uploaded.
NotFound	The order requires an electronic invoice but it is not uploaded.
Processing	The required electronic invoice was uploaded and is processing.
Errored	The uploaded electronic invoice was not accepted.
Accepted	The uploaded electronic invoice was accepted.

errors

array of objects

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

errors

object

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

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

Headers

object

x-amzn-RequestId

string

Unique request reference identifier.

Response body

object

payload

object

Order information.

AmazonOrderId

string

required

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

SellerOrderId

string

A seller-defined order identifier.

PurchaseDate

string

required

The date when the order was created.

LastUpdateDate

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.

OrderStatus

string

required

The current order status.

Pending Unshipped PartiallyShipped Shipped Canceled Unfulfillable InvoiceUnconfirmed PendingAvailability

Show Details

Pending	The 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.
Unshipped	Payment has been authorized and 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.
Canceled	The order was canceled.
Unfulfillable	The order cannot be fulfilled. This state applies only to Amazon-fulfilled orders that were not placed on Amazon's retail web site.
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.
PendingAvailability	This 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.

FulfillmentChannel

string

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

MFN AFN

Show Details

MFN	Fulfilled by the seller.
AFN	Fulfilled by Amazon.

SalesChannel

string

The sales channel for the first item in the order.

OrderChannel

string

The order channel for the first item in the order.

ShipServiceLevel

string

The order's shipment service level.

OrderTotal

object

The monetary value of the order.

NumberOfItemsShipped

integer

The number of items shipped.

NumberOfItemsUnshipped

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.

PaymentMethod

string

required

A sub-payment method for a COD order.

Possible values:

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

PaymentMethod

string

COD CVS Other

Show Details

COD	Cash on delivery.
CVS	Convenience store.
Other	A payment method other than COD and CVS.

PaymentMethodDetails

array of strings

A list of payment method detail items.

PaymentMethodDetails

MarketplaceId

string

The identifier for the marketplace where the order was placed.

ShipmentServiceLevelCategory

string

The shipment service level category for the order.

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

EasyShipShipmentStatus

string

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

Show Details

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 was delivered to the carrier by the seller.
AtOriginFC	The package 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.

CbaDisplayableShippingLabel

string

Custom ship label for Checkout by Amazon (CBA).

OrderType

string

The order's type.

StandardOrder LongLeadTimeOrder Preorder BackOrder SourcingOnDemandOrder

Show Details

StandardOrder	An order that contains items for which the selling partner currently has inventory in stock.
LongLeadTimeOrder	An order that contains items that have a long lead time to ship.
Preorder	An order that contains items with a release date that is in the future.
BackOrder	An 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.
SourcingOnDemandOrder	A Sourcing On Demand order.

EarliestShipDate

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.

LatestShipDate

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.

EarliestDeliveryDate

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.

LatestDeliveryDate

string

IsBusinessOrder

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.

IsPrime

boolean

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

IsPremiumOrder

boolean

IsGlobalExpressEnabled

boolean

When true, the order is a GlobalExpress order.

ReplacedOrderId

string

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

IsReplacementOrder

boolean

When true, this is a replacement order.

PromiseResponseDueDate

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.

IsEstimatedShipDateSet

boolean

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

IsSoldByAB

boolean

IsIBA

boolean

DefaultShipFromLocationAddress

object

The shipping address for the order.

BuyerInvoicePreference

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

INDIVIDUAL	Issues an individual invoice to the buyer.
BUSINESS	Issues 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.

IsISPU

boolean

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

IsAccessPointOrder

boolean

MarketplaceTaxInfo

object

Tax information about the marketplace.

SellerDisplayName

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.

HasRegulatedItems

boolean

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

ElectronicInvoiceStatus

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

NotRequired	The order does not require an electronic invoice to be uploaded.
NotFound	The order requires an electronic invoice but it is not uploaded.
Processing	The required electronic invoice was uploaded and is processing.
Errored	The uploaded electronic invoice was not accepted.
Accepted	The uploaded electronic invoice was accepted.

errors

array of objects

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

errors

object

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

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

Headers

object

x-amzn-RequestId

string

Unique request reference identifier.

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://sellingpartnerapi-na.amazon.com/orders/v0/orders/orderId \
3
     --header 'accept: application/json'


xxxxxxxxxx
61
}
1
{
2
  "payload": {
3
    "AmazonOrderId": "902-3159896-1390916",
4
    "PurchaseDate": "2017-01-20T19:49:35Z",
5
    "LastUpdateDate": "2017-01-20T19:49:35Z",
6
    "OrderStatus": "Pending",
7
    "FulfillmentChannel": "SellerFulfilled",
8
    "NumberOfItemsShipped": 0,
9
    "NumberOfItemsUnshipped": 0,
10
    "PaymentMethod": "Other",
11
    "PaymentMethodDetails": [
12
      "CreditCard",
13
      "GiftCerificate"
14
    ],
15
    "MarketplaceId": "ATVPDKIKX0DER",
16
    "ShipmentServiceLevelCategory": "Standard",
17
    "OrderType": "StandardOrder",
18
    "EarliestShipDate": "2017-01-20T19:51:16Z",
19
    "LatestShipDate": "2017-01-25T19:49:35Z",
20
    "IsBusinessOrder": false,
21
    "IsPrime": false,
22
    "IsGlobalExpressEnabled": false,
23
    "IsPremiumOrder": false,
24
    "IsSoldByAB": false,
25
    "IsIBA": false,

200Success.

400Request has missing or invalid parameters and cannot be parsed.

403Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

404The resource specified does not exist.

429The frequency of requests was greater than allowed.

500An unexpected condition occurred that prevented the server from fulfilling the request.

503Temporary overloading or maintenance of the server.