---
title: "getPurchaseOrders"
method: GET
path: "/vendor/orders/v1/purchaseOrders"
tags: ["Vendor Orders v1"]
---

# getPurchaseOrders

`GET /vendor/orders/v1/purchaseOrders`

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 |
| ---- | ---- |
| 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

## Query parameters

- `limit` integer
- `createdAfter` string, date-time
- `createdBefore` string, date-time
- `sortOrder` 'ASC' | 'DESC'
- `nextToken` string
- `includeDetails` string, boolean
- `changedAfter` string, date-time
- `changedBefore` string, date-time
- `poItemState` 'Cancelled'
- `isPOChanged` string, boolean
- `purchaseOrderState` 'New' | 'Acknowledged' | 'Closed'
- `orderingVendorCode` string

## Response `200`

Success.

- GetPurchaseOrdersResponse — The response schema for the getPurchaseOrders operation.
  - `payload` OrderList — A list of orders returned as response.
    - `pagination` Pagination — The pagination elements required to retrieve the remaining data.
      - `nextToken` string — A generated string used to pass information to your next request. If NextToken is returned, pass the value of NextToken to the next request. If NextToken is not returned, there are no more shipment items to return.
    - `orders` Order[] — Represents an individual order within the OrderList.
      - `purchaseOrderNumber` string, required — The purchase order number for this order. Formatting Notes: 8-character alpha-numeric code.
      - `purchaseOrderState` 'New' | 'Acknowledged' | 'Closed', required — This field will contain the current state of the purchase order.
      - `orderDetails` OrderDetails — Details of an order.
        - `purchaseOrderDate` string, date-time, required — The date the purchase order was placed. Must be in ISO-8601 date/time format.
        - `purchaseOrderChangedDate` string, date-time — The date when purchase order was last changed by Amazon after the order was placed. This date will be greater than 'purchaseOrderDate'. This means the PO data was changed on that date and vendors are required to fulfill the updated PO. The PO changes can be related to Item Quantity, Ship to Location, Ship Window etc. This field will not be present in orders that have not changed after creation. Must be in ISO-8601 date/time format.
        - `purchaseOrderStateChangedDate` string, date-time, required — The date when current purchase order state was changed. Current purchase order state is available in the field 'purchaseOrderState'. Must be in ISO-8601 date/time format.
        - `purchaseOrderType` 'RegularOrder' | 'ConsignedOrder' | 'NewProductIntroduction' | 'RushOrder' — Type of purchase order.
        - `importDetails` ImportDetails — Provide these fields only if this shipment is a direct import.
          - `methodOfPayment` 'PaidByBuyer' | 'CollectOnDelivery' | 'DefinedByBuyerAndSeller' | 'FOBPortOfCall' | 'PrepaidBySeller' | 'PaidBySeller' — This is used for import purchase orders only. If the recipient requests, this field will contain the shipment method of payment.
          - `sealNumber` string — The container's seal number.
          - `route` Route — This is used only for direct import shipment confirmations.
            - `stops` Stop[], required — The port or location involved in transporting the cargo, as specified in transportation contracts or operational plans.
              - …
          - `importContainers` string — Types and numbers of container(s) for import purchase orders. Can be a comma-separated list if shipment has multiple containers.
          - `billableWeight` Weight — The weight of the shipment.
            - `unitOfMeasure` 'G' | 'Kg' | 'Oz' | 'Lb', required — The unit of measurement.
            - `value` string, required — A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation. <br>**Pattern** : `^-?(0|([1-9]\d*))(\.\d+)?([eE][+-]?\d+)?$`.
          - `estimatedShipByDate` string, date-time — Date on which the shipment is expected to be shipped. This value should not be in the past and not more than 60 days out in the future.
          - `handlingInstructions` 'Oversized' | 'Fragile' | 'Food' | 'HandleWithCare' — Identification of the instructions on how specified item/carton/pallet should be handled.
        - `dealCode` string — If requested by the recipient, this field will contain a promotional/deal number. The discount code line is optional. It is used to obtain a price discount on items on the order.
        - `paymentMethod` 'Invoice' | 'Consignment' | 'CreditCard' | 'Prepaid' — Payment method used.
        - `buyingParty` PartyIdentification — Name/Address and tax details of the party.
          - `address` Address — Address of the party.
            - `name` string, required — The name of the person, business or institution at that address.
            - `addressLine1` string, required — First line of the address.
            - `addressLine2` string — Additional street address information, if required.
            - `addressLine3` string — Additional street address information, if required.
            - `city` string — The city where the person, business or institution is located.
            - `county` string — The county where person, business or institution is located.
            - `district` string — The district where person, business or institution is located.
            - `stateOrRegion` string — The state or region where person, business or institution is located.
            - `postalCode` string — The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
            - `countryCode` string, required — The two digit country code in ISO 3166-1 alpha-2 format.
            - `phone` string — The phone number of the person, business or institution located at that address.
          - `partyId` string, required — Assigned identification for the party.
          - `taxRegistrationDetails` TaxRegistrationDetails[] — Tax registration details of the entity.
            - `taxRegistrationType` 'VAT' | 'GST', required — Tax registration type for the entity.
            - `taxRegistrationNumber` string, required — Tax registration number for the entity. For example, VAT ID.
        - `sellingParty` PartyIdentification — Name/Address and tax details of the party.
          - `address` Address — Address of the party.
            - `name` string, required — The name of the person, business or institution at that address.
            - `addressLine1` string, required — First line of the address.
            - `addressLine2` string — Additional street address information, if required.
            - `addressLine3` string — Additional street address information, if required.
            - `city` string — The city where the person, business or institution is located.
            - `county` string — The county where person, business or institution is located.
            - `district` string — The district where person, business or institution is located.
            - `stateOrRegion` string — The state or region where person, business or institution is located.
            - `postalCode` string — The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
            - `countryCode` string, required — The two digit country code in ISO 3166-1 alpha-2 format.
            - `phone` string — The phone number of the person, business or institution located at that address.
          - `partyId` string, required — Assigned identification for the party.
          - `taxRegistrationDetails` TaxRegistrationDetails[] — Tax registration details of the entity.
            - `taxRegistrationType` 'VAT' | 'GST', required — Tax registration type for the entity.
            - `taxRegistrationNumber` string, required — Tax registration number for the entity. For example, VAT ID.
        - `shipToParty` PartyIdentification — Name/Address and tax details of the party.
          - `address` Address — Address of the party.
            - `name` string, required — The name of the person, business or institution at that address.
            - `addressLine1` string, required — First line of the address.
            - `addressLine2` string — Additional street address information, if required.
            - `addressLine3` string — Additional street address information, if required.
            - `city` string — The city where the person, business or institution is located.
            - `county` string — The county where person, business or institution is located.
            - `district` string — The district where person, business or institution is located.
            - `stateOrRegion` string — The state or region where person, business or institution is located.
            - `postalCode` string — The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
            - `countryCode` string, required — The two digit country code in ISO 3166-1 alpha-2 format.
            - `phone` string — The phone number of the person, business or institution located at that address.
          - `partyId` string, required — Assigned identification for the party.
          - `taxRegistrationDetails` TaxRegistrationDetails[] — Tax registration details of the entity.
            - `taxRegistrationType` 'VAT' | 'GST', required — Tax registration type for the entity.
            - `taxRegistrationNumber` string, required — Tax registration number for the entity. For example, VAT ID.
        - `billToParty` PartyIdentification — Name/Address and tax details of the party.
          - `address` Address — Address of the party.
            - `name` string, required — The name of the person, business or institution at that address.
            - `addressLine1` string, required — First line of the address.
            - `addressLine2` string — Additional street address information, if required.
            - `addressLine3` string — Additional street address information, if required.
            - `city` string — The city where the person, business or institution is located.
            - `county` string — The county where person, business or institution is located.
            - `district` string — The district where person, business or institution is located.
            - `stateOrRegion` string — The state or region where person, business or institution is located.
            - `postalCode` string — The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
            - `countryCode` string, required — The two digit country code in ISO 3166-1 alpha-2 format.
            - `phone` string — The phone number of the person, business or institution located at that address.
          - `partyId` string, required — Assigned identification for the party.
          - `taxRegistrationDetails` TaxRegistrationDetails[] — Tax registration details of the entity.
            - `taxRegistrationType` 'VAT' | 'GST', required — Tax registration type for the entity.
            - `taxRegistrationNumber` string, required — Tax registration number for the entity. For example, VAT ID.
        - `shipWindow` string — Defines a date time interval according to ISO8601. Interval is separated by double hyphen (--).
        - `deliveryWindow` string — Defines a date time interval according to ISO8601. Interval is separated by double hyphen (--).
        - `items` OrderItem[], required — A list of items in this purchase order.
          - `itemSequenceNumber` string, required — Numbering of the item on the purchase order. The first item will be 1, the second 2, and so on.
          - `amazonProductIdentifier` string — Amazon Standard Identification Number (ASIN) of an item.
          - `vendorProductIdentifier` string — The vendor selected product identification of the item.
          - `orderedQuantity` ItemQuantity, required — Details of item quantity.
            - `amount` integer, required — Amount of units shipped for a specific item at a shipment level. If the item is present only in certain cartons or pallets within the shipment, please provide this at the appropriate carton or pallet level.
            - `unitOfMeasure` 'Cases' | 'Eaches', required — Unit of measure for the shipped quantity.
            - `unitSize` integer — The case size, in the event that we ordered using cases. Otherwise, 1.
            - `totalWeight` TotalWeight — The total weight of units that are sold by weight in a shipment.
              - …
          - `isBackOrderAllowed` boolean, required — When true, we will accept backorder confirmations for this item.
          - `netCost` Money — An amount of money, including units in the form of currency.
            - `currencyCode` string, required — Three digit currency code in ISO 4217 format.
            - `amount` string, required — A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation. <br>**Pattern** : `^-?(0|([1-9]\d*))(\.\d+)?([eE][+-]?\d+)?$`.
          - `listPrice` Money — An amount of money, including units in the form of currency.
            - `currencyCode` string, required — Three digit currency code in ISO 4217 format.
            - `amount` string, required — A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation. <br>**Pattern** : `^-?(0|([1-9]\d*))(\.\d+)?([eE][+-]?\d+)?$`.
  - `errors` Error[] — A list of error responses returned when a request is unsuccessful.
    - `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.

## Other responses

- `400` — Request has missing or invalid parameters and cannot be parsed.
- `403` — Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
- `404` — The resource specified does not exist.
- `415` — The request payload is in an unsupported format.
- `429` — The frequency of requests was greater than allowed.
- `500` — An unexpected condition occurred that prevented the server from fulfilling the request.
- `503` — Temporary overloading or maintenance of the server.

---

[API](https://skmtc.net/aws-samples/apis/a-content-management-v2020-11-01.md) · [All operations](https://skmtc.net/aws-samples/apis/a-content-management-v2020-11-01/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws-samples/a-content-management-v2020-11-01/revisions/815a5b6dbaa6/schema)