HomeDocumentationCode SamplesAnnouncementsModelsRelease NotesFAQGitHubVideos
Developer HubAPI StatusSupport
Documentation
Developer HubAPI StatusSupport

Orders API v0 Reference

Programmatically retrieve order information.

Use the Orders Selling Partner API to programmatically retrieve order information. With this API, you can develop fast, flexible, and custom applications to manage order synchronization, perform order research, and create demand-based decision support tools.

Note: For the JP, AU, and SG marketplaces, the Orders API supports orders from 2016 onward. For all other marketplaces, the Orders API supports orders for the last two years (orders older than this don't show up in the response).

Version information

Version : v0

Contact information

Contact : Selling Partner API Developer Support
Contact URL : https://sellercentral.amazon.com/gp/mws/contactus.html

License information

License : Apache License 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0

URI scheme

Host : sellingpartnerapi-na.amazon.com
Schemes : HTTPS

Consumes

  • application/json

Produces

  • application/json

Operations

getOrders
getOrder
getOrderBuyerInfo
getOrderAddress
getOrderItems
getOrderItemsBuyerInfo
updateShipmentStatus
getOrderRegulatedInfo
updateVerificationStatus
confirmShipment

Paths

GET /orders/v0/orders

Operation: getOrders

Description

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.

Parameters

TypeNameDescriptionSchema
QueryCreatedAfter
optional
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
QueryCreatedBefore
optional
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
QueryLastUpdatedAfter
optional
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
QueryLastUpdatedBefore
optional
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.
string
QueryOrderStatuses
optional
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.)
< string > array
QueryMarketplaceIds
required
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.
Max count : 50
< string > array
QueryFulfillmentChannels
optional
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).
< string > array
QueryPaymentMethods
optional
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).
< string > array
QueryBuyerEmail
optional
The email address of a buyer. Used to select orders that contain the specified email address.string
QuerySellerOrderId
optional
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.string
QueryMaxResultsPerPage
optional
A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100.integer
QueryEasyShipShipmentStatuses
optional
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.)
< string > array
QueryElectronicInvoiceStatuses
optional
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.)
< string > array
QueryNextToken
optional
A string token returned in the response of your previous request.string
QueryAmazonOrderIds
optional
A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format.
Max count : 50
< string > array
QueryActualFulfillmentSupplySourceId
optional
The sourceId of the location from where you want the order fulfilled.string
QueryIsISPU
optional
When true, this order is marked to be picked up from a store rather than delivered.boolean
QueryStoreChainStoreId
optional
The store chain store identifier. Linked to a specific store in a store chain.string
QueryEarliestDeliveryDateBefore
optional
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
QueryEarliestDeliveryDateAfter
optional
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
QueryLatestDeliveryDateBefore
optional
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
QueryLatestDeliveryDateAfter
optional
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.string

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrdersResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrdersResponse
403Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrdersResponse
404The resource specified does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrdersResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrdersResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrdersResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrdersResponse

For additional error status codes, descriptions and schemas, see Error responses and schemas.

GET /orders/v0/orders/{orderId}

Operation: getOrder

Description

Returns the order that you specify.

Usage Plan:

Rate (requests per second)Burst
0.530

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

Parameters

TypeNameDescriptionSchema
PathorderId
required
An Amazon-defined order identifier, in 3-7-7 format.string

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderResponse
403Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderResponse
404The resource specified does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderResponse

For additional error status codes, descriptions and schemas, see Error responses and schemas.

GET /orders/v0/orders/{orderId}/buyerInfo

Operation: getOrderBuyerInfo

Description

Returns buyer information for the order that you specify.

Usage Plan:

Rate (requests per second)Burst
0.530

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

Parameters

TypeNameDescriptionSchema
PathorderId
required
An orderId is an Amazon-defined order identifier, in 3-7-7 format.string

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderBuyerInfoResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderBuyerInfoResponse
403Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderBuyerInfoResponse
404The resource specified does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderBuyerInfoResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderBuyerInfoResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderBuyerInfoResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderBuyerInfoResponse

For additional error status codes, descriptions and schemas, see Error responses and schemas.

GET /orders/v0/orders/{orderId}/address

Operation: getOrderAddress

Description

Returns the shipping address for the order that you specify.

Usage Plan:

Rate (requests per second)Burst
0.530

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

Parameters

TypeNameDescriptionSchema
PathorderId
required
An orderId is an Amazon-defined order identifier, in 3-7-7 format.string

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderAddressResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderAddressResponse
403Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderAddressResponse
404The resource specified does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderAddressResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderAddressResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderAddressResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderAddressResponse

For additional error status codes, descriptions and schemas, see Error responses and schemas.

GET /orders/v0/orders/{orderId}/orderItems

Operation: getOrderItems

Description

Returns detailed order item information for the order that you specify. If NextToken is provided, it's used to retrieve the next page of order items.

Note: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order.

Usage Plan:

Rate (requests per second)Burst
0.530

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

Parameters

TypeNameDescriptionSchema
PathorderId
required
An Amazon-defined order identifier, in 3-7-7 format.string
QueryNextToken
optional
A string token returned in the response of your previous request.string

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderItemsResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderItemsResponse
403Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderItemsResponse
404The resource specified does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderItemsResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderItemsResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderItemsResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderItemsResponse

For additional error status codes, descriptions and schemas, see Error responses and schemas.

GET /orders/v0/orders/{orderId}/orderItems/buyerInfo

Operation: getOrderItemsBuyerInfo

Description

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

Usage Plan:

Rate (requests per second)Burst
0.530

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

Parameters

TypeNameDescriptionSchema
PathorderId
required
An Amazon-defined order identifier, in 3-7-7 format.string
QueryNextToken
optional
A string token returned in the response of your previous request.string

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderItemsBuyerInfoResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderItemsBuyerInfoResponse
403Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderItemsBuyerInfoResponse
404The resource specified does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderItemsBuyerInfoResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderItemsBuyerInfoResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderItemsBuyerInfoResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderItemsBuyerInfoResponse

For additional error status codes, descriptions and schemas, see Error responses and schemas.

POST /orders/v0/orders/{orderId}/shipment

Operation: updateShipmentStatus

Description

Update the shipment status for an order that you specify.

