Create shipping labels

Learn how to use the Vendor Direct Fulfillment Shipping API to create shipping labels. The createShippingLabels operation creates shipping labels for a purchase order and returns the labels. This is a synchronous operation and does not require calling the Vendor DF Transactions API.

The following diagram shows the workflow for creating shipping labels using the createShippingLabels operation.

Business requirements

You can return shipping labels for one purchase order per request. Multiple purchase orders in a single request is not supported.

Prerequisites

To complete this tutorial, you need:

• Authorization from the selling partner for whom you are making calls. For more information, refer to Authorizing Selling Partner API applications.
• The Direct-to-Consumer Shipping (Restricted) role assigned to your developer profile.
• The Direct-to-Consumer Shipping (Restricted) role selected in the app registration page for your application.

Create shipping labels

📘

Note

This 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 guide.

To create shipping labels synchronously, call the createShippingLabels operation. The latency for this operation is between three and five seconds.

📘

Note

You must include an item sequence number if you include container details. The item sequence number for each item in the shipping label request must match the item sequence number that you receive in the purchase order.