Integrating a transport system

The point of integrating a consignment system is to make the printing of documents required for shipping an integral part of the packing process.

For an example of an integration to a consignment system, you can take a look at our integration to GLS.

Listening for events

Shipment created

When a shipment is created you may want to decide upon a carrier. You could for instance do that based on weight, volume and destination country. After deciding on a carrier, you can use the PATCH /shipments method to set the carrier of the shipment.

Transport booking created

When a transport booking is created you should request labels and other required documents for the shipment from the carrier.

You must set the tracking number of each shipping container. You can do that using the PATCH /shippingContainers method.

You must set the carriers shipment number attribute of the shipment. You can do that using the PATCH /shipments method.

If an error occurs when requesting documents from the carrier, you should save the error in Thetis IMS using the POST /eventMessages method.

You can print the documents using the printResource method of the RPC interface.

Consignment note created

When shipments have been consigned to the carrier you may want to inform the carrier.