Skip to main content

Download Dropship Label

GET 

/api/dropship-labels/:dropshipLabel/download

Streams the label file (usually application/pdf, served inline). Multi-package labels have one file per package; choose it with package (zero-based; the label's label_file_count is the number of files). An index with no file returns 422 invalid_state.

Required scope: purchase-orders:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Returns 422 {message, reason} when the label has no file yet (not purchased) or the file could not be retrieved.

Authentication: Requires Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type