Fetch a label
GET/standard/label
This endpoint is meant to be used for retrieving the label for a given delivery. Labels can be customized by the sender based on technical and operational requirements.
Request
Query Parameters
- ZPL: returns a label optimized for 10.3cm x 15cm default@203dpi.
- PDF: returns an A6 (10.5 x 14.8 cm) sized label.
- 6 dpmm - 152 dpi
- 8 dpmm - 203 dpi
- 12 dpmm - 300 dpi
- 24 dpmm - 600 dpi
access_token stringrequired
API Token
id stringrequired
Id of the delivery a label will be generated for
format string
Possible values: [pdf
, zpl
]
Default value: pdf
The returned label format:
dpmm number
Possible values: [6
, 8
, 12
, 24
]
Default value: 8
Sets ZPL label resolution:
Responses
- 200
- 400
- 500
OK
- application/pdf
- application/zpl
- Schema
Schema
- string binary
Returns the label as PDF
- Schema
Schema
- string binary
Returns the label as ZPL
Bad Request
- application/json
- Schema
- Example (from schema)
- example-400
Schema
error booleanrequired
message stringrequired
Possible values: non-empty
{
"error": true,
"message": "string"
}
{
"error": true,
"message": "not a valid id"
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
- example-500
Schema
error booleanrequired
message stringrequired
Possible values: non-empty
{
"error": true,
"message": "string"
}
{
"error": true,
"message": "Internal error, please contact support@sendit.green"
}
Loading...