Get Label – Retrieve a Shipping Label - OpenBorder API Documentation

The Get Label endpoint 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.

Endpoints

Environment	URL
Production	`POST https://api.openborder.com/api/post/fc/labels`

Authentication

All requests must include a Bearer token in the Authorization header.

Authorization: Bearer TOKEN

Request Body

string

required

The order number to retrieve or generate a label for.

number

Parcel weight. When provided, weightUnit is also required.

string

Unit for the weight field. Required when weight is set. Accepted values: "grams" or "pounds".

number

Parcel length. When any dimension is provided, dimensionsUnit is also required.

number

Parcel width. When any dimension is provided, dimensionsUnit is also required.

number

Parcel height. When any dimension is provided, dimensionsUnit is also required.

string

Unit for length, width, and height. Required when any dimension is set. Accepted values: "cm" or "in".

boolean

When true, the label is returned as a base64-encoded string in addition to the PDF URL.

array

Required for partial label generation. An array of SKU objects describing the items in this parcel.

Show SKU object fields

string

required

The SKU identifier.

string

required

The Advanced Shipment Notice (ASN) reference associated with the SKU.

number

required

Quantity of this SKU included in the parcel.

object

The origin address. Required when skus is provided.

Show Address fields

string

required

First name on the address.

string

required

Last name on the address.

string

required

Phone number including country code (e.g. +12125551234).

string

required

Primary street address line.

string

Secondary address line (apartment, suite, unit, etc.).

string

required

City name.

string

required

State or province code.

string

required

Two-letter ISO 3166-1 alpha-2 country code (e.g. "US", "DE").

string

required

Postal or ZIP code.

object

The destination address. Required when skus is provided.

Show Address fields

string

required

First name on the address.

string

required

Last name on the address.

string

required

Phone number including country code.

string

required

Primary street address line.

string

Secondary address line (apartment, suite, unit, etc.).

string

required

City name.

string

required

State or province code.

string

required

Two-letter ISO 3166-1 alpha-2 country code.

string

required

Postal or ZIP code.

string

A reference string printed directly on the label. Required when skus is provided.

string

Parcel weight in grams. Required when skus is provided.

string

Your brand code as provided by OpenBorder. Required when skus is provided.

string

An optional location code used for partial label consolidation across fulfillment centers.

boolean

When true, the response includes a URL to the label in ZPL format (for thermal printers).

Request Examples

{
  "orderNumber": "#12345"
}

{
  "orderNumber": "#12345",
  "skus": [
    { "skuName": "TSHIRT-L-BLK", "asn": "ASN001", "quantity": 2 }
  ],
  "fromAddress": {
    "firstName": "Warehouse",
    "lastName": "Team",
    "phoneNumber": "+12125551234",
    "line1": "123 Warehouse St",
    "city": "New York",
    "province": "NY",
    "country": "US",
    "zipcode": "10001"
  },
  "toAddress": {
    "firstName": "Jane",
    "lastName": "Doe",
    "phoneNumber": "+493012345678",
    "line1": "Unter den Linden 1",
    "city": "Berlin",
    "province": "Berlin",
    "country": "DE",
    "zipcode": "10115"
  },
  "trackReference": "REF-12345",
  "parcelWeight": "500",
  "brandCode": "MYBRAND"
}

Response

When the label is available, the endpoint returns a structured result object.

boolean

false when the request was processed successfully.

object

The label result data.

Show result fields

string

The order number associated with the label.

string[]

An array of URLs pointing to the generated label PDFs.

string

Label generation status. One of "success", "pending", or "error".

string

The shipment tracking code. Returns an empty string if not yet available.

string

A direct link to the shipment tracking page. Returns an empty string if not yet available.

string

Base64-encoded label string. Only present when base64: true was included in the request.

string

URL to the ZPL format label. Only present when zpl: true was included in the request.

string

The name of the shipping service selected for this shipment. Only present when the service has been determined.

Label Ready Response

{
  "isError": false,
  "result": {
    "orderNumber": "#12345",
    "labelUrls": ["https://labelurl.com", "https://labelurl2.com"],
    "status": "success",
    "trackingCode": "123456789",
    "trackingUrl": "https://trackingurl.com"
  }
}

string

required

The order number to retrieve or generate a label for.

number

Parcel weight. When provided, weightUnit is also required.

string

Unit for the weight field. Required when weight is set. Accepted values: "grams" or "pounds".

number

Parcel length. When any dimension is provided, dimensionsUnit is also required.

number

Parcel width. When any dimension is provided, dimensionsUnit is also required.

number

Parcel height. When any dimension is provided, dimensionsUnit is also required.

string

Unit for length, width, and height. Required when any dimension is set. Accepted values: "cm" or "in".

boolean

When true, the label is returned as a base64-encoded string in addition to the PDF URL.

array

Required for partial label generation. An array of SKU objects describing the items in this parcel.

Show SKU object fields

string

required

The SKU identifier.

string

required

The Advanced Shipment Notice (ASN) reference associated with the SKU.

number

required

Quantity of this SKU included in the parcel.

object

The origin address. Required when skus is provided.

Show Address fields

string

required

First name on the address.

string

required

Last name on the address.

string

required

Phone number including country code (e.g. +12125551234).

string

required

Primary street address line.

string

