Orders API v0 reference

AmazonSPAPI

# Overview

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

# Version information

Version : v0

# Operations

getOrders
getOrder
getOrderBuyerInfo
getOrderAddress
getOrderItems
getOrderItemsBuyerInfo
updateShipmentStatus
getOrderRegulatedInfo
updateVerificationStatus

# Paths

# getOrders

GET /orders/v0/orders

# Description

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

Usage Plan:

Rate (requests per second) Burst
0.0167 20

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

# Parameters

Type Name Description Schema
Query CreatedAfter
optional
A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. Either the CreatedAfter parameter or the LastUpdatedAfter parameter is required. Both cannot be empty. The date must be in ISO 8601 format. string
Query CreatedBefore
optional
A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in ISO 8601 format. string
Query LastUpdatedAfter
optional
A date used for selecting orders that were last updated after (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in ISO 8601 format. string
Query LastUpdatedBefore
optional
A date used for selecting orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in ISO 8601 format. string
Query OrderStatuses
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); and Unfulfillable (The order cannot be fulfilled. This state applies only to Multi-Channel Fulfillment orders.). < string > array
Query MarketplaceIds
required
A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces.

See the Selling Partner API Developer Guide (opens new window) for a complete list of marketplaceId values.
Max count : 50
< string > array
Query FulfillmentChannels
optional
A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. Possible values: AFN (Fulfillment by Amazon); MFN (Fulfilled by the seller). < string > array
Query PaymentMethods
optional
A list of payment method values. Used to select orders paid using the specified payment methods. Possible values: COD (Cash on delivery); CVS (Convenience store payment); Other (Any payment method other than COD or CVS). < string > array
Query BuyerEmail
optional
The email address of a buyer. Used to select orders that contain the specified email address. string
Query SellerOrderId
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
Query MaxResultsPerPage
optional
A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100. integer
Query EasyShipShipmentStatuses
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: PendingPickUp (Amazon has not yet picked up the package from the seller). LabelCanceled (The seller canceled the pickup). PickedUp (Amazon has picked up the package from the seller). AtOriginFC (The packaged is at the origin fulfillment center). AtDestinationFC (The package is at the destination fulfillment center). OutForDelivery (The package is out for delivery). Damaged (The package was damaged by the carrier). Delivered (The package has been delivered to the buyer). RejectedByBuyer (The package has been rejected by the buyer). Undeliverable (The package cannot be delivered). ReturnedToSeller (The package was not delivered to the buyer and was returned to the seller). ReturningToSeller (The package was not delivered to the buyer and is being returned to the seller). < string > array
Query NextToken
optional
A string token returned in the response of your previous request. string
Query AmazonOrderIds
optional
A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format.
Max count : 50
< string > array
Query ActualFulfillmentSupplySourceId
optional
Denotes the recommended sourceId where the order should be fulfilled from. string
Query IsISPU
optional
When true, this order is marked to be picked up from a store rather than delivered. boolean
Query StoreChainStoreId
optional
The store chain store identifier. Linked to a specific store in a store chain. string

# Responses

HTTP Code Description Schema
200 Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrdersResponse
400 Request 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
403 Indicates 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
404 The 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
429 The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrdersResponse
500 An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrdersResponse
503 Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrdersResponse

# getOrder

GET /orders/v0/orders/{orderId}

# Description

Returns the order that you specify.

Usage Plan:

Rate (requests per second) Burst
0.0167 20

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

# Parameters

Type Name Description Schema
Path orderId
required
An Amazon-defined order identifier, in 3-7-7 format. string

# Responses

HTTP Code Description Schema
200 Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderResponse
400 Request 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
403 Indicates 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
404 The 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
429 The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderResponse
500 An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderResponse
503 Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderResponse

# getOrderBuyerInfo

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

# Description

Returns buyer information for the order that you specify.

Usage Plan:

Rate (requests per second) Burst
0.0167 20

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

# Parameters

Type Name Description Schema
Path orderId
required
An orderId is an Amazon-defined order identifier, in 3-7-7 format. string

# Responses

HTTP Code Description Schema
200 Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderBuyerInfoResponse
400 Request 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
403 Indicates 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
404 The 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
429 The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderBuyerInfoResponse
500 An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderBuyerInfoResponse
503 Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderBuyerInfoResponse

# getOrderAddress

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

# Description

Returns the shipping address for the order that you specify.

Usage Plan:

Rate (requests per second) Burst
0.0167 20

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

# Parameters

Type Name Description Schema
Path orderId
required
An orderId is an Amazon-defined order identifier, in 3-7-7 format. string

# Responses

HTTP Code Description Schema
200 Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderAddressResponse
400 Request 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
403 Indicates 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
404 The 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
429 The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderAddressResponse
500 An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderAddressResponse
503 Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderAddressResponse

# getOrderItems

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

