API endpoints > labels > post
Start the label create process for the given labels. Please keep in mind that the amount of concurrent requests and amount of labels in 1 request is limitted by account settings.
The returned CallbackURL is the complete url that can be used for the GET request to poll the api if the process has finished.
Notes
- Please note that any label request is limitted to: 1 concurrent active request per client and at this time only 1 ClientReferenceCodeList item is allowed in any request.
JSON data structure
- ClientReferenceCodeListArray of single valuesrequiredMinimum array items: 1List of shipment references for which to create a label. Usualy 10 labels per request is permitted, but in certain circumstances a higher amount is possible.
- LabelStartInteger numberMinimum value: 1, maximum value: 4If needed/desired for a multi-label print (for instance 4 on an A4 paper), this is the starting position
- LabelTypeInteger numberrequiredThe correct Id for a labeltype (see below). If omitted 0 is asumed.
JSON reply data
- CallbackURLurlMinimum length: 1, maximum length: 100The URL for your poll/callback, only returned if there is no error.
- ErrorsublistAlways returnedAny error will be reported here, see the error list for error codes and their meaning.
- IdInteger numberAlways returnedMaximum value: 999The id of the error
- InfoStringTextual error
| GET | /labels/:runid |
| POST | /labels/ |
LabelFile types
| Id | Label type |
|---|---|
| 0 | PDF with pabels |
| 1 | ZPL printable file |
Label types
| Id | Label type | Printer paper size |
|---|---|---|
| 1 | Labelwriter (102 X 140mm) | 100 X 140 mm |
| 2 | A4 (4 labels per page) | A4 |
| 3 | A4 (1 label per page) | A4 |
| 4 | A4 (2 labels per page) | A4 |
| 5 | Labelwriter (102 X 152mm) | 102 X 152 mm |
| 6 | A4 (2 labels, 100 X 210mm) | A4 |
| 7 | Labelwriter (100 X 210mm) | 100 X 210 mm |
Label start positions
| Id | Start location |
|---|---|
| 0 | Left or top-left |
| 1 | Right or top-right) |
| 2 | bottom-left |
| 3 | bottom-right |