--- title: "getPurchaseOrdersStatus" method: GET path: "/vendor/orders/v1/purchaseOrdersStatus" tags: ["Vendor Orders v1"] --- # getPurchaseOrdersStatus `GET /vendor/orders/v1/purchaseOrdersStatus` Returns purchase order statuses based on the filters that you specify. Date range to search must not be more than 7 days. You can return a list of purchase order statuses using the available filters, or a single purchase order status by providing the purchase order number. **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 - `sortOrder` 'ASC' | 'DESC' - `nextToken` string - `createdAfter` string, date-time - `createdBefore` string, date-time - `updatedAfter` string, date-time - `updatedBefore` string, date-time - `purchaseOrderNumber` string - `purchaseOrderStatus` 'OPEN' | 'CLOSED' - `itemConfirmationStatus` 'ACCEPTED' | 'PARTIALLY_ACCEPTED' | 'REJECTED' | 'UNCONFIRMED' - `itemReceiveStatus` 'NOT_RECEIVED' | 'PARTIALLY_RECEIVED' | 'RECEIVED' - `orderingVendorCode` string - `shipToPartyId` string ## Response `200` Success. - GetPurchaseOrdersStatusResponse — The response schema for the getPurchaseOrdersStatus operation. - `payload` OrderListStatus — A list of order statuses. - `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. - `ordersStatus` OrderStatus[] — Represents an order status within the OrderListStatus. - `purchaseOrderNumber` string, required — The buyer's purchase order number for this order. Formatting Notes: 8-character alpha-numeric code. - `purchaseOrderStatus` 'OPEN' | 'CLOSED', required — The status of the buyer's purchase order for this order. - `purchaseOrderDate` string, date-time, required — The date the purchase order was placed. Must be in ISO-8601 date/time format. - `lastUpdatedDate` string, date-time — The date when the purchase order was last updated. Must be in ISO-8601 date/time format. - `sellingParty` PartyIdentification, required — 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, required — 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. - `itemStatus` OrderItemStatus[], required — Detailed description of items order status. - `itemSequenceNumber` string, required — Numbering of the item on the purchase order. The first item will be 1, the second 2, and so on. - `buyerProductIdentifier` string — Buyer's Standard Identification Number (ASIN) of an item. - `vendorProductIdentifier` string — The vendor selected product identification of the 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.
**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.
**Pattern** : `^-?(0|([1-9]\d*))(\.\d+)?([eE][+-]?\d+)?$`. - `orderedQuantity` object — Ordered quantity information. - `orderedQuantity` ItemQuantity — 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. - … - `orderedQuantityDetails` OrderedQuantityDetails[] — Details of item quantity ordered. - `updatedDate` string, date-time — The date when the line item quantity was updated by buyer. Must be in ISO-8601 date/time format. - `orderedQuantity` ItemQuantity — Details of item quantity. - … - `cancelledQuantity` ItemQuantity — Details of item quantity. - … - `acknowledgementStatus` object — Acknowledgement status information. - `confirmationStatus` 'ACCEPTED' | 'PARTIALLY_ACCEPTED' | 'REJECTED' | 'UNCONFIRMED' — Confirmation status of line item. - `acceptedQuantity` ItemQuantity — 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. - … - `rejectedQuantity` ItemQuantity — 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. - … - `acknowledgementStatusDetails` AcknowledgementStatusDetails[] — Details of item quantity confirmed. - `acknowledgementDate` string, date-time — The date when the line item was confirmed by vendor. Must be in ISO-8601 date/time format. - `acceptedQuantity` ItemQuantity — Details of item quantity. - … - `rejectedQuantity` ItemQuantity — Details of item quantity. - … - `receivingStatus` object — Item receive status at the buyer's warehouse. - `receiveStatus` 'NOT_RECEIVED' | 'PARTIALLY_RECEIVED' | 'RECEIVED' — Receive status of the line item. - `receivedQuantity` ItemQuantity — 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. - … - `lastReceiveDate` string, date-time — The date when the most recent item was received at the buyer's warehouse. Must be in ISO-8601 date/time format. - `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)