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

getOrders

Returns a list of purchase orders created during the time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both parameters. You can choose to get only the purchase order numbers by setting the includeDetails parameter to false. In that case, the operation returns a list of purchase order numbers. You can then call the getOrder operation to return the details of a specific 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 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 than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Query Params
string

The vendor warehouse identifier for the fulfillment warehouse. If not specified, the result will contain orders for all warehouses.

string

Returns only the purchase orders that match the specified status. If not specified, the result will contain orders that match any status.

int64
1 to 100

The limit to the number of purchase orders returned.

date-time
required

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

date-time
required

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

string

Sort the list in ascending or descending order by order creation date.

string

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

string
Defaults to true

When true, returns the complete purchase order details. Otherwise, only purchase order numbers are returned.

Responses

Response body
object
payload
object

A list of purchase orders returned as response.

pagination
object

The pagination elements required to retrieve the remaining data.

orders
array of objects

Represents a purchase order within the OrderList.

orders
object
string
required

The purchase order number for this order. Formatting Notes: alpha-numeric code.

orderDetails
object

Details of an order.

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