create_label
Generate a shipping label from a shipment request containing carrier, addresses, parcels, and label format. Returns tracking information and base64-encoded label.
Instructions
Create a shipping label from a canonical shipment request.
request is a canonical shipment request:
{carrier: {code, product}, sender, recipient, parcels: [{id, weight_kg, dimensions_cm}], references, label: {format}}. Addresses need
name/street/postal_code/city/country.
carrier overrides request.carrier.code when set. config supplies carrier
credential keys (e.g. dhl_username) merged over the environment; use it for
ad-hoc testing without setting SHIPLABEL_* env vars. include_label=false
returns a compact tracking-only reply without the base64 label.
Returns the shipment number and, per parcel, the tracking number/URL, label format and (unless disabled) the base64-encoded label.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| config | No | ||
| carrier | No | ||
| request | Yes | ||
| include_label | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |