getPurchaseOrder

get https://sellingpartnerapi-na.amazon.com/vendor/orders/v1/purchaseOrders/{purchaseOrderNumber}

Returns a purchase order based on the purchaseOrderNumber value that you specify.

Usage Plan:

Rate (requests per second)	Burst
10	10

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.

Responses

Response body

object

payload

object

Represents an order placed by Amazon, including the purchase order number, current state, and order details.

purchaseOrderNumber

string

required

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

purchaseOrderState

string

required

This field will contain the current state of the purchase order.

New Acknowledged Closed

Show Details

New	The purchase order is newly created and needs to be acknowledged by vendor.
Acknowledged	The purchase order has been acknowledged by vendor.
Closed	The purchase order is closed and no further action is required from the vendor. PO can be in closed state for many reasons such as order is rejected by vendor, order is cancelled by Amazon or order is fully received by Amazon.

orderDetails

object

Details of an order.

errors

array of objects

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

errors

object

code

string

required

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

message

string

required

A message that describes the error condition.

details

string

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

Headers

object

x-amzn-RateLimit-Limit

string

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

x-amzn-RequestId

string

Unique request reference identifier.

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://sellingpartnerapi-na.amazon.com/vendor/orders/v1/purchaseOrders/purchaseOrderNumber \
3
     --header 'accept: application/json'


xxxxxxxxxx
46
}
1
{
2
  "payload": {
3
    "purchaseOrderNumber": "TestPO3",
4
    "purchaseOrderState": "New",
5
    "orderDetails": {
6
      "purchaseOrderDate": "2020-05-26T18:05:23Z",
7
      "purchaseOrderStateChangedDate": "2020-05-26T18:05:23Z",
8
      "purchaseOrderType": "RegularOrder",
9
      "paymentMethod": "Invoice",
10
      "buyingParty": {
11
        "partyId": "ABCF"
12
      },
13
      "sellingParty": {
14
        "partyId": "API01"
15
      },
16
      "shipToParty": {
17
        "partyId": "ABCF"
18
      },
19
      "billToParty": {
20
        "partyId": "ABCF"
21
      },
22
      "shipWindow": "2020-05-26T07:00:00Z--2020-06-03T07:00:00Z",
23
      "items": [
24
        {
25
          "itemSequenceNumber": "1",

200Success.

400Request has missing or invalid parameters and cannot be parsed.

401The request's Authorization header is not formatted correctly or does not contain a valid token.

403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

404The resource specified does not exist.

415The request payload is in an unsupported format.

429The frequency of requests was greater than allowed.

500An unexpected condition occurred that prevented the server from fulfilling the request.

503Temporary overloading or maintenance of the server.