Shipping Rates & Labels


About Shipping Rates & Labels

  • Important
    • Labels exist under Fulfillments endpoints.
    • ShippingRates are defined in Order endpoints.
  • Documentation is separate from Fulfillments due to increasing endpoints and capabilities around this feature.
  • This section outlines interaction with shipping rates, shipping partner labels, capture of return labels, channel return labels, and channel packing slips.
  • Documentation in this subsection only covers orders/fulfillments that will be shipped traditionally - through shipping services.
  • For information on local delivery, see Buy Online Pickup in Store & Local Delivery Workflow.

Context

  • Read about the use of Labels in ChannelAdvisor on the Knowledge Center page (platform login required).
  • Shipping Rates can be established at the Item, Account, or Classification level - documentation on setting this up is the Knowledge Center (platform login required).
  • When requesting shipping rates/purchasing shipping labels, ChannelAdvisor will prioritize unshipped items.
  • When a shipping label is successfully purchased, ChannelAdvisor will automatically complete the fulfillment and update it with tracking details (eg shipping method, shipped date, tracking number, etc...).

Amazon Buy Shipping

  • Labels may be purchased through these endpoints for the Amazon Buy Shipping program.
    • Purchase labels for standard and child SKUs via this program.
    • Purchase labels for assembly bundles via this program.
  • To purchase labels for Bundled products through SFP, you must use Assembly Bundles

    • Seller must be enabled to fulfill Assembly Bundles - contact Support to have this enabled.
    • Once enabled, developers may purchase labels for Assembly Bundles under the following conditions, otherwise the request will fail:
      • Quantity must match exactly the quantity on the component SKUs.
      • All components must be included in the shipment.
      • Bundle (from the Item) must be an "Assembly Bundle" 
        • Assembly Bundle definition: all components in the bundle will e shipped from the same distribution center. 

Shipping Workflows

  • 1 Step Workflow: Request rates and purchase the label in a single request.
  • 2 Step Workflow: Request rates in one request. Purchase the label in a second request.
    • Note: the 2 Step workflow is required to purchase library / media mail labels.

Shipping Rates & Labels Endpoints

POST /v1/Orders(OrderID)/ShippingRatesRetrieve shipping rates
POST /v1/Orders(OrderID)/PurchaseLabelPurchase a shipping label
GET /v1/Fulfillments(FulfillmentID)/LabelRetrieve a shipping label
DELETE /v1/Fulfillments(FulfillmentID)/LabelCancel a shipping label
GET /v1/Fulfillments(FulfillmentID)/ReturnLabelRetrieve a return label
GET /v1/Fulfillments(FulfillmentID)/ChannelReturnLabelRetrieve a channel return label
GET /v1/Fulfillments(FulfillmentID)/ChannelPackingSlipRetrieve a channel packing slip

Important POST Parameters / Properties for Purchase Label

Note: this is a comprehensive list of all properties available for Purchase Label. The Shipping Rates endpoint returns rates with unique IDs to be used in Purchase Label.

PropertyTypeRequiredDescription
OrderIDintRequiredInclude in URL. Value is the ChannelAdvisor Order ID
RateIDstringRequiredA GUID that is associated with a rate returned from ShippingRates
LabelFormatenumRequiredValid values are: PDF, ZPL. The default value is PDF
ShippingLabelRequestIDstring (50)Recommended

Seller supplied unique identifier for the label purchase request. Supply this value in each request to ensure duplicate labels are not purchased.

Note: once set, this value is applied on the Fulfillment and will not be returned in the response. If a future request is supplied with the same ID, the response will supply the existing label. See Purchase Shipping Label with Existing Request ID.

Important POST Parameters for Shipping Rates

Note: this is not a comprehensive list of all properties available. For a full list of properties, see the Order Entities page and ShippingRate Entity

PropertyFormatRequiredNote
OrderIDintRequiredInclude in URL. Value is the ChannelAdvisor Order ID
WeightUnitstringRequiredValid values are: Gram, Pound

Weight

decimalRequiredTotal weight of the package
ItemsCollectionRequiredAn array of ShippingItems
DistributionCenterIDintegerConditionallyRequired if no source address information is provided
PackageIDintegerConditionallyRequired if package dimension is not provided
PurchaseCheapestRate booleanOptionalIf specified, we will go ahead and purchase the shipping service associated with the lowest cost
LabelFormatenumOptionalValid values are: PDF, ZPL. The default value is PDF
ShippingLabelRequestIDstring (50)Recommended

Seller supplied unique identifier for the label purchase request. Supply this value in each request to ensure duplicate labels are not purchased.

Note: once set, this value is applied on the Fulfillment and will not be returned in the response. If a future request is supplied with the same ID, the response will supply the existing label. See Purchase Shipping Label with Existing Request ID.

Important GET & DELETE Parameters / Properties for Labels

PropertyTypeRequiredDescription
FulfillmentIDintRequiredInclude in URL. Value is the ChannelAdvisor Fulfillment ID

Label Request Examples