VendorOrders
The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data.
Select
The driver will use the Amazon Marketplace API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the driver.
- PurchaseOrderNumber supports the '=' comparison.
- PurchaseOrderState supports the '='comparison.
- PurchaseOrderDate supports the '<', '>' comparisons and ORDER BY clause.
- PurchaseOrderChangedDate supports the '<', '>' comparisons.
- SellerPartyId supports the '=' comparison.
Following are example queries which are processed server side:
SELECT * FROM VendorOrders
SELECT * FROM VendorOrders WHERE PurchaseOrderNumber = '123456789'
SELECT * FROM VendorOrders WHERE PurchaseOrderState = 'New'
SELECT * FROM VendorOrders ORDER BY PurchaseOrderDate DESC
SELECT * FROM VendorOrders WHERE PurchaseOrderDate > '2022-06-01T12:00:00' AND PurchaseOrderDate < '2022-06-10T12:00:00'
SELECT * FROM VendorOrders WHERE PurchaseOrderChangedDate > '2022-06-01T12:00:00' AND PurchaseOrderChangedDate < '2022-06-10T12:00:00'
SELECT * FROM VendorOrders WHERE SellerPartyId = '123456789'
Columns
| Name | Type | References | Description |
| PurchaseOrderNumber | String | The purchase order number for this order. | |
| PurchaseOrderState | String | The current state of the purchase order.
The allowed values are New, Acknowledged, Closed. | |
| DealCode | String | If requested by the recipient, this field will contain a promotional/deal number. | |
| DeliveryWindow | String | This indicates the delivery window. Format is start and end date separated by double hyphen (--) | |
| ShipWindow | String | This indicates the ship window. Format is start and end date separated by double hyphen (--). | |
| Items | String | A list of items in this purchase order. | |
| PaymentMethod | String | Payment method used.
The allowed values are Prepaid, CreditCard, Consignment, Invoice. | |
| PurchaseOrderDate | Datetime | The date the purchase order was placed. | |
| PurchaseOrderChangedDate | Datetime | The date when purchase order was last changed by Amazon after the order was placed. | |
| PurchaseOrderStateChangedDate | Datetime | The date when current purchase order state was changed. | |
| PurchaseOrderType | String | Type of purchase order.
The allowed values are RushOrder, NewProductIntroduction, ConsignedOrder, RegularOrder. | |
| BillPartyId | String | Assigned identification for the party. For example, warehouse code or vendor code. | |
| BillAddressAddressLine1 | String | First line of the address. | |
| BillAddressAddressLine2 | String | Additional address information, if required. | |
| BillAddressAddressLine3 | String | Additional address information, if required. | |
| BillAddressCity | String | The city where the person, business or institution is located. | |
| BillAddressCountryCode | String | The two digit country code in ISO 3166-1 alpha-2 format. | |
| BillAddressCounty | String | The county where person, business or institution is located. | |
| BillAddressDistrict | String | The district where person, business or institution is located. | |
| BillAddressName | String | The name of the address of the person, business or institution. | |
| BillAddressPhone | String | The phone number of the person, business or institution located at that address. | |
| BillAddressPostalCode | String | The postal code of that address. It contains a series of letters or digits or both. | |
| BillAddressStateOrRegion | String | The state or region where person, business or institution is located. | |
| BillTaxRegistrationNumber | String | Tax registration number for the entity. For example, VAT ID. | |
| BillTaxRegistrationType | String | Tax registration type for the entity.
The allowed values are VAT, GST. | |
| ShipPartyId | String | Assigned identification for the party. For example, warehouse code or vendor code. | |
| ShipAddressAddressLine1 | String | First line of the address. | |
| ShipAddressAddressLine2 | String | Additional address information, if required. | |
| ShipAddressAddressLine3 | String | Additional address information, if required. | |
| ShipAddressCity | String | The city where the person, business or institution is located. | |
| ShipAddressCountryCode | String | The two digit country code in ISO 3166-1 alpha-2 format. | |
| ShipAddressCounty | String | The county where person, business or institution is located. | |
| ShipAddressDistrict | String | The district where person, business or institution is located. | |
| ShipAddressName | String | The name of the address of the person, business or institution. | |
| ShipAddressPhone | String | The phone number of the person, business or institution located at that address. | |
| ShipAddressPostalCode | String | The postal code of that address. It contains a series of letters or digits or both. | |
| ShipAddressStateOrRegion | String | The state or region where person, business or institution is located. | |
| ShipTaxRegistrationNumber | String | Tax registration number for the entity. For example, VAT ID. | |
| ShipTaxRegistrationType | String | Tax registration type for the entity. | |
| BuyerPartyId | String | Assigned identification for the party. For example, warehouse code or vendor code. | |
| BuyerAddressAddressLine1 | String | First line of the address. | |
| BuyerAddressAddressLine2 | String | Additional address information, if required. | |
| BuyerAddressAddressLine3 | String | Additional address information, if required. | |
| BuyerAddressCity | String | The city where the person, business or institution is located. | |
| BuyerAddressCountryCode | String | The two digit country code in ISO 3166-1 alpha-2 format. | |
| BuyerAddressCounty | String | The county where person, business or institution is located. | |
| BuyerAddressDistrict | String | The district where person, business or institution is located. | |
| BuyerAddressName | String | The name of the address of the person, business or institution. | |
| BuyerAddressPhone | String | The phone number of the person, business or institution located at that address. | |
| BuyerAddressPostalCode | String | The postal code of that address. It contains a series of letters or digits or both. | |
| BuyerAddressStateOrRegion | String | The state or region where person, business or institution is located. | |
| BuyerTaxRegistrationNumber | String | Tax registration number for the entity. For example, VAT ID. | |
| BuyerTaxRegistrationType | String | Tax registration type for the entity. | |
| SellerPartyId | String | Assigned identification for the party. For example, warehouse code or vendor code. | |
| SellerAddressAddressLine1 | String | First line of the address. | |
| SellerAddressAddressLine2 | String | Additional address information, if required. | |
| SellerAddressAddressLine3 | String | Additional address information, if required. | |
| SellerAddressCity | String | The city where the person, business or institution is located. | |
| SellerAddressCountryCode | String | The two digit country code in ISO 3166-1 alpha-2 format. | |
| SellerAddressCounty | String | The county where person, business or institution is located. | |
| SellerAddressDistrict | String | The district where person, business or institution is located. | |
| SellerAddressName | String | The name of the address of the person, business or institution. | |
| SellerAddressPhone | String | The phone number of the person, business or institution located at that address. | |
| SellerAddressPostalCode | String | The postal code of that address. It contains a series of letters or digits or both. | |
| SellerAddressStateOrRegion | String | The state or region where person, business or institution is located. | |
| SellerTaxRegistrationNumber | String | Tax registration number for the entity. For example, VAT ID. | |
| SellerTaxRegistrationType | String | Tax registration type for the entity. | |
| ImportContainers | String | Types and numbers of container(s) for import purchase orders. Can be a comma-separated list if the shipment has multiple containers. | |
| InternationalCommercialTerms | String | Incoterms (International Commercial Terms) are used to divide transaction costs and responsibilities between buyer and seller and reflect state-of-the-art transportation practices. | |
| MethodOfPayment | String | If the recipient requests, contains the shipment method of payment. This is for import PO's only.
The allowed values are PaidBySeller, PrepaidBySeller, FOBPortOfCall, DefinedByBuyerAndSeller, CollectOnDelivery, PaidByBuyer. | |
| PortOfDelivery | String | The port where goods on an import purchase order must be delivered by the vendor. | |
| ShippingInstructions | String | Special instructions regarding the shipment. |