"description":"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.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `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, 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).",
"description":"Purchase orders that became available after this time will be included in the result. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format.",
"description":"Purchase orders that became available before this time will be included in the result. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format.",
"description":"Sort in ascending or descending order by purchase order creation date.",
"required":false,
"type":"string",
"enum":[
"ASC",
"DESC"
],
"x-docgen-enum-table-extension":[
{
"value":"ASC",
"description":"Sort in ascending order by purchase order creation date."
},
{
"value":"DESC",
"description":"Sort in descending order by purchase order creation date."
}
]
},
{
"name":"nextToken",
"in":"query",
"description":"Used for pagination when there is more purchase orders than the specified result size limit. The token value is returned in the previous API call",
"description":"When `true`, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is `true`.",
"description":"Purchase orders that changed after this timestamp will be included in the result. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format.",
"description":"Purchase orders that changed before this timestamp will be included in the result. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format.",
"description":"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.",
"description":"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`.",
"description":"Filters purchase orders based on the purchase order state.",
"required":false,
"type":"string",
"enum":[
"New",
"Acknowledged",
"Closed"
],
"x-docgen-enum-table-extension":[
{
"value":"New",
"description":"Status of the orders that are newly created."
},
{
"value":"Acknowledged",
"description":"Status of the orders acknowledged by vendors."
},
{
"value":"Closed",
"description":"Status of the orders that are completed."
}
]
},
{
"name":"orderingVendorCode",
"in":"query",
"description":"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.",
"shippingInstructions":"PREFERENCE IS PALLET-LOAD, BUT IF CONTAINERS ARE FLOOR-LOADED, THEN PLEASE DO CLAMP-LOAD OR STRAIGHT FLOOR-LOAD. DO NOT USE SLIP SHEET FOR THIS FC DESTINATION. PAYMENT TERMS ARE PER CONTAINER."
"description":"Indicates that access to the resource is forbidden. Possible reasons include `Access Denied`, `Unauthorized`, `Expired Token`, or `Invalid Signature`.",
"description":"Returns a purchase order based on the `purchaseOrderNumber` value that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `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, 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).",
"description":"Indicates that access to the resource is forbidden. Possible reasons include `Access Denied`, `Unauthorized`, `Expired Token`, or `Invalid Signature`.",
"description":"Submits acknowledgements for one or more purchase orders.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `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, 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).",
"description":"Indicates that access to the resource is forbidden. Possible reasons include `Access Denied`, `Unauthorized,` `Expired Token`, or `Invalid Signature`.",
"description":"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.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `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, 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).",
"description":"Purchase orders that became available after this timestamp will be included in the result. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format.",
"description":"Purchase orders that became available before this timestamp will be included in the result. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format.",
"description":"Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format.",
"description":"Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format.",
"description":"Provides purchase order status for the specified purchase order number.",
"required":false,
"type":"string"
},
{
"name":"purchaseOrderStatus",
"in":"query",
"description":"Filters purchase orders based on the specified purchase order status. If not included in filter, this will return purchase orders for all statuses.",
"required":false,
"type":"string",
"enum":[
"OPEN",
"CLOSED"
],
"x-docgen-enum-table-extension":[
{
"value":"OPEN",
"description":"Buyer has not yet received all of the items in the purchase order."
},
{
"value":"CLOSED",
"description":"Buyer has received all of the items in the purchase order."
"description":"Filters purchase orders based on their item confirmation status. If the item confirmation status is not included in the filter, purchase orders for all confirmation statuses are included.",
"description":"Provides a list of orders that has at least one item yet to be confirmed by vendors."
}
]
},
{
"name":"itemReceiveStatus",
"in":"query",
"description":"Filters purchase orders based on the purchase order's item receive status. If the item receive status is not included in the filter, purchase orders for all receive statuses are included.",
"required":false,
"type":"string",
"enum":[
"NOT_RECEIVED",
"PARTIALLY_RECEIVED",
"RECEIVED"
],
"x-docgen-enum-table-extension":[
{
"value":"NOT_RECEIVED",
"description":"Provides a list of orders that have at least one item not received by the buyer."
},
{
"value":"PARTIALLY_RECEIVED",
"description":"Provides a list of orders that have at least one item not received by the buyer."
},
{
"value":"RECEIVED",
"description":"Provides a list of orders that have at least one item fully received by the buyer."
"description":"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 filter, all purchase orders for all the vendor codes that exist in the vendor group used to authorize API client application are returned.",
"required":false,
"type":"string"
},
{
"name":"shipToPartyId",
"in":"query",
"description":"Filters purchase orders for a specific buyer's Fulfillment Center/warehouse by providing ship to location id here. This value should be same as 'shipToParty.partyId' in the purchase order. If not included in filter, this will return purchase orders for all the buyer's warehouses used for vendor group purchase orders.",
"description":"Indicates that access to the resource is forbidden. Possible reasons include `Access Denied`, `Unauthorized`, `Expired Token`, or `Invalid Signature`.",
"description":"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 purchase order items to return."
"description":"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."
"description":"The date the purchase order was placed. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format."
"description":"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 <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format."
"description":"The date when current purchase order state was changed. Current purchase order state is available in the field 'purchaseOrderState'. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format."
"description":"A regular purchase order is a method for placing orders for a one-time purchase and payment for line item goods that have a specific quantity and unit price."
},
{
"value":"ConsignedOrder",
"description":"A consignment purchase order is an agreement with a vendor that allows the product to be received, but the inventory still belong to the vendor until the product is used."
},
{
"value":"NewProductIntroduction",
"description":"A purchase order where a new product is introduced."
},
{
"value":"RushOrder",
"description":"Rush orders are purchases of goods that need to be processed and delivered by a certain date that is much sooner than the standard arrival date."
}
]
},
"importDetails":{
"description":"If the purchase order is an import order, the details for the import order.",
"$ref":"#/definitions/ImportDetails"
},
"dealCode":{
"type":"string",
"description":"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":{
"type":"string",
"description":"Payment method used.",
"enum":[
"Invoice",
"Consignment",
"CreditCard",
"Prepaid"
],
"x-docgen-enum-table-extension":[
{
"value":"Invoice",
"description":"An invoice payment is submitted by a business to pay for products and services purchased from vendors."
},
{
"value":"Consignment",
"description":"A retail merchandiser acts as a consignor for goods supplied by the consignee. The consignor pays the consignee after the sale and keeps a percentage of the proceeds"
},
{
"value":"CreditCard",
"description":"Payment is made using a credit card."
},
{
"value":"Prepaid",
"description":"Payment is prepaid."
}
]
},
"buyingParty":{
"description":"Name/Address and tax details of the buying party.",
"$ref":"#/definitions/PartyIdentification"
},
"sellingParty":{
"description":"Name/Address and tax details of the selling party.",
"description":"Name/Address and tax details of the ship to party. Find a list of fulfillment center addresses for a region on the [Resources page of Amazon Vendor Central](https://vendorcentral.amazon.com/hz/vendor/members/support/help/node/GPZ88XH8HQM97ZV6).",
"description":"Name/Address and tax details of the bill to party.",
"$ref":"#/definitions/PartyIdentification"
},
"shipWindow":{
"description":"This indicates the ship window. Format is start and end date separated by double hyphen (--). For example, 2007-03-01T13:00:00Z--2007-03-11T15:30:00Z.",
"$ref":"#/definitions/DateTimeInterval"
},
"deliveryWindow":{
"description":"This indicates the delivery window. Format is start and end date separated by double hyphen (--). For example, 2007-03-01T13:00:00Z--2007-03-11T15:30:00Z.",
"$ref":"#/definitions/DateTimeInterval"
},
"items":{
"type":"array",
"description":"A list of items in this purchase order.",
"items":{
"$ref":"#/definitions/OrderItem"
}
}
},
"description":"Details of an order."
},
"ImportDetails":{
"type":"object",
"properties":{
"methodOfPayment":{
"type":"string",
"description":"If the recipient requests, contains the shipment method of payment. This is for import PO's only.",
"enum":[
"PaidByBuyer",
"CollectOnDelivery",
"DefinedByBuyerAndSeller",
"FOBPortOfCall",
"PrepaidBySeller",
"PaidBySeller"
],
"x-docgen-enum-table-extension":[
{
"value":"PaidByBuyer",
"description":"Buyer pays for shipping."
},
{
"value":"CollectOnDelivery",
"description":"Buyer pays for shipping on delivery."
},
{
"value":"DefinedByBuyerAndSeller",
"description":"Shipping costs paid as agreed upon between buyer and seller."
},
{
"value":"FOBPortOfCall",
"description":"Seller pays for transportation including loading and shipping."
},
{
"value":"PrepaidBySeller",
"description":"Seller prepays for shipping."
},
{
"value":"PaidBySeller",
"description":"Seller pays for shipping."
}
]
},
"internationalCommercialTerms":{
"type":"string",
"description":"Incoterms (International Commercial Terms) are used to divide transaction costs and responsibilities between buyer and seller and reflect state-of-the-art transportation practices. This is for import purchase orders only. ",
"enum":[
"ExWorks",
"FreeCarrier",
"FreeOnBoard",
"FreeAlongSideShip",
"CarriagePaidTo",
"CostAndFreight",
"CarriageAndInsurancePaidTo",
"CostInsuranceAndFreight",
"DeliveredAtTerminal",
"DeliveredAtPlace",
"DeliverDutyPaid"
],
"x-docgen-enum-table-extension":[
{
"value":"ExWorks",
"description":"Places the maximum obligation on the buyer and minimum obligations on the seller. The seller makes the goods available at its premises. The buyer is responsible for all costs of the transportation of the shipment and bears all the risks for bringing the goods to their final destination."
},
{
"value":"FreeCarrier",
"description":"The seller hands over the goods, cleared for export, into the disposal of the carrier (named by the buyer). The buyer pays for all the additional costs of transportation and risk passes when the goods are handed over to the carrier."
},
{
"value":"FreeOnBoard",
"description":"Ocean shipments only. The seller must deliver the goods alongside the ship at the named port, and clear the goods for export. The buyer pays for all the additional costs of transportation and risk passes when the goods are alongside the ship."
},
{
"value":"FreeAlongSideShip",
"description":"Ocean shipments only. The seller must load the goods on board the vessel, cleared for export. The buyer pays for all the additional costs of transportation and risk passes when the goods are loaded on the ship."
},
{
"value":"CarriagePaidTo",
"description":"The seller pays for transportation to the named port of destination, but risk transfers to the buyer upon handing goods over to the first carrier. The buyer pays for all destination charges."
},
{
"value":"CostAndFreight",
"description":"Ocean shipments only. Seller pays for transportation to the named port of destination, but risk transfers to the buyer once the goods are loaded on the vessel. The buyer pays for all destination charges."
},
{
"value":"CarriageAndInsurancePaidTo",
"description":"Seller pays for transportation and insurance to the named port of destination, but risk transfers to the buyer upon handing goods over to the first carrier. The buyer pays for all destination charges."
},
{
"value":"CostInsuranceAndFreight",
"description":"Ocean shipments only. Seller pays for transportation and insurance to the named port of destination, but risk transfers to the buyer once the goods are loaded on the vessel. The buyer pays for all destination charges."
},
{
"value":"DeliveredAtTerminal",
"description":"Seller pays for transportation up to the destination terminal, and risks up to the point that the goods are unloaded at the terminal. The buyer pays for import clearance, duties & taxes and delivery costs."
},
{
"value":"DeliveredAtPlace",
"description":"Seller pays for transportation to the named destination, and risk transfers at the point that the goods are ready for unloading by the buyer. The buyer pays for import clearance, duties & taxes and delivery costs."
},
{
"value":"DeliverDutyPaid",
"description":"Seller is responsible for delivering the goods to the named place in the country of the buyer, and pays all costs in bringing the goods to the destination including import duties and taxes. This term places the maximum obligations on the seller and minimum obligations on the buyer."
"description":"The port where goods on an import purchase order must be delivered by the vendor. This should only be specified when the `internationalCommercialTerms` is `FOB`.",
"description":"Types and numbers of container(s) for import purchase orders. Can be a comma-separated list if the shipment has multiple containers. HC signifies a high-capacity container. Free-text field, limited to 64 characters. The format will be a comma-delimited list containing values of the type: `$NUMBER_OF_CONTAINERS_OF_THIS_TYPE-$CONTAINER_TYPE`. The list of values for the container type is: `40'`(40-foot container), `40'HC` (40-foot high-capacity container), `45'`, `45'HC`, `30'`, `30'HC`, `20'`, `20'HC`.",
"description":"Defines a date time interval according to <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a>. Interval is separated by double hyphen (--)."
"description":"Three digit currency code in ISO 4217 format. String of length 3.",
"maxLength":3
},
"amount":{
"$ref":"#/definitions/Decimal"
}
},
"description":"An amount of money, including units in the form of currency."
},
"Decimal":{
"type":"string",
"description":"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+)?$`."
"description":"GUID assigned by Amazon to identify this transaction. This value can be used with the Transaction Status API to return the status of this transaction."
"description":"The date and time when the purchase order is acknowledged, in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format."
"description":"Represents an acknowledgement for an order, including the purchase order number, selling party details, acknowledgement date, and a list of acknowledged items."
"description":"Line item sequence number for the item."
},
"amazonProductIdentifier":{
"type":"string",
"description":"Amazon Standard Identification Number (ASIN) of an item."
},
"vendorProductIdentifier":{
"type":"string",
"description":"The vendor selected product identification of the item. Should be the same as was sent in the purchase order."
},
"orderedQuantity":{
"description":"The quantity of this item ordered.",
"$ref":"#/definitions/ItemQuantity"
},
"netCost":{
"description":"The cost to Amazon, which should match the cost on the invoice. This is a required field. If this is left blank the file will reject in Amazon systems. Price information should not be zero or negative. Indicates a net unit price.",
"$ref":"#/definitions/Money"
},
"listPrice":{
"description":"The list price. This is required only if a vendor sells books with a list price.",
"$ref":"#/definitions/Money"
},
"discountMultiplier":{
"type":"string",
"description":"The discount multiplier that should be applied to the price if a vendor sells books with a list price. This is a multiplier factor to arrive at a final discounted price. A multiplier of .90 would be the factor if a 10% discount is given."
},
"itemAcknowledgements":{
"type":"array",
"description":"This is used to indicate acknowledged quantity.",
"items":{
"$ref":"#/definitions/OrderItemAcknowledgement"
}
}
},
"description":"Details of the item being acknowledged."
},
"OrderItemAcknowledgement":{
"type":"object",
"required":[
"acknowledgedQuantity",
"acknowledgementCode"
],
"properties":{
"acknowledgementCode":{
"type":"string",
"description":"This indicates the acknowledgement code.",
"enum":[
"Accepted",
"Backordered",
"Rejected"
],
"x-docgen-enum-table-extension":[
{
"value":"Accepted",
"description":"Vendor accepts to fulfill the order item(s)."
"description":"Vendor placed a backorder to fulfill the original order and provides a `scheduledShipDate` or `scheduledDeliveryDate` which is different than the `expectedShipDate` or `expectedDeliveryDate` provided in the purchase order."
"description":"Estimated ship date per line item. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format."
"description":"Estimated delivery date per line item. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format."
"description":"Represents the acknowledgement details for an individual order item, including the acknowledgement code, acknowledged quantity, scheduled ship and delivery dates, and rejection reason (if applicable)."
"description":"The date the purchase order was placed. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format."
"description":"The date when the purchase order was last updated. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format."
"description":"Name/Address and tax details of the ship to party. Find a list of fulfillment center addresses for a region on the [Resources page of Amazon Vendor Central](https://vendorcentral.amazon.com/hz/vendor/members/support/help/node/GPZ88XH8HQM97ZV6).",
"description":"The date when the most recent item was received at the buyer's warehouse. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format."
"description":"The date when the line item quantity was updated by the buyer. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format."
"description":"The date when the line item was confirmed by the vendor. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format."