Label data model

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

Data Model

idstring
Unique identifier for this label object
created_atdate
The date that this label object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate
The last date that this label object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
shipment_idstring
Reference to the shipment
tracking_numberstring
Tracking number for the shipment
label_urlstring
URL to download the label
label_format enum
Valid values:
"PDF"
"PNG"
"ZPL"
"EPL2"
"PDF_4X6"
Format of the label (PDF, PNG, ZPL, EPL2)
status enum
Valid values:
"PENDING"
"PROCESSING"
"IN_TRANSIT"
"DELIVERED"
"EXCEPTION"
Status of the label
is_voidedboolean
Whether label has been voided
label_costnumber
Cost to purchase label
label_cost_currencystring
rate_idstring
Rate used for this label; points to ShippingRate
service_codestring
Service code used
Are we missing anything? Let us know
Was this page helpful?