Usage Plan:

Rate (requests per second)Burst
515

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.

Parameters

TypeNameDescriptionSchema
PathorderId
required
An Amazon-defined order identifier, in 3-7-7 format.string
Bodypayload
required
The request body for the updateShipmentStatus operation.UpdateShipmentStatusRequest

Responses

HTTP CodeDescriptionSchema
204Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
No Content
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateShipmentStatusErrorResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateShipmentStatusErrorResponse
404The resource specified does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateShipmentStatusErrorResponse
413The request size exceeded the maximum accepted size.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateShipmentStatusErrorResponse
415The request payload is in an unsupported format.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateShipmentStatusErrorResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateShipmentStatusErrorResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateShipmentStatusErrorResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateShipmentStatusErrorResponse

For additional error status codes, descriptions and schemas, see Error responses and schemas.

GET /orders/v0/orders/{orderId}/regulatedInfo

Operation: getOrderRegulatedInfo

Description

Returns regulated information for the order that you specify.

Usage Plan:

Rate (requests per second)Burst
0.530

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

Parameters

TypeNameDescriptionSchema
PathorderId
required
An Amazon-defined order identifier, in 3-7-7 format.string

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderRegulatedInfoResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderRegulatedInfoResponse
403Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderRegulatedInfoResponse
404The resource specified does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderRegulatedInfoResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderRegulatedInfoResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderRegulatedInfoResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderRegulatedInfoResponse

For additional error status codes, descriptions and schemas, see Error responses and schemas.

PATCH /orders/v0/orders/{orderId}/regulatedInfo

Operation: updateVerificationStatus

Description

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

Usage Plan:

Rate (requests per second)Burst
0.530

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

Parameters

TypeNameDescriptionSchema
PathorderId
required
An Amazon-defined order identifier, in 3-7-7 format.string
Bodypayload
required
The request body for the updateVerificationStatus operation.UpdateVerificationStatusRequest

Responses

HTTP CodeDescriptionSchema
204Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
No Content
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateVerificationStatusErrorResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateVerificationStatusErrorResponse
404The resource specified does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateVerificationStatusErrorResponse
413The request size exceeded the maximum accepted size.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateVerificationStatusErrorResponse
415The request payload is in an unsupported format.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateVerificationStatusErrorResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateVerificationStatusErrorResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateVerificationStatusErrorResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateVerificationStatusErrorResponse

For additional error status codes, descriptions and schemas, see Error responses and schemas.

POST /orders/v0/orders/{orderId}/shipmentConfirmation

Operation: confirmShipment

Description

Updates the shipment confirmation status for a specified order.

Usage Plan:

Rate (requests per second)Burst
210

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.

Parameters

TypeNameDescriptionSchema
PathorderId
required
An Amazon-defined order identifier, in 3-7-7 format.string
Bodypayload
required
Request body of confirmShipment.ConfirmShipmentRequest

Responses

HTTP CodeDescriptionSchema
204Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
No Content
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
ConfirmShipmentErrorResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
ConfirmShipmentErrorResponse
404The specified resource does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
ConfirmShipmentErrorResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
ConfirmShipmentErrorResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
ConfirmShipmentErrorResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
ConfirmShipmentErrorResponse

For additional error status codes, descriptions and schemas, see Error responses and schemas.

Error Responses and Schemas

This table contains HTTP status codes and associated information for error responses.

HTTP CodeDescriptionSchema
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers:
x-amzn-RequestId (string):Unique request reference identifier.
ConfirmShipmentErrorResponse

Definitions

UpdateShipmentStatusRequest

The request body for the updateShipmentStatus operation.

NameDescriptionSchema
marketplaceId
required
The unobfuscated marketplace identifier.MarketplaceId
shipmentStatus
required
The shipment status to apply.ShipmentStatus
orderItems
optional
For partial shipment status updates, the list of order items and quantities to be updated.OrderItems

UpdateVerificationStatusRequest

The request body for the updateVerificationStatus operation.

NameDescriptionSchema
regulatedOrderVerificationStatus
required
The updated values of the VerificationStatus field.UpdateVerificationStatusRequestBody

UpdateVerificationStatusRequestBody

The updated values of the VerificationStatus field.

NameDescriptionSchema
status
optional
The new verification status of the order.VerificationStatus
externalReviewerId
required
The identifier of the order's regulated information reviewer.string
rejectionReasonId
optional
The unique identifier of the rejection reason used for rejecting the order's regulated information. Only required if the new status is rejected.string
verificationDetails
optional
Additional information regarding the verification of the order.VerificationDetails

MarketplaceId

The unobfuscated marketplace identifier.

Type : string

ShipmentStatus

The shipment status to apply.

Type : enum

ValueDescription
ReadyForPickupReady for pickup.
PickedUpPicked up.
RefusedPickupRefused pickup.

OrderItems

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

Type : < OrderItems > array


OrderItems

NameDescriptionSchema
orderItemId
optional
The order item's unique identifier.string
quantity
optional
The quantity for which to update the shipment status.integer

UpdateShipmentStatusErrorResponse

The error response schema for the UpdateShipmentStatus operation.

NameDescriptionSchema
errors
optional
One or more unexpected errors occurred during the UpdateShipmentStatus operation.ErrorList

UpdateVerificationStatusErrorResponse

The error response schema for the UpdateVerificationStatus operation.

NameDescriptionSchema
errors
optional
One or more unexpected errors occurred during the UpdateVerificationStatus operation.ErrorList

GetOrdersResponse

The response schema for the getOrders operation.

NameDescriptionSchema
payload
optional
The payload for the getOrders operation.OrdersList
errors
optional
One or more unexpected errors occurred during the getOrders operation.ErrorList

GetOrderResponse

The response schema for the getOrder operation.

NameDescriptionSchema
payload
optional
The payload for the getOrder operation.Order
errors
optional
One or more unexpected errors occurred during the getOrder operation.ErrorList

GetOrderBuyerInfoResponse

The response schema for the getOrderBuyerInfo operation.

NameDescriptionSchema
payload
optional
The payload for the getOrderBuyerInfo operation.OrderBuyerInfo
errors
optional
One or more unexpected errors occurred during the getOrderBuyerInfo operation.ErrorList

