Get Label
Returns one or more shipping labels associated with an OpenBorder order.
For full-order fulfillment, provide the order number to retrieve the existing label. For split shipments, include the required SKU, parcel, and address information to generate a label for the specified items.
Authorizations
Bearer token provided by OpenBorder.
Body
The order number to retrieve or generate a label for.
Parcel weight. When provided, weightUnit is also required.
Unit for the weight field. Required when weight is set.
grams, pounds Parcel length. When any dimension is provided, dimensionsUnit is also required.
Parcel width. When any dimension is provided, dimensionsUnit is also required.
Parcel height. When any dimension is provided, dimensionsUnit is also required.
Unit for length, width, and height. Required when any dimension is set.
cm, in When true, the label is returned as a base64-encoded string in addition to the PDF URL.
Required for partial label generation. An array of SKU objects describing the items in this parcel.
Show child attributes
Show child attributes
The origin address. Required when skus is provided.
Show child attributes
Show child attributes
The destination address. Required when skus is provided.
Show child attributes
Show child attributes
A reference string printed directly on the label. Required when skus is provided.
Parcel weight in grams. Required when skus is provided.
Your brand code as provided by OpenBorder. Required when skus is provided.
An optional location code used for partial label consolidation across fulfillment centers.
When true, the response includes a URL to the label in ZPL format for thermal printers.
Response
Request processed. result is the label when one was found or generated.
When the order can't be matched, result is the string
Unable to generate label and isError is still false.