TABLE OF CONTENTS
1. Get label request (GET Method)
Info
|
1. 1 Query parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| CourierId | int | Yes | See Couriers table |
| Awb | string | Yes | AWB number from Courier |
| ExternalLocationId | string | Yes | ExternalLocationId of order |
| Type | string | Yes | Type of label : PDF,HTML, ZPL (not available for all carriers) |
| Format | string | Yes | Size of label : A6, A4, A6_10x9 (not available for all carriers) |
| UseFile | boolean | Yes | If yes application will return pdf file, otherwise application will return base64 |
| skipCache | boolean | If yes, cached file will be skipped | |
| includeVoucher | boolean | If yes, voucher will be printed if requested in Order |
2. Get label request for individual parcel (GET Method)
Info
|
2. 1 Query parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| CourierId | int | Yes | See Couriers table |
| UseClientBarcode | boolean | Yes | Defaults to NO |
| Awb | string | Yes | AWB number from Courier |
| ParcelBarcode | string | Yes | Parcel barcode from Courier or Client based on flag UseClientBarcode |
| ExternalLocationId | string | Yes | ExternalLocationId of order |
| Type | string | Yes | Type of label : PDF,HTML, ZPL (not available for all carriers) |
| Format | string | Yes | Size of label : A6, A4 |
| UseFile | boolean | Yes | If yes application will return pdf file, otherwise application will return base64 |
| skipCache | boolean | If yes, cached file will be skipped | |
| includeVoucher | boolean | If yes, voucher will be printed if requested in Order |
3. Label methods response
In case the response is a PDF document, the result content type is application/pdf.
Content-type: application/pdf