GetOrderRegulatedInfoResponse

The response schema for the getOrderRegulatedInfo operation.

NameDescriptionSchema
payload
optional
The payload for the getOrderRegulatedInfo operation.OrderRegulatedInfo
errors
optional
One or more unexpected errors occurred during the getOrderRegulatedInfo operation.ErrorList

GetOrderAddressResponse

The response schema for the getOrderAddress operation.

NameDescriptionSchema
payload
optional
The payload for the getOrderAddress operations.OrderAddress
errors
optional
One or more unexpected errors occurred during the getOrderAddress operation.ErrorList

GetOrderItemsResponse

The response schema for the getOrderItems operation.

NameDescriptionSchema
payload
optional
The payload for the getOrderItems operation.OrderItemsList
errors
optional
One or more unexpected errors occurred during the getOrderItems operation.ErrorList

GetOrderItemsBuyerInfoResponse

The response schema for the getOrderItemsBuyerInfo operation.

NameDescriptionSchema
payload
optional
The payload for the getOrderItemsBuyerInfo operation.OrderItemsBuyerInfoList
errors
optional
One or more unexpected errors occurred during the getOrderItemsBuyerInfo operation.ErrorList

OrdersList

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

NameDescriptionSchema
Orders
required
A list of orders.OrderList
NextToken
optional
When present and not empty, pass this string token in the next request to return the next response page.string
LastUpdatedBefore
optional
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
CreatedBefore
optional
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.string

OrderList

A list of orders.

Type : < Order > array

Order

Order information.

NameDescriptionSchema
AmazonOrderId
required
An Amazon-defined order identifier, in 3-7-7 format.string
SellerOrderId
optional
A seller-defined order identifier.string
PurchaseDate
required
The date when the order was created.string
LastUpdateDate
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
OrderStatus
required
The current order status.enum (OrderStatus)
FulfillmentChannel
optional
Whether the order was fulfilled by Amazon (AFN) or by the seller (MFN).enum (FulfillmentChannel)
SalesChannel
optional
The sales channel for the first item in the order.string
OrderChannel
optional
The order channel for the first item in the order.string
ShipServiceLevel
optional
The order's shipment service level.string
OrderTotal
optional
The total charge for this order.Money
NumberOfItemsShipped
optional
The number of items shipped.integer
NumberOfItemsUnshipped
optional
The number of items unshipped.integer
PaymentExecutionDetail
optional
Information about sub-payment methods for a cash-on-delivery (COD) order.

Note: For a COD order that is paid for using one sub-payment method, one PaymentExecutionDetailItem object is returned, with PaymentExecutionDetailItem/PaymentMethod = COD. For a COD order that is paid for using multiple sub-payment methods, two or more PaymentExecutionDetailItem objects are returned.
PaymentExecutionDetailItemList
PaymentMethod
optional
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.enum (PaymentMethod)
PaymentMethodDetails
optional
A list of payment methods for the order.PaymentMethodDetailItemList
MarketplaceId
optional
The identifier for the marketplace where the order was placed.string
ShipmentServiceLevelCategory
optional
The shipment service level category for the order.

Possible values: Expedited, FreeEconomy, NextDay, Priority, SameDay, SecondDay, Scheduled, and Standard.
string
EasyShipShipmentStatus
optional
The status of the Amazon Easy Ship order. This property is only included for Amazon Easy Ship orders.EasyShipShipmentStatus
CbaDisplayableShippingLabel
optional
Custom ship label for Checkout by Amazon (CBA).string
OrderType
optional
The order's type.enum (OrderType)
EarliestShipDate
optional
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
LatestShipDate
optional
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
EarliestDeliveryDate
optional
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
LatestDeliveryDate
optional
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.string
IsBusinessOrder
optional
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
IsPrime
optional
When true, the order is a seller-fulfilled Amazon Prime order.boolean
IsPremiumOrder
optional
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
IsGlobalExpressEnabled
optional
When true, the order is a GlobalExpress order.boolean
ReplacedOrderId
optional
The order ID value for the order that is being replaced. Returned only if IsReplacementOrder = true.string
IsReplacementOrder
optional
When true, this is a replacement order.boolean
PromiseResponseDueDate
optional
Indicates the date by which the seller must respond to the buyer with an estimated ship date. Only returned for Sourcing on Demand orders.string
IsEstimatedShipDateSet
optional
When true, the estimated ship date is set for the order. Only returned for Sourcing on Demand orders.boolean
IsSoldByAB
optional
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
IsIBA
optional
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
DefaultShipFromLocationAddress
optional
The recommended location for the seller to ship the items from. It is calculated at checkout. The seller may or may not choose to ship from this location.Address
BuyerInvoicePreference
optional
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.
enum (BuyerInvoicePreference)
BuyerTaxInformation
optional
Contains the business invoice tax information. Sellers could use this data to issue electronic invoices for business orders in Turkey.

Note:
1. This attribute is only available in the Turkey marketplace for the orders that BuyerInvoicePreference is BUSINESS.
2. The BuyerTaxInformation is a restricted data. Use the Restricted Data Token (RDT) and restricted SPDS roles to access this restricted data.
BuyerTaxInformation
FulfillmentInstruction
optional
Contains the instructions about the fulfillment, such as the location from where you want the order filled.FulfillmentInstruction
IsISPU
optional
When true, this order is marked to be picked up from a store rather than delivered.boolean
IsAccessPointOrder
optional
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.boolean
MarketplaceTaxInfo
optional
Tax information about 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.
MarketplaceTaxInfo
SellerDisplayName
optional
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.
string
ShippingAddress
optional
The shipping address for the order.

Note:
1. ShippingAddress is only available for orders with the following status values: Unshipped, PartiallyShipped, Shipped and InvoiceUnconfirmed.
2. The ShippingAddress contains restricted data. Use the Restricted Data Token (RDT) and restricted SPDS roles to access the restricted data in ShippingAddress. For example, Name, AddressLine1, AddressLine2, AddressLine3, Phone, AddressType, and ExtendedFields.
Address
BuyerInfo
optional
Buyer information.

