HomeDocumentationCode SamplesAPI ReferenceAnnouncementsModelsRelease NotesFAQGitHubVideos
Developer HubAPI StatusSupport
API Reference
Developer HubAPI StatusSupport

getPurchaseOrdersStatus

Returns purchase order statuses based on the filters that you specify. Date range to search must not be more than 7 days. You can return a list of purchase order statuses using the available filters, or a single purchase order status by providing the purchase order number.

Usage Plan:

Rate (requests per second)Burst
1010

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

Query Params
int64
1 to 100

The limit to the number of records returned. Default value is 100 records.

string

Sort in ascending or descending order by purchase order creation date.

string

Used for pagination when there are more purchase orders than the specified result size limit.

date-time

Purchase orders that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format.

date-time

Purchase orders that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format.

date-time

Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in ISO-8601 date/time format.

date-time

Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in ISO-8601 date/time format.

string

Provides purchase order status for the specified purchase order number.

string

Filters purchase orders based on the specified purchase order status. If not included in filter, this will return purchase orders for all statuses.

string

Filters purchase orders based on their item confirmation status. If the item confirmation status is not included in the filter, purchase orders for all confirmation statuses are included.

string

Filters purchase orders based on the purchase order's item receive status. If the item receive status is not included in the filter, purchase orders for all receive statuses are included.

string

Filters purchase orders based on the specified ordering vendor code. This value should be same as 'sellingParty.partyId' in the purchase order. If not included in filter, all purchase orders for all the vendor codes that exist in the vendor group used to authorize API client application are returned.

string

Filters purchase orders for a specific buyer's Fulfillment Center/warehouse by providing ship to location id here. This value should be same as 'shipToParty.partyId' in the purchase order. If not included in filter, this will return purchase orders for all the buyer's warehouses used for vendor group purchase orders.

Responses

Response body
object
payload
object

A list of order statuses.

pagination
object

The pagination elements required to retrieve the remaining data.

ordersStatus
array of objects

Represents an order status within the OrderListStatus.

ordersStatus
object
string
required

The buyer's purchase order number for this order. Formatting Notes: 8-character alpha-numeric code.

string
required

The status of the buyer's purchase order for this order.

OPEN CLOSED

Show Details
OPENBuyer has not yet received all of the items in the purchase order.
CLOSEDBuyer has received all of the items in the purchase order.
date-time
required

The date the purchase order was placed. Must be in ISO-8601 date/time format.

date-time

The date when the purchase order was last updated. Must be in ISO-8601 date/time format.

sellingParty
object
required

Name, address and tax details of a party.

shipToParty
object
required

Name, address and tax details of a party.

itemStatus
array of objects
required

Detailed description of items order status.

itemStatus*
object
string
required

Numbering of the item on the purchase order. The first item will be 1, the second 2, and so on.

string

Buyer's Standard Identification Number (ASIN) of an item.

string

The vendor selected product identification of the item.

netCost
object

An amount of money. Includes the currency code and an optional unit of measure for items priced by weight.

listPrice
object

An amount of money. Includes the currency code and an optional unit of measure for items priced by weight.

orderedQuantity
object

Ordered quantity information.

acknowledgementStatus
object

Acknowledgement status information.

receivingStatus
object

Item receive status at the buyer's warehouse.

errors
array of objects

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

errors
object
string
required

An error code that identifies the type of error that occurred.

string
required

A message that describes the error condition.

string

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

Headers
object
string

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

string

Unique request reference identifier.

Language