Secondary address line (apartment, suite, unit, etc.).

string

required

City name.

string

required

State or province code.

string

required

Two-letter ISO 3166-1 alpha-2 country code (e.g. "US", "DE").

string

required

Postal or ZIP code.

object

The destination address. Required when skus is provided.

Show Address fields

string

required

First name on the address.

string

required

Last name on the address.

string

required

Phone number including country code.

string

required

Primary street address line.

string

Secondary address line (apartment, suite, unit, etc.).

string

required

City name.

string

required

State or province code.

string

required

Two-letter ISO 3166-1 alpha-2 country code.

string

required

Postal or ZIP code.

string

A reference string printed directly on the label. Required when skus is provided.

string

Parcel weight in grams. Required when skus is provided.

string

Your brand code as provided by OpenBorder. Required when skus is provided.

string

An optional location code used for partial label consolidation across fulfillment centers.

boolean

When true, the response includes a URL to the label in ZPL format (for thermal printers).

Request Examples

{
  "orderNumber": "#12345"
}

{
  "orderNumber": "#12345",
  "skus": [
    { "skuName": "TSHIRT-L-BLK", "asn": "ASN001", "quantity": 2 }
  ],
  "fromAddress": {
    "firstName": "Warehouse",
    "lastName": "Team",
    "phoneNumber": "+12125551234",
    "line1": "123 Warehouse St",
    "city": "New York",
    "province": "NY",
    "country": "US",
    "zipcode": "10001"
  },
  "toAddress": {
    "firstName": "Jane",
    "lastName": "Doe",
    "phoneNumber": "+493012345678",
    "line1": "Unter den Linden 1",
    "city": "Berlin",
    "province": "Berlin",
    "country": "DE",
    "zipcode": "10115"
  },
  "trackReference": "REF-12345",
  "parcelWeight": "500",
  "brandCode": "MYBRAND"
}

When the label is available, the endpoint returns a structured result object.

string

required

The order number to retrieve or generate a label for.

number

Parcel weight. When provided, weightUnit is also required.

string

Unit for the weight field. Required when weight is set. Accepted values: "grams" or "pounds".

number

Parcel length. When any dimension is provided, dimensionsUnit is also required.

number

Parcel width. When any dimension is provided, dimensionsUnit is also required.

number

Parcel height. When any dimension is provided, dimensionsUnit is also required.

string

Unit for length, width, and height. Required when any dimension is set. Accepted values: "cm" or "in".

boolean

When true, the label is returned as a base64-encoded string in addition to the PDF URL.

array

Required for partial label generation. An array of SKU objects describing the items in this parcel.

Show SKU object fields

string

required

The SKU identifier.

string

required

The Advanced Shipment Notice (ASN) reference associated with the SKU.

number

required

Quantity of this SKU included in the parcel.

object

The origin address. Required when skus is provided.

Show Address fields

string

required

First name on the address.

string

required

Last name on the address.

string

required

Phone number including country code (e.g. +12125551234).

string

required

Primary street address line.

string

Secondary address line (apartment, suite, unit, etc.).

string

required

City name.

string

required

State or province code.

string

required

Two-letter ISO 3166-1 alpha-2 country code (e.g. "US", "DE").

string

required

Postal or ZIP code.

object

The destination address. Required when skus is provided.

Show Address fields

string

required

First name on the address.

string

required

Last name on the address.

string

required

Phone number including country code.

string

required

Primary street address line.

string

Secondary address line (apartment, suite, unit, etc.).

string

required

City name.

string

required

State or province code.

string

required

Two-letter ISO 3166-1 alpha-2 country code.

string

required

Postal or ZIP code.

string

A reference string printed directly on the label. Required when skus is provided.

string

Parcel weight in grams. Required when skus is provided.

string

Your brand code as provided by OpenBorder. Required when skus is provided.

string

An optional location code used for partial label consolidation across fulfillment centers.

boolean

When true, the response includes a URL to the label in ZPL format (for thermal printers).

Request Examples

{
  "orderNumber": "#12345"
}

{
  "orderNumber": "#12345",
  "skus": [
    { "skuName": "TSHIRT-L-BLK", "asn": "ASN001", "quantity": 2 }
  ],
  "fromAddress": {
    "firstName": "Warehouse",
    "lastName": "Team",
    "phoneNumber": "+12125551234",
    "line1": "123 Warehouse St",
    "city": "New York",
    "province": "NY",
    "country": "US",
    "zipcode": "10001"
  },
  "toAddress": {
    "firstName": "Jane",
    "lastName": "Doe",
    "phoneNumber": "+493012345678",
    "line1": "Unter den Linden 1",
    "city": "Berlin",
    "province": "Berlin",
    "country": "DE",
    "zipcode": "10115"
  },
  "trackReference": "REF-12345",
  "parcelWeight": "500",
  "brandCode": "MYBRAND"
}

When the label is available, the endpoint returns a structured result object.

Shipping Labels

Landed Cost

Orders

Label Compliance

Get Label – Retrieve a Shipping Label

Endpoints

Authentication

Request Body

Request Examples

Response

Request Examples

Request Examples

​Endpoints

​Authentication

​Request Body

​Request Examples

​Response

​Request Examples

​Request Examples

Endpoints

Authentication

Request Body

Request Examples

Response

Request Examples

Request Examples