Note: The BuyerInfo contains restricted data. Use the Restricted Data Token (RDT) and restricted SPDS roles to access the restricted data in BuyerInfo. For example, BuyerName, BuyerTaxInfo, and PurchaseOrderNumber.
BuyerInfo
AutomatedShippingSettings
optional
Contains information regarding the Shipping Settings Automaton program, such as whether the order's shipping settings were generated automatically, and what those settings are.AutomatedShippingSettings
HasRegulatedItems
optional
Whether the order contains regulated items which may require additional approval steps before being fulfilled.boolean
ElectronicInvoiceStatus
optional
The status of the electronic invoice.ElectronicInvoiceStatus

OrderBuyerInfo

Buyer information for an order.

NameDescriptionSchema
AmazonOrderId
required
An Amazon-defined order identifier, in 3-7-7 format.string
BuyerEmail
optional
The anonymized email address of the buyer.string
BuyerName
optional
The buyer name or the recipient name.string
BuyerCounty
optional
The county of the buyer.

Note: This attribute is only available in the Brazil marketplace.
string
BuyerTaxInfo
optional
Tax information about the buyer. Sellers can use this data to issue electronic invoices for business orders.

Note: This attribute is only available for business orders in the Brazil, Mexico and India marketplaces.
BuyerTaxInfo
PurchaseOrderNumber
optional
The purchase order (PO) number entered by the buyer at checkout. Only returned for orders where the buyer entered a PO number at checkout.string

OrderRegulatedInfo

The order's regulated information along with its verification status.

NameDescriptionSchema
AmazonOrderId
required
An Amazon-defined order identifier, in 3-7-7 format.string
RegulatedInformation
required
The regulated information collected during purchase and used to verify the order.RegulatedInformation
RequiresDosageLabel
required
When true, the order requires attaching a dosage information label when shipped.boolean
RegulatedOrderVerificationStatus
required
The order's verification status.RegulatedOrderVerificationStatus

RegulatedOrderVerificationStatus

The verification status of the order, along with associated approval or rejection metadata.

NameDescriptionSchema
Status
required
The verification status of the order.VerificationStatus
RequiresMerchantAction
required
When true, the regulated information provided in the order requires a review by the merchant.boolean
ValidRejectionReasons
required
A list of valid rejection reasons that may be used to reject the order's regulated information.< RejectionReason > array
RejectionReason
optional
The reason for rejecting the order's regulated information. Not present if the order isn't rejected.RejectionReason
ReviewDate
optional
The date the order was reviewed. In ISO 8601 date time format.string
ExternalReviewerId
optional
The identifier for the order's regulated information reviewer.string
ValidVerificationDetails
optional
A list of valid verification details that may be provided and the criteria required for when the verification detail can be provided.< ValidVerificationDetail > array

RejectionReason

The reason for rejecting the order's regulated information. This is only present if the order is rejected.

NameDescriptionSchema
RejectionReasonId
required
The unique identifier for the rejection reason.string
RejectionReasonDescription
required
The description of this rejection reason.string

PrescriptionDetail

Information about the prescription that is used to verify a regulated product. This must be provided once per order and reflect the seller’s own records. Only approved orders can have prescriptions.

NameDescriptionSchema
prescriptionId
required
The identifier for the prescription used to verify the regulated product.string
expirationDate
required
The expiration date of the prescription used to verify the regulated product, in ISO 8601 date time format.string (date-time)
writtenQuantity
required
The number of units in each fill as provided in the prescription.
Minimum value : 1
integer
totalRefillsAuthorized
required
The total number of refills written in the original prescription used to verify the regulated product. If a prescription originally had no refills, this value must be 0.
Minimum value : 0
integer
refillsRemaining
required
The number of refills remaining for the prescription used to verify the regulated product. If a prescription originally had 10 total refills, this value must be 10 for the first order, 9 for the second order, and 0 for the eleventh order. If a prescription originally had no refills, this value must be 0.
Minimum value : 0
integer
clinicId
required
The identifier for the clinic which provided the prescription used to verify the regulated product.string
usageInstructions
required
The instructions for the prescription as provided by the approver of the regulated product.string

ValidVerificationDetail

The types of verification details that may be provided for the order and the criteria required for when the type of verification detail can be provided. The types of verification details allowed depend on the type of regulated product and will not change order to order.

NameDescriptionSchema
VerificationDetailType
required
A supported type of verification detail. The type indicates which verification detail could be shared while updating the regulated order. Valid value: prescriptionDetail.string
ValidVerificationStatuses
required
A list of valid verification statuses where the associated verification detail type may be provided. For example, if the value of this field is ["Approved"], calls to provide the associated verification detail will fail for orders with a VerificationStatus of Pending, Rejected, Expired, or Cancelled.< VerificationStatus > array

VerificationDetails

Additional information related to the verification of a regulated order.

NameDescriptionSchema
prescriptionDetail
optional
Information regarding the prescription tied to the order.PrescriptionDetail

VerificationStatus

The verification status of the order.

Type : enum

ValueDescription
PendingThe order is pending approval. Note that the approval might be needed from someone other than the merchant as determined by the RequiresMerchantAction property.
ApprovedThe order's regulated information has been reviewed and approved.
RejectedThe order's regulated information has been reviewed and rejected.
ExpiredThe time to review the order's regulated information has expired.
CancelledThe order was cancelled by the purchaser.

RegulatedInformation

The regulated information collected during purchase and used to verify the order.

NameDescriptionSchema
Fields
required
A list of regulated information fields as collected from the regulatory form.< RegulatedInformationField > array

RegulatedInformationField

A field collected from the regulatory form.

NameDescriptionSchema
FieldId
required
The unique identifier of the field.string
FieldLabel
required
The name of the field.string
FieldType
required
The type of field.enum (FieldType)
FieldValue
required
The content of the field as collected in regulatory form. Note that FileAttachment type fields contain a URL where you can download the attachment.string

OrderAddress

The shipping address for the order.

NameDescriptionSchema
AmazonOrderId
required
An Amazon-defined order identifier, in 3-7-7 format.string
BuyerCompanyName
optional
The company name of the contact buyer. For IBA orders, the buyer company must be Amazon entities.string
ShippingAddress
optional
The shipping address for the order.

Note: ShippingAddress is only available for orders with the following status values: Unshipped, PartiallyShipped, Shipped, and InvoiceUnconfirmed.
Address
DeliveryPreferences
optional
Contains all of the delivery instructions provided by the customer for the shipping address.DeliveryPreferences

