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

getPurchaseOrders

Returns a list of purchase orders created or changed during the time frame that you specify. You define the time frame using the createdAfter, createdBefore, changedAfter and changedBefore parameters. The date range to search must not be more than 7 days. You can choose to get only the purchase order numbers by setting includeDetails to false. You can then use the getPurchaseOrder operation to receive details for a specific purchase order.

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.

date-time

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

date-time

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

string

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

string

Used for pagination when there is more purchase orders than the specified result size limit. The token value is returned in the previous API call

string

When true, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is true.

date-time

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

date-time

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

string

Current state of the purchase order item. If this value is Cancelled, this API will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as zero.

string

When true, returns purchase orders which were modified after the order was placed. Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the original one. Default value is false.

string

Filters purchase orders based on the purchase order state.

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 the filter, all purchase orders for all of the vendor codes that exist in the vendor group used to authorize the API client application are returned.

Responses

Language
Click Try It! to start a request and see the response here! Or choose an example:
application/json
payload