shipping
label

Retrieve a label

get/shipping/{connection_id}/label/{id}

Request

  • Base URL: http://api.unified.to
  • URL: http://api.unified.to/shipping/{connection_id}/label/{id}
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Label

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring

Unique identifier for this label object

created_atstring date-time

The date that this label object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

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'PDF' | 'PNG' | 'ZPL' | 'EPL2' | 'PDF_4X6' | 'PDF_4X8' | 'PNG_4X6' | 'PNG_4X8'

Format of the label (PDF, PNG, ZPL, EPL2)

status'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'

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

rawunknown

Changes

No recorded changes to this operation across all 1 revision of this API.