Shipping Label Recommended Workflows

The purpose of this page is to define ChannelAdvisor recommended workflows for requesting shipping rates and purchasing labels.

These utilize the ShippingLabelRequestID - a seller/developer defined unique identifier designed to prevent duplicate label requests and provide the possibility of retrieving a previously purchased label.


One Step Workflow

This workflow will request shipping rates and purchase the cheapest rate in a single request.

StepDescription

Endpoint

POST /v1/Orders(ID)/ShippingRates
Important Parameters

ShippingLabelRequestID: Supply a unique identifier that will be associated with this request and the purchased label.

PurchaseCheapestRate: true

ResponseIncludes the cheapest available label for the shipment.

Future requests that include this same ShippingLabelRequestID will return a previously purchased label.

If a unique ShippingLabelRequestID is provided in subsequent requests, the associated responses will be unique if there are open items available to ship.


Two Step Workflow

This workflow requires two requests:

  1. ShippingRates
  2. PurchaseLabel w/defined Shipping RateID as one of the inputs

Specific Documentation for Each Step

Step 1Description

Endpoint

POST /v1/Orders(ID)/ShippingRates
Important ParameterShippingLabelRequestID
  • Supply a unique identifier that will be associated with this request and the purchased label.
ResponseIncludes RateIDs for shipping options..

Step 2Description

Endpoint

POST /v1/Orders(ID)/ShippingRates
Important Parameters
  • ShippingLabelRequestID: include the same ShippingLabelRequestID from Step 1.
  • RateID: include the RateID from the response of Step 1 to be purchased.
ResponseIncludes Shipping Label requested.