Fetch Label
Fetch the shipping label for an order.
Environments: Production https://api.integration.instabee.com · Sandbox https://sandbox-api.integration.instabee.com (same paths; use sandbox credentials for the sandbox host).
Fetch Label
Production: GET https://api.integration.instabee.com/orders/{orderId}/labels
Sandbox: GET https://sandbox-api.integration.instabee.com/orders/{orderId}/labels
Headers:
1Authorization: Bearer {token}1Authorization: Bearer {token}
Path Parameters
| Param | Type | Required | Description | Constraints |
|---|---|---|---|---|
| orderId | string | required | The unique order ID | Minimum 1 character |
Query Parameters
The label endpoint supports optional query parameters to customize the output format:
| Param | Type | Default | Options | Description |
|---|---|---|---|---|
| fileFormat | string | pdf | png, zpl, pdf | Output file format |
| encoding | string | base64 | Return label as base64-encoded string | |
| template | string | a6 | a6, a7 | Label paper size |
| dpi | integer | 96 | Resolution in dots per inch | |
| debug | boolean | false | true, false | Enable debug mode |
1curl -X GET "https://api.integration.instabee.com/orders/ORDER-12345/labels?fileFormat=pdf&template=a6" \ 2 -H "Authorization: Bearer {token}" \ 3 --output label.pdf1curl -X GET "https://api.integration.instabee.com/orders/ORDER-12345/labels?fileFormat=pdf&template=a6" \ 2 -H "Authorization: Bearer {token}" \ 3 --output label.pdf
1curl -X GET "https://sandbox-api.integration.instabee.com/orders/ORDER-12345/labels?fileFormat=pdf&template=a6" \ 2 -H "Authorization: Bearer {token}" \ 3 --output label.pdf1curl -X GET "https://sandbox-api.integration.instabee.com/orders/ORDER-12345/labels?fileFormat=pdf&template=a6" \ 2 -H "Authorization: Bearer {token}" \ 3 --output label.pdf
Response
Returns the label file in the requested format. When encoding=base64, returns a JSON object with a base64-encoded string.
Error Handling
| Status Code | Description | Solution |
|---|---|---|
401 | Unauthorised | Verify your Bearer token |
404 | Order not found | Check the orderId is correct |
429 | Rate limit exceeded | Reduce request frequency |