Retrieve Shipping Labels

GET

/shipping/labels{format}?shipment_ids[]={shipment_ids}

Fetch shipping labels for the specified shipment IDs.

Parameters

Accept

required

string

Allowed values: application/pdf image/png image/jpeg application/zpl

The format to return the shipping label as.

shipment_ids

required

string

Comma-separated list of shipment IDs to retrieve labels for.

format

required

string

Allowed values: .pdf .png .jpeg .zpl

The extension of the format to return the shipping label as.

A file containing the shipping label in the specified format, as well as a return label if one was purchased.

The label is available, but no format has been defined in the ‘format’ query parameter.

string format: binary

{"labels_count":1}

Shipment IDs not found, or no label was purchased for the given shipment.