Address

The shipping address for the order.

NameDescriptionSchema
Name
required
The name.string
CompanyName
optional
The company name of the recipient.

Note: This attribute is only available for shipping address.
string
AddressLine1
optional
The street address.string
AddressLine2
optional
Additional street address information, if required.string
AddressLine3
optional
Additional street address information, if required.string
City
optional
The city.string
County
optional
The county.string
District
optional
The district.string
StateOrRegion
optional
The state or region.string
Municipality
optional
The municipality.string
PostalCode
optional
The postal code.string
CountryCode
optional
The country code. A two-character country code, in ISO 3166-1 alpha-2 format.string
Phone
optional
The phone number of the buyer.

Note:
1. This attribute is only available for shipping address.
2. In some cases, the buyer phone number is suppressed:
a. Phone is suppressed for all AFN (fulfilled by Amazon) orders.
b. Phone is suppressed for the shipped MFN (fulfilled by seller) order when the current date is past the Latest Delivery Date.
string
ExtendedFields
optional
The container for address extended fields. For example, street name or street number.

Note: This attribute is currently only available with Brazil shipping addresses.
AddressExtendedFields
AddressType
optional
The address type of the shipping address.enum (AddressType)

AddressExtendedFields

The container for address extended fields (such as street name and street number). Currently only available with Brazil shipping addresses.

NameDescriptionSchema
StreetName
optional
The street name.string
StreetNumber
optional
The house, building, or property number associated with the location's street address.string
Complement
optional
The floor number/unit number in the building/private house number.string
Neighborhood
optional
The neighborhood. This value is only used in some countries (such as Brazil).string

DeliveryPreferences

Contains all of the delivery instructions provided by the customer for the shipping address.

NameDescriptionSchema
DropOffLocation
optional
Drop-off location selected by the customer.string
PreferredDeliveryTime
optional
Business hours and days when the delivery is preferred.PreferredDeliveryTime
OtherAttributes
optional
Enumerated list of miscellaneous delivery attributes associated with the shipping address.< OtherDeliveryAttributes > array
AddressInstructions
optional
Building instructions, nearby landmark or navigation instructions.string

PreferredDeliveryTime

The time window when the delivery is preferred.

NameDescriptionSchema
BusinessHours
optional
Business hours when the business is open for deliveries.< BusinessHours > array
ExceptionDates
optional
Dates when the business is closed during the next 30 days.< ExceptionDates > array

BusinessHours

Business days and hours when the destination is open for deliveries.

NameDescriptionSchema
DayOfWeek
optional
Day of the week.enum (DayOfWeek)
OpenIntervals
optional
Time window during the day when the business is open.< OpenInterval > array

ExceptionDates

Dates when the business is closed or open with a different time window.

NameDescriptionSchema
ExceptionDate
optional
Date when the business is closed, in ISO 8601 date format.string
IsOpen
optional
Boolean indicating if the business is closed or open on that date.boolean
OpenIntervals
optional
Time window during the day when the business is open.< OpenInterval > array

OpenInterval

The time interval for which the business is open.

NameDescriptionSchema
StartTime
optional
The time when the business opens.OpenTimeInterval
EndTime
optional
The time when the business closes.OpenTimeInterval

OpenTimeInterval

The time when the business opens or closes.

NameDescriptionSchema
Hour
optional
The hour when the business opens or closes.integer
Minute
optional
The minute when the business opens or closes.integer

OtherDeliveryAttributes

Miscellaneous delivery attributes associated with the shipping address.

Type : enum

ValueDescription
HAS_ACCESS_POINTIndicates whether the delivery has an access point pickup or drop-off location.
PALLET_ENABLEDIndicates whether pallet delivery is enabled for the address.
PALLET_DISABLEDIndicates whether pallet delivery is disabled for the address.

Money

The monetary value of the order.

NameDescriptionSchema
CurrencyCode
optional
The three-digit currency code. In ISO 4217 format.string
Amount
optional
The currency amount.string

PaymentMethodDetailItemList

A list of payment method detail items.

Type : < string > array

PaymentExecutionDetailItemList

A list of payment execution detail items.

Type : < PaymentExecutionDetailItem > array

PaymentExecutionDetailItem

Information about a sub-payment method used to pay for a COD order.

NameDescriptionSchema
Payment
required
The monetary value of the order.Money
PaymentMethod
required
A sub-payment method for a COD order.

