Retrieve a label

GET/shipping/{connection_id}/label/{id}

Parameters

fieldsstring array
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
connection_idstring required
ID of the connection
idstring required
ID of the Label

Returns

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
const options = {
  method: 'GET',
  url: 'https://api.unified.to/shipping/5de520f96e439b002043d8dc/label/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?