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)/ShippingRates | Retrieve shipping rates |
| POST /v1/Orders(OrderID)/PurchaseLabel | Purchase a shipping label |
| GET /v1/Fulfillments(FulfillmentID)/Label | Retrieve a shipping label |
| DELETE /v1/Fulfillments(FulfillmentID)/Label | Cancel a shipping label |
| GET /v1/Fulfillments(FulfillmentID)/ReturnLabel | Retrieve a return label |
| GET /v1/Fulfillments(FulfillmentID)/ChannelReturnLabel | Retrieve a channel return label |
| GET /v1/Fulfillments(FulfillmentID)/ChannelPackingSlip | Retrieve 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.
| Property | Type | Required | Description |
|---|---|---|---|
| OrderID | int | Required | Include in URL. Value is the ChannelAdvisor Order ID |
| RateID | string | Required | A GUID that is associated with a rate returned from ShippingRates |
| LabelFormat | enum | Required | Valid values are: PDF, ZPL. The default value is PDF |
| ShippingLabelRequestID | string (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
| Property | Format | Required | Note |
|---|---|---|---|
| OrderID | int | Required | Include in URL. Value is the ChannelAdvisor Order ID |
| WeightUnit | string | Required | Valid values are: Gram, Pound |
Weight | decimal | Required | Total weight of the package |
| Items | Collection | Required | An array of ShippingItems |
| DistributionCenterID | integer | Conditionally | Required if no source address information is provided |
| PackageID | integer | Conditionally | Required if package dimension is not provided |
| PurchaseCheapestRate | boolean | Optional | If specified, we will go ahead and purchase the shipping service associated with the lowest cost |
| LabelFormat | enum | Optional | Valid values are: PDF, ZPL. The default value is PDF |
| ShippingLabelRequestID | string (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
| Property | Type | Required | Description |
|---|---|---|---|
| FulfillmentID | int | Required | Include in URL. Value is the ChannelAdvisor Fulfillment ID |
Label Request Examples
- Cancel Shipping Label
- Cancel Shipping Label & Mark Unshipped
- Purchase a Shipping Label
- Purchase Shipping Label with Existing Request ID
- Retrieve a Channel Packing Slip
- Retrieve a Channel Return Label
- Retrieve a Return Label
- Retrieve a Shipping Label
- Retrieve Shipping Label Rates
- Retrieve Shipping Label Rates & Purchase Least Expensive Rate
- Shipping Label Recommended Workflows