v5

latestOpenAPI 3.0.02026-08-017841,2603.2 MB

shipping

label

Create a label

post/shipping/{connection_id}/label

Path parameters

connection_idstring required

ID of the connection

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

Request body

idstring

created_atstring date-time

updated_atstring date-time

shipment_idstring

tracking_numberstring

label_urlstring

label_format'PDF' | 'PNG' | 'ZPL' | 'EPL2' | 'PDF_4X6' | 'PDF_4X8' | 'PNG_4X6' | 'PNG_4X8'

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'

is_voidedboolean

label_costnumber

label_cost_currencystring

rate_idstring

service_codestring

rawobject

Response

Successful

idstring

created_atstring date-time

updated_atstring date-time

shipment_idstring

tracking_numberstring

label_urlstring

label_format'PDF' | 'PNG' | 'ZPL' | 'EPL2' | 'PDF_4X6' | 'PDF_4X8' | 'PNG_4X6' | 'PNG_4X8'

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'

is_voidedboolean

label_costnumber

label_cost_currencystring

rate_idstring

service_codestring

rawobject