# 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.5 30

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

# Parameters

Type Name Description Schema
Path orderId
required
An Amazon-defined order identifier, in 3-7-7 format. string
Query NextToken
optional
A string token returned in the response of your previous request. string

# Responses

HTTP Code Description Schema
200 Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderItemsResponse
400 Request 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
403 Indicates 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
404 The 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
429 The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderItemsResponse
500 An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderItemsResponse
503 Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderItemsResponse

# getOrderItemsBuyerInfo

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

# Description

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

Usage Plan:

Rate (requests per second) Burst
0.5 30

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

# Parameters

Type Name Description Schema
Path orderId
required
An Amazon-defined order identifier, in 3-7-7 format. string
Query NextToken
optional
A string token returned in the response of your previous request. string

# Responses

HTTP Code Description Schema
200 Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderItemsBuyerInfoResponse
400 Request 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
403 Indicates 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
404 The 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
429 The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderItemsBuyerInfoResponse
500 An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderItemsBuyerInfoResponse
503 Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderItemsBuyerInfoResponse

# updateShipmentStatus

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

# Description

Update the shipment status for an order that you specify.

Usage Plan:

Rate (requests per second) Burst
5 15

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

# Parameters

Type Name Description Schema
Path orderId
required
An Amazon-defined order identifier, in 3-7-7 format. string
Body payload
required
The request body for the updateShipmentStatus operation. UpdateShipmentStatusRequest

# Responses

HTTP Code Description Schema
204 Success.
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
400 Request 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
403 Indicates 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
404 The 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
413 The request size exceeded the maximum accepted size.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateShipmentStatusErrorResponse
415 The request payload is in an unsupported format.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateShipmentStatusErrorResponse
429 The frequency of requests was greater than allowed.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateShipmentStatusErrorResponse
500 An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateShipmentStatusErrorResponse
503 Temporary overloading or maintenance of the server.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateShipmentStatusErrorResponse

# getOrderRegulatedInfo

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

# Description

Returns regulated information for the order that you specify.

Usage Plan:

Rate (requests per second) Burst
0.5 30

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

# Parameters

Type Name Description Schema
Path orderId
required
An orderId is an Amazon-defined order identifier, in 3-7-7 format. string

# Responses

HTTP Code Description Schema
200 Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderRegulatedInfoResponse
400 Request 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
403 Indicates 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
404 The 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
429 The frequency of requests was greater than allowed.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderRegulatedInfoResponse
500 An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderRegulatedInfoResponse
503 Temporary overloading or maintenance of the server.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetOrderRegulatedInfoResponse

# updateVerificationStatus

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

# Description

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

Usage Plan:

Rate (requests per second) Burst
0.5 30

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

# Parameters

Type Name Description Schema
Path orderId
required
An orderId is an Amazon-defined order identifier, in 3-7-7 format. string
Body payload
required
Request to update the verification status of an order containing regulated products. UpdateVerificationStatusRequest

# Responses

HTTP Code Description Schema
204 Success.
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
400 Request 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
403 Indicates 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
404 The 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
413 The request size exceeded the maximum accepted size.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateVerificationStatusErrorResponse
415 The request payload is in an unsupported format.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateVerificationStatusErrorResponse
429 The frequency of requests was greater than allowed.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateVerificationStatusErrorResponse
500 An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateVerificationStatusErrorResponse
503 Temporary overloading or maintenance of the server.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateVerificationStatusErrorResponse

# Definitions

# UpdateShipmentStatusRequest

The request body for the updateShipmentStatus operation.

Name Description Schema
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

Request to update the verification status of an order containing regulated products.

Name Description Schema
regulatedOrderVerificationStatus
required
The updated values of the VerificationStatus field. UpdateVerificationStatusRequestBody

# UpdateVerificationStatusRequestBody

The updated values of the VerificationStatus field.

Name Description Schema
status
required
The new verification status of the order. VerificationStatus
externalReviewerId
required
The identifier for the order's regulated information reviewer. string
rejectionReasonId
optional
The unique identifier for the rejection reason used for rejecting the order's regulated information. Only required if the new status is rejected. string

# MarketplaceId

The unobfuscated marketplace identifier.

Type : string

# ShipmentStatus

The shipment status to apply.

Type : enum

Value Description
ReadyForPickup Ready for pickup.
PickedUp Picked up.
RefusedPickup Refused pickup.

# OrderItems

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

Type : < OrderItems > array

OrderItems

Name Description Schema
orderItemId
optional
The unique identifier of the order item. string
quantity
optional
The quantity for which to update the shipment status. integer

# UpdateShipmentStatusErrorResponse

The error response schema for the UpdateShipmentStatus operation.

Name Description Schema
errors
optional
One or more unexpected errors occurred during the UpdateShipmentStatus operation. ErrorList

