Vendor Orders API v1 reference

Programmatic access to vendors orders data.

Selling Partner API for Retail Procurement Orders

Overview

The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data.

Version information

Version : v1

Contact information

Contact : Selling Partner API Developer Support
Contact URL : https://sellercentral.amazon.com/gp/mws/contactus.html

License information

License : Apache License 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0

URI scheme

Host : sellingpartnerapi-na.amazon.com
Schemes : HTTPS

Consumes

  • application/json

Produces

  • application/json

Operations

getPurchaseOrders
getPurchaseOrder
submitAcknowledgement
getPurchaseOrdersStatus

Paths

GET /vendor/orders/v1/purchaseOrders

Operation: getPurchaseOrders

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.

Usage Plans:

Plan typeRate (requests per second)Burst
Default1010
Selling partner specificVariableVariable

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
Querylimit
optional
The limit to the number of records returned. Default value is 100 records.
Minimum : 1
Maximum : 100
integer (int64)
QuerycreatedAfter
optional
Purchase orders that became available after this time will be included in the result. Must be in ISO-8601 date/time format.string (date-time)
QuerycreatedBefore
optional
Purchase orders that became available before this time will be included in the result. Must be in ISO-8601 date/time format.string (date-time)
QuerysortOrder
optional
Sort in ascending or descending order by purchase order creation date.enum (SortOrder)
QuerynextToken
optional
Used for pagination when there is more purchase orders than the specified result size limit. The token value is returned in the previous API callstring
QueryincludeDetails
optional
When true, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is true.string (boolean)
QuerychangedAfter
optional
Purchase orders that changed after this timestamp will be included in the result. Must be in ISO-8601 date/time format.string (date-time)
QuerychangedBefore
optional
Purchase orders that changed before this timestamp will be included in the result. Must be in ISO-8601 date/time format.string (date-time)
QuerypoItemState
optional
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.enum (PoItemState)
QueryisPOChanged
optional
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.string (boolean)
QuerypurchaseOrderState
optional
Filters purchase orders based on the purchase order state.enum (PurchaseOrderState)
QueryorderingVendorCode
optional
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.string

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPurchaseOrdersResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPurchaseOrdersResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPurchaseOrdersResponse
404The resource specified does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPurchaseOrdersResponse
415The request payload is in an unsupported format.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPurchaseOrdersResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPurchaseOrdersResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPurchaseOrdersResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPurchaseOrdersResponse

For additional error status codes, descriptions and schemas, see Error responses and schemas.

GET /vendor/orders/v1/purchaseOrders/{purchaseOrderNumber}

Operation: getPurchaseOrder

Description

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

Usage Plans:

Plan typeRate (requests per second)Burst
Default1010
Selling partner specificVariableVariable

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
PathpurchaseOrderNumber
required
The purchase order identifier for the order that you want. Formatting Notes: 8-character alpha-numeric code.string

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPurchaseOrderResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPurchaseOrderResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPurchaseOrderResponse
404The resource specified does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPurchaseOrderResponse
415The request payload is in an unsupported format.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPurchaseOrderResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPurchaseOrderResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPurchaseOrderResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPurchaseOrderResponse

For additional error status codes, descriptions and schemas, see Error responses and schemas.

POST /vendor/orders/v1/acknowledgements

Operation: submitAcknowledgement

Description

Submits acknowledgements for one or more purchase orders.

Usage Plans:

Plan typeRate (requests per second)Burst
Default1010
Selling partner specificVariableVariable

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
Bodybody
required
The request schema for the submitAcknowledgment operation.SubmitAcknowledgementRequest

Responses

HTTP CodeDescriptionSchema
202Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
SubmitAcknowledgementResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
SubmitAcknowledgementResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
SubmitAcknowledgementResponse
404The resource specified does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
SubmitAcknowledgementResponse
415The request payload is in an unsupported format.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
SubmitAcknowledgementResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
SubmitAcknowledgementResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
SubmitAcknowledgementResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
SubmitAcknowledgementResponse

For additional error status codes, descriptions and schemas, see Error responses and schemas.

GET /vendor/orders/v1/purchaseOrdersStatus

Operation: getPurchaseOrdersStatus

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.

Usage Plans:

Plan typeRate (requests per second)Burst
Default1010
Selling partner specificVariableVariable

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
Querylimit
optional
The limit to the number of records returned. Default value is 100 records.
Minimum : 1
Maximum : 100
integer (int64)
QuerysortOrder
optional
Sort in ascending or descending order by purchase order creation date.enum (SortOrder)
QuerynextToken
optional
Used for pagination when there are more purchase orders than the specified result size limit.string
QuerycreatedAfter
optional
Purchase orders that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format.string (date-time)
QuerycreatedBefore
optional
Purchase orders that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format.string (date-time)
QueryupdatedAfter
optional
Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in ISO-8601 date/time format.string (date-time)
QueryupdatedBefore
optional
Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in ISO-8601 date/time format.string (date-time)
QuerypurchaseOrderNumber
optional
Provides purchase order status for the specified purchase order number.string
QuerypurchaseOrderStatus
optional
Filters purchase orders based on the specified purchase order status. If not included in filter, this will return purchase orders for all statuses.enum (PurchaseOrderStatus)
QueryitemConfirmationStatus
optional
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.enum (ItemConfirmationStatus)
QueryitemReceiveStatus
optional
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.enum (ItemReceiveStatus)
QueryorderingVendorCode
optional
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.string
QueryshipToPartyId
optional
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.string

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPurchaseOrdersStatusResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPurchaseOrdersStatusResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPurchaseOrdersStatusResponse
404The resource specified does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPurchaseOrdersStatusResponse
415The request payload is in an unsupported format.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPurchaseOrdersStatusResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPurchaseOrdersStatusResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPurchaseOrdersStatusResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPurchaseOrdersStatusResponse

For additional error status codes, descriptions and schemas, see Error responses and schemas.

Error Responses and Schemas

This table contains HTTP status codes and associated information for error responses.

HTTP CodeDescriptionSchema
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers:
x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string):Unique request reference identifier.
GetPurchaseOrderResponse
413The request size exceeded the maximum accepted size.
Headers:
x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string):Unique request reference identifier.
SubmitAcknowledgementResponse

Definitions

GetPurchaseOrdersResponse

The response schema for the getPurchaseOrders operation.

NameDescriptionSchema
payload
optional
A list of orders.OrderList
errors
optional
A list of error responses returned when a request is unsuccessful.ErrorList

GetPurchaseOrderResponse

The response schema for the getPurchaseOrder operation.

NameDescriptionSchema
payload
optional
The details of the requested orderOrder
errors
optional
A list of error responses returned when a request is unsuccessful.ErrorList

OrderList

NameSchema
pagination
optional
Pagination
orders
optional
< Order > array

Pagination

NameDescriptionSchema
nextToken
optional
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.string

Order

NameDescriptionSchema
purchaseOrderNumber
required
The purchase order number for this order. Formatting Notes: 8-character alpha-numeric code.string
purchaseOrderState
required
This field will contain the current state of the purchase order.enum (PurchaseOrderState)
orderDetails
optional
Details of an order.OrderDetails

OrderDetails

Details of an order.

NameDescriptionSchema
purchaseOrderDate
required
The date the purchase order was placed. Must be in ISO-8601 date/time format.string (date-time)
purchaseOrderChangedDate
optional
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.string (date-time)
purchaseOrderStateChangedDate
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.string (date-time)
purchaseOrderType
optional
Type of purchase order.enum (PurchaseOrderType)
importDetails
optional
If the purchase order is an import order, the details for the import order.ImportDetails
dealCode
optional
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.string
paymentMethod
optional
Payment method used.enum (PaymentMethod)
buyingParty
optional
Name/Address and tax details of the buying party.PartyIdentification
sellingParty
optional
Name/Address and tax details of the selling party.PartyIdentification
shipToParty
optional
Name/Address and tax details of the ship to party.PartyIdentification
billToParty
optional
Name/Address and tax details of the bill to party.PartyIdentification
shipWindow
optional
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.DateTimeInterval
deliveryWindow
optional
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.DateTimeInterval
items
required
A list of items in this purchase order.< OrderItem > array

ImportDetails

Import details for an import order.

NameDescriptionSchema
methodOfPayment
optional
If the recipient requests, contains the shipment method of payment. This is for import PO's only.enum (MethodOfPayment)
internationalCommercialTerms
optional
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 (InternationalCommercialTerms)
portOfDelivery
optional
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.
maxLength : 64
string
importContainers
optional
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.
maxLength : 64
string
shippingInstructions
optional
Special instructions regarding the shipment. This field is for import purchase orders.string

DateTimeInterval

Defines a date time interval according to ISO8601. Interval is separated by double hyphen (--).

Type : string

PartyIdentification

NameDescriptionSchema
partyId
required
Assigned identification for the party. For example, warehouse code or vendor code. Please refer to specific party for more details.string
address
optional
Identification of the party by address.Address
taxInfo
optional
Tax registration details of the party.TaxRegistrationDetails

