Label data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier for this label object |
created_at | string (date-time) | No | The date that this label object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | The last date that this label object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
shipment_id | string | No | Reference to the shipment |
tracking_number | string | No | Tracking number for the shipment |
label_url | string | No | URL to download the label |
label_format | enum | No | Format of the label (PDF, PNG, ZPL, EPL2) Values: PDF, PNG, ZPL, EPL2, PDF_4X6, PDF_4X8, PNG_4X6, PNG_4X8 |
status | enum | No | Status of the label Values: PENDING, PROCESSING, IN_TRANSIT, DELIVERED, EXCEPTION, CANCELLED, LABEL_CREATED, PICKED_UP, OUT_FOR_DELIVERY, DELIVERY_ATTEMPTED, RETURNED_TO_SENDER, HELD_AT_LOCATION, CUSTOMS_CLEARANCE, EXCEPTION_RESOLVED |
is_voided | boolean | No | Whether label has been voided |
label_cost | number | No | Cost to purchase label |
label_cost_currency | string | No | |
rate_id | string | No | Rate used for this label; points to ShippingRate |
service_code | string | No | Service code used |
Are we missing anything? Let us know