object ShippingLabel

Fields

FieldTypeDescription
idString

Public API ID for this identifiable.

legacy_idBigInt

Numeric legacy ID for this identifiable; use only where legacy IDs are required.

account_idString

Public API account ID that identifies the related record.

shipment_idString

Public API shipment ID that identifies the related record.

order_idString

Public API order ID that identifies the related record.

box_idString

Public API box ID that identifies the related record.

box_nameString

Box name for this shipping label.

statusString

Current status; use the API status values returned by this field when filtering or updating.

tracking_numberString

Carrier tracking number for the shipment or label.

alternate_tracking_idString

Public API alternate tracking ID that identifies the related record.

order_numberString

Order number for this shipping label.

order_account_idString

Public API order account ID that identifies the related record.

carrierString

Carrier name or carrier code used for shipping.

shipping_nameString

Shipping name for this shipping label.

shipping_methodString

Carrier service or shipping method code.

costString

Internal cost as a decimal monetary amount; distinct from customer-facing price.

box_codeString

Box code for this shipping label.

device_idString

Public API device ID that identifies the related record.

deliveredBoolean

Whether the carrier marked this shipping label as delivered.

picked_upBoolean

Whether the carrier picked up the shipment for this label.

refundedBoolean

Whether this shipping label has been refunded.

needs_refundBoolean

True when this shipping label needs refund; false otherwise.

profileString

Profile for this shipping label.

partner_fulfillment_idString

Public API partner fulfillment ID that identifies the related record.

full_size_to_printString

Full size to print for this shipping label.

packing_slipString

Packing slip for this shipping label.

warehouseString

Warehouse display value or nested warehouse object for this record. Use warehouse_id when passing a warehouse reference.

warehouse_idString

Public API warehouse ID. Use this when passing or filtering by a warehouse; warehouse fields are display values or nested objects.

insurance_amountString

Monetary amount as a decimal value in the record currency; not cents.

carrier_account_idString

Public API carrier account ID that identifies the related record.

sourceString

Source for this shipping label.

created_dateISODateTime

Created date in ISO-8601 date or datetime format, returned in UTC when time is included.

tracking_urlString

URL for the tracking URL resource.

dimensionsDimensions

Package or item dimensions. Length, width, and height are in inches unless account or carrier configuration specifies another unit.

labelLabelResource

Label associated with this shipping label.

addressAddress

Address details for this shipping label.

orderOrder

Order associated with this shipping label.

shipment_line_itemsShipmentLineItemConnection

Shipment line items for this shipping label.

ArgumentTypeRequiredDefaultDescription
sortStringNo
beforeStringNo
afterStringNo
firstIntNo
lastIntNo
package_numberInt

Package number as a numeric value.

parcelview_urlString

URL for the parcelview URL resource.

tracking_statusString

Current tracking status; use the API status values returned by this field when filtering or updating.

in_shipping_containerBoolean

Whether this label is assigned to a shipping container.

shipping_container_idString

Public API shipping container ID that identifies the related record.

last_mile_labelsLastMileLabelDEPRECATED Zone Skipping has been deprecated. This field always returns null.

Last mile labels for this shipping label. Deprecated; see the deprecation reason for current behavior.

serial_numbers[LineItemSerialNumber]

List of serial numbers for this shipping label.

Referenced By

Example

{
  "id": "UmVjb3JkOjEyMzQ=",
  "legacy_id": 1234,
  "account_id": "U2hpcHBpbmdMYWJlbDoxMjM0",
  "shipment_id": "U2hpcHBpbmdMYWJlbDoxMjM0",
  "order_id": "U2hpcHBpbmdMYWJlbDoxMjM0",
  "box_id": "U2hpcHBpbmdMYWJlbDoxMjM0",
  "box_name": "12x10x4 Box",
  "status": "pending",
  "tracking_number": "1Z999AA10123456784",
  "alternate_tracking_id": "U2hpcHBpbmdMYWJlbDoxMjM0",
  "order_number": "SO-100045",
  "order_account_id": "U2hpcHBpbmdMYWJlbDoxMjM0",
  "carrier": "ups",
  "shipping_name": "UPS Ground",
  "shipping_method": "ups_ground",
  "cost": "19.99",
  "box_code": "STANDARD",
  "device_id": "U2hpcHBpbmdMYWJlbDoxMjM0",
  "delivered": true,
  "picked_up": true,
  "refunded": true,
  "needs_refund": true,
  "profile": "default",
  "partner_fulfillment_id": "U2hpcHBpbmdMYWJlbDoxMjM0",
  "full_size_to_print": "M",
  "packing_slip": "https://example.com/packing-slips/PK-100045.pdf",
  "warehouse": "Primary Warehouse",
  "warehouse_id": "U2hpcHBpbmdMYWJlbDoxMjM0",
  "insurance_amount": "19.99",
  "carrier_account_id": "U2hpcHBpbmdMYWJlbDoxMjM0",
  "source": "shopify",
  "created_date": "2026-07-09T15:30:00Z",
  "tracking_url": "https://example.com/resource",
  "dimensions": {length: 12.5, width: 8.0, height: 4.0},
  "label": {tracking_number: "1Z999AA10123456784", carrier: "ups"},
  "address": {address1: "123 Fulfillment Ave", city: "New York", country: "US"},
  "order": {tracking_number: "1Z999AA10123456784", carrier: "ups"},
  "shipment_line_items": [{sku: "BLUE-TEE-M", quantity: 2}],
  "package_number": 100,
  "parcelview_url": "https://example.com/resource",
  "tracking_status": "pending",
  "in_shipping_container": true,
  "shipping_container_id": "U2hpcHBpbmdMYWJlbDoxMjM0",
  "last_mile_labels": {tracking_number: "1Z999AA10123456784", carrier: "ups"},
  "serial_numbers": ["SN-100045", "SN-100046"]
}