TaxRegistrationDetails

Tax registration details of the entity.

NameDescriptionSchema
taxRegistrationType
required
Tax registration type for the entity.enum (TaxRegistrationType)
taxRegistrationNumber
required
Tax registration number for the entity. For example, VAT ID.string

Address

Address of the party.

NameDescriptionSchema
name
required
The name of the person, business or institution at that address.string
addressLine1
required
First line of the address.string
addressLine2
optional
Additional address information, if required.string
addressLine3
optional
Additional address information, if required.string
city
optional
The city where the person, business or institution is located.string
county
optional
The county where person, business or institution is located.string
district
optional
The district where person, business or institution is located.string
stateOrRegion
optional
The state or region where person, business or institution is located.string
postalCode
optional
The postal code of that address. It conatins a series of letters or digits or both, sometimes including spaces or punctuation.string
countryCode
required
The two digit country code. In ISO 3166-1 alpha-2 format.
maxLength : 2
string
phone
optional
The phone number of the person, business or institution located at that address.string

OrderItem

NameDescriptionSchema
itemSequenceNumber
required
Numbering of the item on the purchase order. The first item will be 1, the second 2, and so on.string
amazonProductIdentifier
optional
Amazon Standard Identification Number (ASIN) of an item.string
vendorProductIdentifier
optional
The vendor selected product identification of the item.string
orderedQuantity
required
Item quantity ordered.ItemQuantity
isBackOrderAllowed
required
When true, we will accept backorder confirmations for this item.boolean
netCost
optional
The price to Amazon each (cost).Money
listPrice
optional
The price to Amazon each (list).Money

Money

An amount of money, including units in the form of currency.

NameDescriptionSchema
currencyCode
optional
Three digit currency code in ISO 4217 format. String of length 3.
maxLength : 3
string
amount
optional
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+)?$.
Decimal

Decimal

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+)?$.

Type : string

SubmitAcknowledgementResponse

The response schema for the submitAcknowledgement operation

NameDescriptionSchema
payload
optional
The payload for the submitAcknowledgement operation.TransactionId
errors
optional
A list of error responses returned when a request is unsuccessful.ErrorList

TransactionId

NameDescriptionSchema
transactionId
optional
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.string

ErrorList

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

Type : < Error > array

SubmitAcknowledgementRequest

The request schema for the submitAcknowledgment operation.

NameSchema
acknowledgements
optional
< OrderAcknowledgement > array

OrderAcknowledgement

NameDescriptionSchema
purchaseOrderNumber
required
The purchase order number. Formatting Notes: 8-character alpha-numeric code.string
sellingParty
required
Name, address and tax details of the party receiving a shipment of products.PartyIdentification
acknowledgementDate
required
The date and time when the purchase order is acknowledged, in ISO-8601 date/time format.string (date-time)
items
required
A list of the items being acknowledged with associated details.< OrderAcknowledgementItem > array

OrderAcknowledgementItem

Details of the item being acknowledged.

NameDescriptionSchema
itemSequenceNumber
optional
Line item sequence number for the item.string
amazonProductIdentifier
optional
Amazon Standard Identification Number (ASIN) of an item.string
vendorProductIdentifier
optional
The vendor selected product identification of the item. Should be the same as was sent in the purchase order.string
orderedQuantity
required
The quantity of this item ordered.ItemQuantity
netCost
optional
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.Money
listPrice
optional
The list price. This is required only if a vendor sells books with a list price.Money
discountMultiplier
optional
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.string
itemAcknowledgements
required
This is used to indicate acknowledged quantity.< OrderItemAcknowledgement > array

OrderItemAcknowledgement

NameDescriptionSchema
acknowledgementCode
required
This indicates the acknowledgement code.enum (AcknowledgementCode)
acknowledgedQuantity
required
Details of quantity acknowledged with the above acknowledgement code.ItemQuantity
scheduledShipDate
optional
Estimated ship date per line item. Must be in ISO-8601 date/time format.string (date-time)
scheduledDeliveryDate
optional
Estimated delivery date per line item. Must be in ISO-8601 date/time format.string (date-time)
rejectionReason
optional
Indicates the reason for rejection.enum (RejectionReason)

ItemQuantity

Details of quantity ordered.

NameDescriptionSchema
amount
optional
Acknowledged quantity. This value should not be zero.integer
unitOfMeasure
optional
Unit of measure for the acknowledged quantity.enum (UnitOfMeasure)
unitSize
optional
The case size, in the event that we ordered using cases.integer