# UpdateVerificationStatusErrorResponse

The error response schema for the UpdateVerificationStatus operation.

Name Description Schema
errors
optional
One or more unexpected errors occurred during the UpdateVerificationStatus operation. ErrorList

# GetOrdersResponse

The response schema for the getOrders operation.

Name Description Schema
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.

Name Description Schema
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.

Name Description Schema
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.

Name Description Schema
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.

Name Description Schema
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.

Name Description Schema
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.

Name Description Schema
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.

Name Description Schema
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
A date used for selecting orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. All dates must be in ISO 8601 format. string
CreatedBefore
optional
A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in ISO 8601 format. string

# OrderList

A list of orders.

Type : < Order > array

# Order

Order information.

Name Description Schema
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 of the first item in the order. string
OrderChannel
optional
The order channel of the first item in the order. string
ShipServiceLevel
optional
The shipment service level of the order. 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 Cash On Delivery (COD) and Convenience Store (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 of the order.

Possible values: Expedited, FreeEconomy, NextDay, SameDay, SecondDay, Scheduled, Standard.
string
EasyShipShipmentStatus
optional
The status of the Amazon Easy Ship order. This property is included only for Amazon Easy Ship orders.

Possible values: PendingPickUp, LabelCanceled, PickedUp, OutForDelivery, Damaged, Delivered, RejectedByBuyer, Undeliverable, ReturnedToSeller, ReturningToSeller.
string
CbaDisplayableShippingLabel
optional
Custom ship label for Checkout by Amazon (CBA). string
OrderType
optional
The type of the order. 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. Returned only 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. Returned only 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. Returned only 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. Returned only 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, see "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. Returned only for Sourcing on Demand orders. string
IsEstimatedShipDateSet
optional
When true, the estimated ship date is set for the order. Returned only 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. Available only in the TR marketplace. enum (BuyerInvoicePreference)
BuyerTaxInformation
optional
Contains the business invoice tax information. BuyerTaxInformation
FulfillmentInstruction
optional
Contains the instructions about the fulfillment like where should it be fulfilled from. 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. MarketplaceTaxInfo
SellerDisplayName
optional
The seller’s friendly name registered in the marketplace. string
ShippingAddress
optional
The shipping address for the order. Address
BuyerInfo
optional
Buyer information. 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

# OrderBuyerInfo

Buyer information for an order.

Name Description Schema
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 name of the buyer. string
BuyerCounty
optional
The county of the buyer. string
BuyerTaxInfo
optional
Tax information about the buyer. BuyerTaxInfo
PurchaseOrderNumber
optional
The purchase order (PO) number entered by the buyer at checkout. Returned only for orders where the buyer entered a PO number at checkout. string

# OrderRegulatedInfo

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

Name Description Schema
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.

Name Description Schema
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

# RejectionReason

The reason for rejecting the order's regulated information. Not present if the order isn't rejected.

Name Description Schema
RejectionReasonId
required
The unique identifier for the rejection reason. string
RejectionReasonDescription
required
The description of this rejection reason. string

# VerificationStatus

The verification status of the order.

Type : enum

Value Description
Pending The order is pending approval. Note that the approval might be needed from someone other than the merchant as determined by the RequiresMerchantAction property.
Approved The order's regulated information has been reviewed and approved.
Rejected The order's regulated information has been reviewed and rejected.
Expired The time to review the order's regulated information has expired.
Cancelled The order was cancelled by the purchaser.

# RegulatedInformation

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

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

# RegulatedInformationField

A field collected from the regulatory form.

Name Description Schema
FieldId
required
The unique identifier for the field. string
FieldLabel
required
The name for 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 will contain a URL to download the attachment here. string

# OrderAddress

The shipping address for the order.

Name Description Schema
AmazonOrderId
required
An Amazon-defined order identifier, in 3-7-7 format. string
ShippingAddress
optional
The shipping address for the order. Address

# Address

The shipping address for the order.

Name Description Schema
Name
required
The name. 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. Not returned for Fulfillment by Amazon (FBA) orders. string
AddressType
optional
The address type of the shipping address. enum (AddressType)

# Money

The monetary value of the order.

Name Description Schema
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.

Name Description Schema
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.
  • string

    # BuyerTaxInfo

    Tax information about the buyer.

    Name Description Schema
    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.

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

    # TaxClassification

    The tax classification for the order.

    Name Description Schema
    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.

    Name Description Schema
    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.

    Name Description Schema
    ASIN
    required
    The Amazon Standard Identification Number (ASIN) of the item. string
    SellerSKU
    optional
    The seller stock keeping unit (SKU) of the item. string
    OrderItemId
    required
    An Amazon-defined order item identifier. string
    Title
    optional
    The name of the item. string
    QuantityOrdered
    required
    The number of items in the order. integer
    QuantityShipped
    optional
    The number of items shipped. integer
    ProductInfo
    optional
    Product information for the item. 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. Note that ItemPrice excludes ShippingPrice and GiftWrapPrice. Money
    ShippingPrice
    optional
    The shipping price of the item. 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
    When true, the item is a gift. boolean
    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, 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, Other.
    string
    ScheduledDeliveryStartDate
    optional
    The start date of the scheduled delivery window in the time zone of the order destination. In ISO 8601 date time format. string
    ScheduledDeliveryEndDate
    optional
    The end date of the scheduled delivery window in the time zone of the order destination. In ISO 8601 date time format. string
    PriceDesignation
    optional
    Indicates that the selling price is a special price that is available only for Amazon Business orders. For more information about the Amazon Business Seller Program, see the Amazon Business website (opens new window).

    Possible values: BusinessPrice - A special price that is available only for Amazon Business orders.
    string
    TaxCollection
    optional
    Information about withheld taxes. TaxCollection
    SerialNumberRequired
    optional
    When true, the product type for this item has a serial number.

    Returned only for Amazon Easy Ship orders.
    boolean
    IsTransparency
    optional
    When true, transparency codes are required. boolean
    IossNumber
    optional
    The IOSS number for the marketplace. Sellers shipping to the European Union (EU) from outside of 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. ItemBuyerInfo
    BuyerRequestedCancel
    optional
    Information about whether or not a buyer requested cancellation. BuyerRequestedCancel

    # OrderItemsBuyerInfoList

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

    Name Description Schema
    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.

    Name Description Schema
    OrderItemId
    required
    An Amazon-defined order item identifier. string
    BuyerCustomizedInfo
    optional
    Buyer information for custom orders from the Amazon Custom program. 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. 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.

    Name Description Schema
    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.

    Name Description Schema
    NumberOfItems
    optional
    The total number of items that are included in the ASIN. integer

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

    Name Description Schema
    CustomizedURL
    optional
    The location of a zip file containing Amazon Custom data. string

    # TaxCollection

    Information about withheld taxes.

    Name Description Schema
    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.

    Name Description Schema
    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 like where should it be fulfilled from.

    Name Description Schema
    FulfillmentSupplySourceId
    optional
    Denotes the recommended sourceId where the order should be fulfilled from. string

    # BuyerInfo

    Buyer information.

    Name Description Schema
    BuyerEmail
    optional
    The anonymized email address of the buyer. string
    BuyerName
    optional
    The name of the buyer. string
    BuyerCounty
    optional
    The county of the buyer. string
    BuyerTaxInfo
    optional
    Tax information about the buyer. BuyerTaxInfo
    PurchaseOrderNumber
    optional
    The purchase order (PO) number entered by the buyer at checkout. Returned only for orders where the buyer entered a PO number at checkout. string

    # ItemBuyerInfo

    A single item's buyer information.

    Name Description Schema
    BuyerCustomizedInfo
    optional
    Buyer information for custom orders from the Amazon Custom program. 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. 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.

    Name Description Schema
    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.

    Name Description Schema
    IsBuyerRequestedCancel
    optional
    When true, the buyer has requested cancellation. boolean
    BuyerCancelReason
    optional
    The reason that the buyer requested cancellation. 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.

    Name Description Schema
    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. Available only in the TR marketplace.

    Type : enum

    Value Description
    INDIVIDUAL Buyer should be issued an individual invoice.
    BUSINESS Buyer should be issued a business invoice. Tax information is available in BuyerTaxInformation structure.

    # OrderStatus

    The current order status.

    Type : enum

    Value Description
    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 of the item is in the future. The order is not ready for shipment.

    # OrderType

    The type of the order.

    Type : enum

    Value Description
    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.

    # Model

    The tax collection model applied to the item.

    Type : enum

    Value Description
    MarketplaceFacilitator Tax 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 Cash On Delivery (COD) and Convenience Store (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

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

    # AddressType

    The address type of the shipping address.

    Type : enum

    Value Description
    Residential The shipping address is a residential address.
    Commercial The shipping address is a commercial address.

    # ResponsibleParty

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

    Type : enum

    Value Description
    Amazon Services, Inc. Amazon Services, Inc.

    # FulfillmentChannel

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

    Type : enum

    Value Description
    MFN Fulfilled by the seller.
    AFN Fulfilled by Amazon.

    # FieldType

    The type of field.

    Type : enum

    Value Description
    Text This field is a text representation of a response collected from the regulatory form.
    FileAttachment This field contains the link to an attachment collected from the regulatory form.

    # 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

    Value Description
    IOSS Import one stop shop. The item being purchased is not held in the EU for shipment.
    UOSS Union one stop shop. The item being purchased is held in the EU for shipment.
    Last Updated: 10/11/2022, 9:45:34 PM