HomeDocumentationCode SamplesAPI ReferenceAnnouncementsModelsRelease NotesFAQGitHubVideos
Developer HubAPI StatusSupport
Documentation
Developer HubAPI StatusSupport

Get an order

Learn how to use the Vendor Direct Fulfillment Orders API to get an order.

Learn how to use the Vendor Direct Fulfillment Orders API to get an order. The getOrder operation returns information about the purchase order that you specify using the purchase order number. The response includes complete purchase order information for the purchase order, including line item details, quantity, and cost.

📘

Note

getOrder is a restricted operation and requires a Restricted Data Token (RDT) for authorization. Some operations require restrictions because they contain customer PII data. These operations require passing an additional security review. For more information on RDT, refer to the Tokens API Use Case Guide.

Use this API to get the details of specific orders returned by the getOrders operation. You can also use this API to get details for any purchase order in a seven-day time range during the past six months after the vendor went live on the API.

The following diagram shows the integration workflow to retrieve a specific purchase order:

The Direct Fulfillment integration workflow to retrieve a specific purchase order.

Business requirements

  • A packing slip is required for orders that are Business to Business (B2B) orders or gift orders. When isPslipRequired is true, a packing slip is required.

  • The requiredShipDate value is the latest date that the order must be shipped from the warehouse. The promisedDeliveryDate field value denotes the date we promised to deliver to the customer.

  • You cannot submit changes to an order using the API. After an order has been placed, it cannot be changed.

Country-specific business requirements

FunctionalityIndiaEuropeNorth America
Net costConditional. Either net cost or list price.Conditional. Either net cost or list price.Conditional. Either net cost or list price.
List priceConditional. Either net cost or list price.Conditional. Either Net Cost or List price.Conditional. Either net cost or list price.
Ship-from partyThe warehouse code assigned to the vendor.The warehouse code assigned to the vendor.The warehouse code assigned to the vendor.
Selling partyThe vendor code assigned to the vendor.The vendor code assigned to the vendor.The vendor code assigned to the vendor.
Ship-to partyThe address of the customer.The address of the customer. For Amazon label only vendors, certain fields are replaced with the fictitious value XXXXX. Refer to the Direct Fulfillment customer data transmission section for more information.The address of the customer. For Amazon label only vendors, certain fields are replaced with fictitious value XXXXX. Refer to the Direct Fulfillment customer data transmission section for more information.
Bill-to partyThe address of the bill-to entity.The address of the bill-to entity.Not applicable.

⭐

Tip

To learn how to check that your vendor group contains all of the vendor codes that you want your application to access, and add new vendor codes to your account, refer to Authorize your Application to Access Vendor Groups.

Prerequisites

To complete this tutorial, you need:

Get an order

To return information about a specific purchase order, call the getOrder operation.

Updated about 17 hours ago