GetPurchaseOrdersStatusResponse

The response schema for the getPurchaseOrdersStatus operation.

NameDescriptionSchema
payload
optional
Current status of list of purchase orders.OrderListStatus
errors
optional
A list of error responses returned when a request is unsuccessful.ErrorList

OrderListStatus

NameSchema
pagination
optional
Pagination
ordersStatus
optional
< OrderStatus > array

OrderStatus

Current status of a purchase order.

NameDescriptionSchema
purchaseOrderNumber
required
The buyer's purchase order number for this order. Formatting Notes: 8-character alpha-numeric code.string
purchaseOrderStatus
required
The status of the buyer's purchase order for this order.enum (PurchaseOrderStatus)
purchaseOrderDate
required
The date the purchase order was placed. Must be in ISO-8601 date/time format.string (date-time)
lastUpdatedDate
optional
The date when the purchase order was last updated. Must be in ISO-8601 date/time format.string (date-time)
sellingParty
required
Name/Address and tax details of the selling party.PartyIdentification
shipToParty
required
Name/Address and tax details of the ship to party.PartyIdentification
itemStatus
required
Detailed order status.ItemStatus

ItemStatus

Detailed description of items order status.

Type : < OrderItemStatus > array

OrderItemStatus

NameDescriptionSchema
itemSequenceNumber
required
Numbering of the item on the purchase order. The first item will be 1, the second 2, and so on.string
buyerProductIdentifier
optional
Buyer's Standard Identification Number (ASIN) of an item.string
vendorProductIdentifier
optional
The vendor selected product identification of the item.string
netCost
optional
The net cost to Amazon each (cost).Money
listPrice
optional
The list Price to Amazon each (list).Money
orderedQuantity
optional
Ordered quantity information.orderedQuantity
acknowledgementStatus
optional
Acknowledgement status information.acknowledgementStatus
receivingStatus
optional
Item receive status at the buyer's warehouse.receivingStatus


orderedQuantity

NameDescriptionSchema
orderedQuantity
optional
Item quantity ordered.ItemQuantity
orderedQuantityDetails
optional
Details of item quantity ordered.< OrderedQuantityDetails > array


acknowledgementStatus

NameDescriptionSchema
confirmationStatus
optional
Confirmation status of line item.enum (ConfirmationStatus)
acceptedQuantity
optional
Item quantities accepted by vendor to be shipped.ItemQuantity
rejectedQuantity
optional
Item quantities rejected by vendor.ItemQuantity
acknowledgementStatusDetails
optional
Details of item quantity confirmed.< AcknowledgementStatusDetails > array


receivingStatus

NameDescriptionSchema
receiveStatus
optional
Receive status of the line item.enum (ReceiveStatus)
receivedQuantity
optional
The total item quantity received by the buyer so far.ItemQuantity
lastReceiveDate
optional
The date when the most recent item was received at the buyer's warehouse. Must be in ISO-8601 date/time format.string (date-time)

OrderedQuantityDetails

Details of item quantity ordered

NameDescriptionSchema
updatedDate
optional
The date when the line item quantity was updated by buyer. Must be in ISO-8601 date/time format.string (date-time)
orderedQuantity
optional
Item quantity ordered.ItemQuantity
cancelledQuantity
optional
Item quantity ordered.ItemQuantity

AcknowledgementStatusDetails

Details of item quantity ordered

NameDescriptionSchema
acknowledgementDate
optional
The date when the line item was confirmed by vendor. Must be in ISO-8601 date/time format.string (date-time)
acceptedQuantity
optional
Item quantity accepted by vendor to be shipped.ItemQuantity
rejectedQuantity
optional
Item quantity rejected by vendor.ItemQuantity

Error

Error response returned when the request is unsuccessful.

NameDescriptionSchema
code
required
An error code that identifies the type of error that occurred.string
message
required
A message that describes the error condition.string
details
optional
Additional details that can help the caller understand or fix the issue.string

MethodOfPayment

If the recipient requests, contains the shipment method of payment. This is for import PO's only.

Type : enum

ValueDescription
PaidByBuyerBuyer pays for shipping.
CollectOnDeliveryBuyer pays for shipping on delivery.
DefinedByBuyerAndSellerShipping costs paid as agreed upon between buyer and seller.
FOBPortOfCallSeller pays for transportation including loading and shipping.
PrepaidBySellerSeller prepays for shipping.
PaidBySellerSeller pays for shipping.

ConfirmationStatus

Confirmation status of line item.

Type : enum

