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.
[API Help]
| Parameter |
Label |
Required |
Options |
Description |
| CreatedAfter |
CreatedAfter |
NO |
| Option |
Value |
| 2023-12-31 |
2023-12-31 |
| 2023-12-31T00:00:00 |
2023-12-31T00:00:00 |
| now |
now |
| now-24h |
now-24h |
| today |
today |
| yesterday |
yesterday |
| yearstart-10y |
yearstart-10y |
| monthstart |
monthstart |
| monthend |
monthend |
| yearstart |
yearstart |
| yearend |
yearend |
| weekstart |
weekstart |
| weekend |
weekend |
| yearstart-1y |
yearstart-1y |
| yearend-1y |
yearend-1y |
| monthstart-1d |
monthstart-1d |
| monthend+1d |
monthend+1d |
| monthend+1d-1y |
monthend+1d-1y |
|
Purchase orders that became available after this time will be included in the result. Must be in ISO 8601 date/time format. Date format must be UTC - ISO 8601 format (e.g. short date 2017-02-10 -OR- date and time 2017-02-10T12:10:02). If LastUpdatedAfter is not specified. Specifying both CreatedAfter and LastUpdatedAfter returns an error. You can use static values or date functions. Supported functions are now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start)
|
| CreatedBefore |
CreatedBefore |
NO |
| Option |
Value |
| 2023-12-31 |
2023-12-31 |
| 2023-12-31T00:00:00 |
2023-12-31T00:00:00 |
| now |
now |
| now-24h |
now-24h |
| today |
today |
| yesterday |
yesterday |
| yearstart-10y |
yearstart-10y |
| monthstart |
monthstart |
| monthend |
monthend |
| yearstart |
yearstart |
| yearend |
yearend |
| weekstart |
weekstart |
| weekend |
weekend |
| yearstart-1y |
yearstart-1y |
| yearend-1y |
yearend-1y |
| monthstart-1d |
monthstart-1d |
| monthend+1d |
monthend+1d |
| monthend+1d-1y |
monthend+1d-1y |
|
Purchase orders that became available before this time will be included in the result. Must be in ISO 8601 date/time format. Date format must be UTC - ISO 8601 format (e.g. short date 2017-02-10 -OR- date and time 2017-02-10T12:10:02) You can use static values or date functions. Supported functions are now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start)
|
| ChangedAfter |
ChangedAfter |
NO |
| Option |
Value |
| 2023-12-31 |
2023-12-31 |
| 2023-12-31T00:00:00 |
2023-12-31T00:00:00 |
| now |
now |
| now-24h |
now-24h |
| today |
today |
| yesterday |
yesterday |
| yearstart-10y |
yearstart-10y |
| monthstart |
monthstart |
| monthend |
monthend |
| yearstart |
yearstart |
| yearend |
yearend |
| weekstart |
weekstart |
| weekend |
weekend |
| yearstart-1y |
yearstart-1y |
| yearend-1y |
yearend-1y |
| monthstart-1d |
monthstart-1d |
| monthend+1d |
monthend+1d |
| monthend+1d-1y |
monthend+1d-1y |
|
Purchase orders that changed after this timestamp will be included in the result. Must be in ISO 8601 date/time format. Date format must be UTC - ISO 8601 format (e.g. short date 2017-02-10 -OR- date and time 2017-02-10T12:10:02). If CreatedAfter is not specified.Specifying both CreatedAfter and LastUpdatedAfter returns an error.If LastUpdatedAfter is specified, then BuyerEmail and SellerOrderId cannot be specified. You can use static values or date functions. Supported functions are now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start)
|
| ChangedBefore |
ChangedBefore |
NO |
| Option |
Value |
| 2023-12-31 |
2023-12-31 |
| 2023-12-31T00:00:00 |
2023-12-31T00:00:00 |
| now |
now |
| now-24h |
now-24h |
| today |
today |
| yesterday |
yesterday |
| yearstart-10y |
yearstart-10y |
| monthstart |
monthstart |
| monthend |
monthend |
| yearstart |
yearstart |
| yearend |
yearend |
| weekstart |
weekstart |
| weekend |
weekend |
| yearstart-1y |
yearstart-1y |
| yearend-1y |
yearend-1y |
| monthstart-1d |
monthstart-1d |
| monthend+1d |
monthend+1d |
| monthend+1d-1y |
monthend+1d-1y |
|
Purchase orders that changed before this timestamp will be included in the result. Must be in ISO 8601 date/time format. Date format must be UTC - ISO 8601 format (e.g. short date 2017-02-10 -OR- date and time 2017-02-10T12:10:02) You can use static values or date functions. Supported functions are now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start)
|
| IncludeDetails |
IncludeDetails |
NO |
| Option |
Value |
| true |
true |
| false |
false |
|
When true, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is true.
|
| SortOrder |
SortOrder |
NO |
| Option |
Value |
| ASC |
ASC |
| DESC |
DESC |
|
Sort in ascending or descending order by purchase order creation date.
|
| PoItemState |
PoItemState |
NO |
| Option |
Value |
| ACCEPTED |
ACCEPTED |
| PARTIALLY_ACCEPTED |
PARTIALLY_ACCEPTED |
| REJECTED |
REJECTED |
| UNCONFIRMED |
UNCONFIRMED |
|
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.
|
| IsPOChanged |
IsPOChanged |
NO |
| Option |
Value |
| true |
true |
| false |
false |
|
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.
|
| PurchaseOrderState |
PurchaseOrderState |
NO |
| Option |
Value |
| New |
New |
| Acknowledged |
Acknowledged |
| Closed |
Closed |
|
Filters purchase orders based on the purchase order state.
|
| OrderingVendorCode |
OrderingVendorCode |
NO |
|
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.
|
| PageSize |
PageSize |
NO |
|
|
