1. Get label request with included voucher (GET Method)

Info
  • Webservice URL: BASE_URL/api/Label/by-courier/{courierId}/awb/{awb}

1. 1 Query parameters:


NameTypeRequiredDescription
CourierIdintYesSee Couriers table
AwbstringYesAWB number from Courier
ExternalLocationIdstringYesExternalLocationId of order
TypestringYesType of label : PDF,HTML, ZPL (not available for all carriers)
FormatstringYesSize of label : A6, A4, A6_10x9 (not available for all carriers)
OrientationstringNoDefault value: Portrait - Landscape (not available for all carriers)
UseFilebooleanYesIf yes application will return pdf file, otherwise application will return base64
skipCacheboolean
If yes, cached file will be skipped
includeVoucherbooleanYesIf yes, voucher will be printed if requested in Order


Voucher will be returned togheter with the shipment label

2. Get voucher label (GET Method)

Info
  • Webservice URL:BASE_URL/api/Label/by-courier/{courierId}/voucher/{awb}

2. 1 Query parameters:


NameTypeRequiredDescription
CourierIdintYesSee Couriers table
AwbstringYesAWB number from Courier
ExternalLocationIdstringYesExternalLocationId of order
TypestringYesType of label : PDF,HTML, ZPL (not available for all carriers)
FormatstringYesSize of label : A6, A4
UseFilebooleanYesIf yes application will return pdf file, otherwise application will return base64
skipCacheboolean
If yes, cached file will be skipped