GENERATE A CARRIER LABEL VIA API

Benefits of the feature ✨

Shipment automation: generation of carrier labels directly via API.
Data security: validation of payloads before sending to carriers.
Technical flexibility: compatible with Shippingbo OMS or an external OMS.
Time savings: fewer manual interventions on shipped orders.

1. Prerequisites

Have already configured a Shippingbo API application.

More information here: CREATE A SHIPPINGBO API APPLICATION.
Have technical knowledge of how to use APIs (curl, PHP, etc.).

2. How does label generation via API work in Shippingbo?

2.1 Sending the first API request

You can test access and authentication via the endpoint Try your implementation.

➡️Case 1: Using Shippingbo OMS (recommended)

The API returns a default payload with fake labels
No actual call is made to the carrier
Shippingbo checks the consistency of the data sent (e.g. sbo_order_id, address_label_config_id) against your OMS and your settings.

➡️Case 2: Using your own OMS

Since the Shippingbo TMS has no access to your OMS, you must provide more mandatory fields
All logistics information must be included in the API request.

Example: If you use an external OMS, you must send all order and delivery data in the payload so that Shippingbo can generate the labels.

2.2 Going into production

When your system is able to handle all API responses and to process potential errors, you can then use the endpoint Generate labels to generate real carrier labels.

⭐ Key point:

Each carrier has its own validation rules.

➡️ A field may therefore be mandatory for one carrier and not for another.

➡️ Errors of type Missing field may therefore appear depending on the selected carrier; they must be corrected by adding the required fields.

2.3 Marking the shipment as shipped (Shippingbo OMS only)

Once the labels are generated and the parcels are ready, you must inform Shippingbo that the order is shipped using the API call Mark your shipment as shipped.

➡️ The consignment_id must be identical to the one used when calling Generate labels

The Shippingbo order then moves to the status Shipped (all the notifications are triggered automatically: SMS, emails, webhooks, etc.).

3. Example of practical use

Context: An e-merchant using an external OMS automatically generates their Chronopost labels via the Shippingbo TMS API, then triggers the shipment and customer notifications without any manual intervention.

⚒️ Framework and responsibilities:

Before fully using the feature described in this tutorial, we strongly recommend running a test phase with your own settings to check that the result matches your expectations. As the customer remains fully responsible for the actions carried out in the Shippingbo account, these tests are essential to use the tool with complete peace of mind.

To go further 🛫

- Generate a carrier label

- Create an API application

Contact us 📬

Questions about this feature?

Feel free to write to us here so that we can answer your questions.