Possible values:
  • COD: Cash on delivery

  • GC: Gift card

  • PointsAccount: Amazon Points

  • Invoice: Invoice
  • string

    BuyerTaxInfo

    Tax information about the buyer.

    NameDescriptionSchema
    CompanyLegalName
    optional
    The legal name of the company.string
    TaxingRegion
    optional
    The country or region imposing the tax.string
    TaxClassifications
    optional
    A list of tax classifications that apply to the order.< TaxClassification > array

    MarketplaceTaxInfo

    Tax information about the marketplace.

    NameDescriptionSchema
    TaxClassifications
    optional
    A list of tax classifications that apply to the order.< TaxClassification > array

    TaxClassification

    The tax classification of the order.

    NameDescriptionSchema
    Name
    optional
    The type of tax.string
    Value
    optional
    The buyer's tax identifier.string

    OrderItemsList

    The order items list along with the order ID.

    NameDescriptionSchema
    OrderItems
    required
    A list of order items.OrderItemList
    NextToken
    optional
    When present and not empty, pass this string token in the next request to return the next response page.string
    AmazonOrderId
    required
    An Amazon-defined order identifier, in 3-7-7 format.string

    OrderItemList

    A list of order items.

    Type : < OrderItem > array

    OrderItem

    A single order item.

    NameDescriptionSchema
    ASIN
    required
    The item's Amazon Standard Identification Number (ASIN).string
    SellerSKU
    optional
    The item's seller stock keeping unit (SKU).string
    OrderItemId
    required
    An Amazon-defined order item identifier.string
    AssociatedItems
    optional
    A list of associated items that a customer has purchased with a product. For example, a tire installation service purchased with tires.< AssociatedItem > array
    Title
    optional
    The item's name.string
    QuantityOrdered
    required
    The number of items in the order.integer
    QuantityShipped
    optional
    The number of items shipped.integer
    ProductInfo
    optional
    The item's product information.ProductInfoDetail
    PointsGranted
    optional
    The number and value of Amazon Points granted with the purchase of an item.PointsGrantedDetail
    ItemPrice
    optional
    The selling price of the order item. Note that an order item is an item and a quantity. This means that the value of ItemPrice is equal to the selling price of the item multiplied by the quantity ordered. ItemPrice excludes ShippingPrice and GiftWrapPrice.Money
    ShippingPrice
    optional
    The item's shipping price.Money
    ItemTax
    optional
    The tax on the item price.Money
    ShippingTax
    optional
    The tax on the shipping price.Money
    ShippingDiscount
    optional
    The discount on the shipping price.Money
    ShippingDiscountTax
    optional
    The tax on the discount on the shipping price.Money
    PromotionDiscount
    optional
    The total of all promotional discounts in the offer.Money
    PromotionDiscountTax
    optional
    The tax on the total of all promotional discounts in the offer.Money
    PromotionIds
    optional
    A list of promotion identifiers provided by the seller when the promotions were created.PromotionIdList
    CODFee
    optional
    The fee charged for COD service.Money
    CODFeeDiscount
    optional
    The discount on the COD fee.Money
    IsGift
    optional
    Indicates whether the item is a gift.

    Possible values: true and false.
    string
    ConditionNote
    optional
    The condition of the item, as described by the seller.string
    ConditionId
    optional
    The condition of the item.

    Possible values: New, Used, Collectible, Refurbished, Preorder, and Club.
    string
    ConditionSubtypeId
    optional
    The subcondition of the item.

    Possible values: New, Mint, Very Good, Good, Acceptable, Poor, Club, OEM, Warranty, Refurbished Warranty, Refurbished, Open Box, Any, and Other.
    string
    ScheduledDeliveryStartDate
    optional
    The start date of the scheduled delivery window in the time zone for the order destination. In ISO 8601 date time format.string
    ScheduledDeliveryEndDate
    optional
    The end date of the scheduled delivery window in the time zone for the order destination. In ISO 8601 date time format.string
    PriceDesignation
    optional
    Indicates that the selling price is a special price that is only available for Amazon Business orders. For more information about the Amazon Business Seller Program, refer to the Amazon Business website.

    Possible values: BusinessPrice
    string
    TaxCollection
    optional
    Information about withheld taxes.TaxCollection
    SerialNumberRequired
    optional
    When true, the product type for this item has a serial number.

    Only returned for Amazon Easy Ship orders.
    boolean
    IsTransparency
    optional
    When true, the ASIN is enrolled in Transparency. The Transparency serial number that you must submit is determined by:

    1D or 2D Barcode: This has a T logo. Submit either the 29-character alpha-numeric identifier beginning with AZ or ZA, or the 38-character Serialized Global Trade Item Number (SGTIN).
    2D Barcode SN: Submit the 7- to 20-character serial number barcode, which likely has the prefix SN. The serial number is applied to the same side of the packaging as the GTIN (UPC/EAN/ISBN) barcode.
    QR code SN: Submit the URL that the QR code generates.
    boolean
    IossNumber
    optional
    The IOSS number of the marketplace. Sellers shipping to the EU from outside the EU must provide this IOSS number to their carrier when Amazon has collected the VAT on the sale.string
    StoreChainStoreId
    optional
    The store chain store identifier. Linked to a specific store in a store chain.string
    DeemedResellerCategory
    optional
    The category of deemed reseller. This applies to selling partners that are not based in the EU and is used to help them meet the VAT Deemed Reseller tax laws in the EU and UK.enum (DeemedResellerCategory)
    BuyerInfo
    optional
    A single item's buyer information.

    Note: The BuyerInfo contains restricted data. Use the Restricted Data Token (RDT) and restricted SPDS roles to access the restricted data in BuyerInfo. For example, BuyerCustomizedInfo and GiftMessageText.
    ItemBuyerInfo
    BuyerRequestedCancel
    optional
    Information about whether or not a buyer requested cancellation.BuyerRequestedCancel
    SerialNumbers
    optional
    A list of serial numbers for electronic products that are shipped to customers. Returned for FBA orders only.< string > array
    SubstitutionPreferences
    optional
    Substitution preferences for the order item. This is an optional field that is only present if a seller supports substitutions, as is the case with some grocery sellers.SubstitutionPreferences
    Measurement
    optional
    Measurement information for the order item.Measurement
    ShippingConstraints
    optional
    Shipping constraints applicable to this order.ShippingConstraints
    AmazonPrograms
    optional
    Contains the list of programs that are associated with an item.AmazonPrograms

    AmazonPrograms

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

    Possible programs are:

    • Subscribe and Save: Offers recurring, scheduled deliveries to Amazon customers and Amazon Business customers for their frequently ordered products.
    NameDescriptionSchema
    Programs
    required
    A list of the programs that are associated with the specified order item.

    Possible values: SUBSCRIBE_AND_SAVE
    < string > array

    SubstitutionPreferences

    Substitution preferences for an order item.

    NameDescriptionSchema
    SubstitutionType
    required
    The type of substitution that these preferences represent.enum (SubstitutionType)
    SubstitutionOptions
    optional
    Substitution options for the order item.SubstitutionOptionList

    SubstitutionOptionList

    A collection of substitution options.

    Type : < SubstitutionOption > array

    SubstitutionOption

    Substitution options for an order item.

    NameDescriptionSchema
    ASIN
    optional
    The item's Amazon Standard Identification Number (ASIN).string
    QuantityOrdered
    optional
    The number of items to be picked for this substitution option.integer
    SellerSKU
    optional
    The item's seller stock keeping unit (SKU).string
    Title
    optional
    The item's title.string
    Measurement
    optional
    Measurement information for the substitution option.Measurement

    Measurement

    Measurement information for an order item.

    NameDescriptionSchema
    Unit
    required
    The unit of measure.enum (Unit)
    Value
    required
    The measurement value.number

    AssociatedItem

    An item that is associated with an order item. For example, a tire installation service that is purchased with tires.

    NameDescriptionSchema
    OrderId
    optional
    The order item's order identifier, in 3-7-7 format.string
    OrderItemId
    optional
    An Amazon-defined item identifier for the associated item.string
    AssociationType
    optional
    The type of association an item has with an order item.AssociationType

    AssociationType

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

    Type : enum

    ValueDescription
    VALUE_ADD_SERVICEThe associated item is a service order.

    OrderItemsBuyerInfoList

    A single order item's buyer information list with the order ID.

    NameDescriptionSchema
    OrderItems
    required
    A single order item's buyer information list.OrderItemBuyerInfoList
    NextToken
    optional
    When present and not empty, pass this string token in the next request to return the next response page.string
    AmazonOrderId
    required
    An Amazon-defined order identifier, in 3-7-7 format.string

    OrderItemBuyerInfoList

    A single order item's buyer information list.

    Type : < OrderItemBuyerInfo > array

    OrderItemBuyerInfo

    A single order item's buyer information.

    NameDescriptionSchema
    OrderItemId
    required
    An Amazon-defined order item identifier.string
    BuyerCustomizedInfo
    optional
    Buyer information for custom orders from the Amazon Custom program.

    Note: This attribute is only available for MFN (fulfilled by seller) orders.
    BuyerCustomizedInfoDetail
    GiftWrapPrice
    optional
    The gift wrap price of the item.Money
    GiftWrapTax
    optional
    The tax on the gift wrap price.Money
    GiftMessageText
    optional
    A gift message provided by the buyer.

    Note: This attribute is only available for MFN (fulfilled by seller) orders.
    string
    GiftWrapLevel
    optional
    The gift wrap level specified by the buyer.string

    PointsGrantedDetail

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

    NameDescriptionSchema
    PointsNumber
    optional
    The number of Amazon Points granted with the purchase of an item.integer
    PointsMonetaryValue
    optional
    The monetary value of the Amazon Points granted.Money

    ProductInfoDetail

    Product information on the number of items.

    NameDescriptionSchema
    NumberOfItems
    optional
    The total number of items that are included in the ASIN.string

    PromotionIdList

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

    Type : < string > array

    BuyerCustomizedInfoDetail

    Buyer information for custom orders from the Amazon Custom program.

    NameDescriptionSchema
    CustomizedURL
    optional
    The location of a ZIP file containing Amazon Custom data.string

    TaxCollection

    Information about withheld taxes.

    NameDescriptionSchema
    Model
    optional
    The tax collection model applied to the item.enum (Model)
    ResponsibleParty
    optional
    The party responsible for withholding the taxes and remitting them to the taxing authority.enum (ResponsibleParty)

    BuyerTaxInformation

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

    NameDescriptionSchema
    BuyerLegalCompanyName
    optional
    Business buyer's company legal name.string
    BuyerBusinessAddress
    optional
    Business buyer's address.string
    BuyerTaxRegistrationId
    optional
    Business buyer's tax registration ID.string
    BuyerTaxOffice
    optional
    Business buyer's tax office.string

    FulfillmentInstruction

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

    NameDescriptionSchema
    FulfillmentSupplySourceId
    optional
    The sourceId of the location from where you want the order fulfilled.string

    ShippingConstraints

    Delivery constraints applicable to this order.

    NameDescriptionSchema
    PalletDelivery
    optional
    Indicates if the line item needs to be delivered by pallet.ConstraintType
    SignatureConfirmation
    optional
    Indicates that the recipient of the line item must sign to confirm its delivery.ConstraintType
    RecipientIdentityVerification
    optional
    Indicates that the person receiving the line item must be the same as the intended recipient of the order.ConstraintType
    RecipientAgeVerification
    optional
    Indicates that the carrier must confirm the recipient is of the legal age to receive the line item upon delivery.ConstraintType

    ConstraintType

    Details the importance of the constraint present on the item

    Type : enum

    ValueDescription
    MANDATORYItem must follow the constraint to ensure order is met with buyer's delivery requirements.

    BuyerInfo

    Buyer information.

    NameDescriptionSchema
    BuyerEmail
    optional
    The anonymized email address of the buyer.string
    BuyerName
    optional
    The buyer name or the recipient name.string
    BuyerCounty
    optional
    The county of the buyer.

    Note: This attribute is only available in the Brazil marketplace.
    string
    BuyerTaxInfo
    optional
    Tax information about the buyer. Sellers can use this data to issue electronic invoices for business orders.

    Note: This attribute is only available for business orders in the Brazil, Mexico and India marketplaces.
    BuyerTaxInfo
    PurchaseOrderNumber
    optional
    The purchase order (PO) number entered by the buyer at checkout. Only returned for orders where the buyer entered a PO number at checkout.string

    ItemBuyerInfo

    A single item's buyer information.

    NameDescriptionSchema
    BuyerCustomizedInfo
    optional
    Buyer information for custom orders from the Amazon Custom program.

    Note: This attribute is only available for MFN (fulfilled by seller) orders.
    BuyerCustomizedInfoDetail
    GiftWrapPrice
    optional
    The gift wrap price of the item.Money
    GiftWrapTax
    optional
    The tax on the gift wrap price.Money
    GiftMessageText
    optional
    A gift message provided by the buyer.

    Note: This attribute is only available for MFN (fulfilled by seller) orders.
    string
    GiftWrapLevel
    optional
    The gift wrap level specified by the buyer.string

    AutomatedShippingSettings

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

    NameDescriptionSchema
    HasAutomatedShippingSettings
    optional
    When true, this order has automated shipping settings generated by Amazon. This order could be identified as an SSA order.boolean
    AutomatedCarrier
    optional
    Auto-generated carrier for SSA orders.string
    AutomatedShipMethod
    optional
    Auto-generated ship method for SSA orders.string

    BuyerRequestedCancel

    Information about whether or not a buyer requested cancellation.

    NameDescriptionSchema
    IsBuyerRequestedCancel
    optional
    Indicate whether the buyer has requested cancellation.

    Possible Values: true, false.
    string
    BuyerCancelReason
    optional
    The reason that the buyer requested cancellation.string

    EasyShipShipmentStatus

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

    Type : enum

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

    ElectronicInvoiceStatus

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

    Type : enum

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

    ConfirmShipmentRequest

    The request schema for an shipment confirmation.

    NameDescriptionSchema
    packageDetail
    required
    Properties of packagesPackageDetail
    codCollectionMethod
    optional
    The COD collection method (only supported in the JP marketplace).enum (CodCollectionMethod)
    marketplaceId
    required
    The unobfuscated marketplace identifier.MarketplaceId

    ConfirmShipmentErrorResponse

    The error response schema for the confirmShipment operation.

    NameDescriptionSchema
    errors
    optional
    One or more unexpected errors occurred during the confirmShipment operation.ErrorList

    PackageDetail

    Properties of packages

    NameDescriptionSchema
    packageReferenceId
    required
    A seller-supplied identifier that uniquely identifies a package within the scope of an order. Only positive numeric values are supported.PackageReferenceId
    carrierCode
    required
    Identifies the carrier that will deliver the package. This field is required for all marketplaces. For more information, refer to the CarrierCode announcement.string
    carrierName
    optional
    Carrier Name that will deliver the package. Required when carrierCode is "Others"string
    shippingMethod
    optional
    Ship method to be used for shipping the order.string
    trackingNumber
    required
    The tracking number used to obtain tracking and delivery information.string
    shipDate
    required
    The shipping date for the package. Must be in ISO 8601 date/time format.string (date-time)
    shipFromSupplySourceId
    optional
    The unique identifier for the supply source.string
    orderItems
    required
    The list of order items and quantities to be updated.ConfirmShipmentOrderItemsList

    ConfirmShipmentOrderItemsList

    A list of order items.

    Type : < ConfirmShipmentOrderItem > array

    ConfirmShipmentOrderItem

    A single order item.

    NameDescriptionSchema
    orderItemId
    required
    The order item's unique identifier.string
    quantity
    required
    The item's quantity.integer
    transparencyCodes
    optional
    The list of transparency codes.TransparencyCodeList

    TransparencyCodeList

    A list of order items.

    Type : < TransparencyCode > array

    TransparencyCode

    The transparency code associated with the item.

    Type : string

    PackageReferenceId

    A seller-supplied identifier that uniquely identifies a package within the scope of an order. Only positive numeric values are supported.

    Type : string

    ErrorList

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

    Type : < Error > array

    Error

    Error response returned when the request is unsuccessful.

    NameDescriptionSchema
    code
    required
    An error code that identifies the type of error that occurred.string
    message
    required
    A message that describes the error condition.string
    details
    optional
    Additional details that can help the caller understand or fix the issue.string

    BuyerInvoicePreference

    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.

    Type : enum

    ValueDescription
    INDIVIDUALIssues an individual invoice to the buyer.
    BUSINESSIssues a business invoice to the buyer. Tax information is available in BuyerTaxInformation.

    DayOfWeek

    Day of the week.

    Type : enum

    ValueDescription
    SUNSunday - Day of the week.
    MONMonday - Day of the week.
    TUETuesday - Day of the week.
    WEDWednesday - Day of the week.
    THUThursday - Day of the week.
    FRIFriday - Day of the week.
    SATSaturday - Day of the week.

    CodCollectionMethod

    The COD collection method (only supported in the JP marketplace).

    Type : enum

    ValueDescription
    DirectPayment-

    Unit

    The unit of measure.

    Type : enum

    ValueDescription
    OUNCESThe item is measured in ounces.
    POUNDSThe item is measured in pounds.
    KILOGRAMSThe item is measured in kilograms.
    GRAMSThe item is measured in grams.
    MILLIGRAMSThe item is measured in milligrams.
    INCHESThe item is measured in inches.
    FEETThe item is measured in feet.
    METERSThe item is measured in meters.
    CENTIMETERSThe item is measured in centimeters.
    MILLIMETERSThe item is measured in millimeters.
    SQUARE_METERSThe item is measured in square meters.
    SQUARE_CENTIMETERSThe item is measured in square centimeters.
    SQUARE_FEETThe item is measured in square feet.
    SQUARE_INCHESThe item is measured in square inches.
    GALLONSThe item is measured in gallons.
    PINTSThe item is measured in pints.
    QUARTSThe item is measured in quarts.
    FLUID_OUNCESThe item is measured in fluid ounces.
    LITERSThe item is measured in liters.
    CUBIC_METERSThe item is measured in cubic meters.
    CUBIC_FEETThe item is measured in cubic feet.
    CUBIC_INCHESThe item is measured in cubic inches.
    CUBIC_CENTIMETERSThe item is measured in cubic centimeters.
    COUNTThe item is measured by count.

    ResponsibleParty

    The party responsible for withholding the taxes and remitting them to the taxing authority.

    Type : enum

    ValueDescription
    Amazon Services, Inc.The MarketplaceFacilitator entity for the US marketplace.

    FieldType

    The type of field.

    Type : enum

    ValueDescription
    TextThis field is a text representation of the response collected from the regulatory form.
    FileAttachmentThis field contains a link to an attachment collected from the regulatory form.

    SubstitutionType

    The type of substitution that these preferences represent.

    Type : enum

    ValueDescription
    CUSTOMER_PREFERENCECustomer has provided the substitution preferences.
    AMAZON_RECOMMENDEDAmazon has provided the substitution preferences.
    DO_NOT_SUBSTITUTEDo not provide a substitute if item is not found.

    OrderStatus

    The current order status.

    Type : enum

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

    OrderType

    The order's type.

    Type : enum

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

    Model

    The tax collection model applied to the item.

    Type : enum

    ValueDescription
    MarketplaceFacilitatorTax is withheld and remitted to the taxing authority by Amazon on behalf of the seller.

    PaymentMethod

    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.

    Type : enum

    ValueDescription
    CODCash on delivery.
    CVSConvenience store.
    OtherA payment method other than COD and CVS.

    AddressType

    The address type of the shipping address.

    Type : enum

    ValueDescription
    ResidentialThe shipping address is a residential address.
    CommercialThe shipping address is a commercial address.

    FulfillmentChannel

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

    Type : enum

    ValueDescription
    MFNFulfilled by the seller.
    AFNFulfilled by Amazon.

    DeemedResellerCategory

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

    Type : enum

    ValueDescription
    IOSSImport one stop shop. The item being purchased is not held in the EU for shipment.
    UOSSUnion one stop shop. The item being purchased is held in the EU for shipment.