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.

📘

Note

This is a restricted operation and requires a Restricted Data Token (RDT) for authorization. For more information, refer to the Tokens API Use Case Guide.

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

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

You can submit shipping label requests in batches. You can also make multiple single-label or batch requests in parallel. A batch file can have shipping label requests for a maximum of 100 orders. To reduce label retrieval latency, limit the batch size to 10-15 requests.

For batches, use the submitShippingLabelRequest operation, which is asynchronous, and then call the getShippingLabel operation to get the generated shipping labels.

📘

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.