Generate Shipping Label
POST /shipments/{id}/label command api-key
Generates a carrier shipping label for a dispatched fulfillment order, returning a PDF label and tracking number.
Overview
|
|
| ID |
generate-label-api |
| Method |
POST |
| Path |
/shipments/{id}/label |
| Classification |
command |
| Domain |
fulfillment |
| Capability |
fulfillment-execution |
| Service |
ship-order |
| Application |
carrier-platform — Carrier Platform |
| Auth |
api-key |
Response
|
|
| Business Object |
shipment |
| Description |
Fulfillment movement or collection unit used to complete customer delivery or pickup. |
| Lifecycle |
pending → label-created → collected → in-transit → out-for-delivery → delivery-attempted → held-at-depot → delivered → returned-to-sender → lost |
Events Emitted
| Event |
Classification |
Object |
Description |
shipment-label-generated |
updated |
shipment |
A carrier shipping label was successfully generated for a dispatched shipment, providing a tracking number. |
Integration Patterns
| Pattern |
Flow |
Style |
Description |
| FMS → Carrier Platform Label & Tracking |
fms → carrier-platform |
synchronous-api |
At dispatch, the FMS calls the Carrier Platform to generate a shipping label and obtain a tracking number. Carrier updates are received via webhook. |
Scenarios using fulfillment-execution
| Scenario |
Description |
Buy Online, Pick Up In Store |
Customer browses and purchases online, then collects the order from a physical store. The canonical |
Endless Aisle |
Store associate helps a customer order an item that is not physically stocked in the current store b |
Ship From Store |
An online order is fulfilled by shipping the goods directly from a physical store rather than a cent |
Ship To Store |
Customer places an online order for collection at a chosen store while stock is sourced from a wareh |
Unified Return |
Customer returns an item regardless of the original purchase channel. The return may be initiated on |
Related APIs — fulfillment domain