Placing an order with the v3 API

To place an order, you will use the POST /v3.1/shipping-order endpoint, which requires the complete information of the senders and recipients, the choice of a transport offer and possibly for the international shipments additional information on the content and the reason for the shipment (customsDeclaration parameter).

The choice of the transport offer is made alternately with the parameters shippingOfferCode or shippingOfferId:

• shippingOfferCode, this is to designate the code of a transport offer via the transport offer code repository.
• shippingOfferId, this is to designate a specific offer and contract, in the case where you are using an offer from a hosted contract. Please contact us to retrieve the id to use if you are using a hosted contract.

You can optionally choose to select insurance using the insurance parameter.

Once the order is placed, you can retrieve the Boxtal reference of the order, (shippingOrder > id property).

To retrieve shipping documents and tracking information, you must subscribe to these events.