ValueDescription
ACCEPTEDStatus for orders accepted by vendors.
PARTIALLY_ACCEPTEDStatus for orders that are partially accepted by vendors.
REJECTEDStatus for orders that are rejected by vendors.
UNCONFIRMEDStatus for orders that are yet to be confirmed by vendors.

ItemReceiveStatus

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.

Type : enum

ValueDescription
NOT_RECEIVEDProvides a list of orders that have at least one item not received by the buyer.
PARTIALLY_RECEIVEDProvides a list of orders that have at least one item not received by the buyer.
RECEIVEDProvides a list of orders that have at least one item fully received by the buyer.

UnitOfMeasure

Unit of measure for the acknowledged quantity.

Type : enum

ValueDescription
CasesPacking of individual items into a case.
EachesIndividual items.

AcknowledgementCode

This indicates the acknowledgement code.

Type : enum

ValueDescription
AcceptedVendor accepts to fulfill the order item(s).
BackorderedVendor 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.
RejectedVendor rejects to fulfill the order item(s).

PoItemState

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.

Type : enum

ValueDescription
CancelledStatus for order items cancelled by vendors.

ItemConfirmationStatus

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.

Type : enum

ValueDescription
ACCEPTEDProvides a list of orders that has at least one item fully accepted by vendors.
PARTIALLY_ACCEPTEDProvides a list of orders that has at least one item partially accepted by vendors.
REJECTEDProvides a list of orders that has at least one item rejected by vendors.
UNCONFIRMEDProvides a list of orders that has at least one item yet to be confirmed by vendors.

InternationalCommercialTerms

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.

Type : enum

ValueDescription
ExWorksPlaces 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.
FreeCarrierThe 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.
FreeOnBoardOcean 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.
FreeAlongSideShipOcean 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.
CarriagePaidToThe 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.
CostAndFreightOcean 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.
CarriageAndInsurancePaidToSeller 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.
CostInsuranceAndFreightOcean 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.
DeliveredAtTerminalSeller 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.
DeliveredAtPlaceSeller 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.
DeliverDutyPaidSeller 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.

TaxRegistrationType

Tax registration type for the entity.

Type : enum

ValueDescription
VATValue-added tax.
GSTGoods and Services tax.

ReceiveStatus

Receive status of the line item.

Type : enum

ValueDescription
NOT_RECEIVEDThe buyer has not received any of the item.
PARTIALLY_RECEIVED-
RECEIVEDReceiving is complete. The buyer has received all confirmed items.

SortOrder

Sort in ascending or descending order by purchase order creation date.

Type : enum

ValueDescription
ASCSort in ascending order by purchase order creation date.
DESCSort in descending order by purchase order creation date.

RejectionReason

Indicates the reason for rejection.

Type : enum

ValueDescription
TemporarilyUnavailableItems are currently not available.
InvalidProductIdentifierItem cannot be found with the provided identifier.
ObsoleteProductItem is no longer sold.

PurchaseOrderType

Type of purchase order.

Type : enum

ValueDescription
RegularOrderA 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.
ConsignedOrderA 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.
NewProductIntroductionA purchase order where a new product is introduced.
RushOrderRush 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.

PaymentMethod

Payment method used.

Type : enum

ValueDescription
InvoiceAn invoice payment is submitted by a business to pay for products and services purchased from vendors.
ConsignmentA 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
CreditCardPayment is made using a credit card.
PrepaidPayment is prepaid.

PurchaseOrderStatus

Type : enum

For use with the definition(s): OrderStatus
The status of the buyer's purchase order for this order.

ValueDescription
OPENBuyer has not yet received all of the items in the purchase order.
CLOSEDBuyer has received all of the items in the purchase order.

For use with the operation(s): getPurchaseOrdersStatus
Filters purchase orders based on the specified purchase order status. If not included in filter, this will return purchase orders for all statuses.

ValueDescription
OPENBuyer has not yet received all of the items in the purchase order.
CLOSEDBuyer has received all of the items in the purchase order.

PurchaseOrderState

Type : enum

For use with the operation(s): getPurchaseOrders
Filters purchase orders based on the purchase order state.

ValueDescription
NewStatus of the orders that are newly created.
AcknowledgedStatus of the orders acknowledged by vendors.
ClosedStatus of the orders that are completed.

For use with the definition(s): Order
This field will contain the current state of the purchase order.

ValueDescription
NewThe purchase order is newly created and needs to be acknowledged by vendor.
AcknowledgedThe purchase order has been acknowledged by vendor.
ClosedThe 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.

Did this page help you?