Post your shipment (beta)

Beta notice : this endpoint is part of our v3-suite beta testing phase.
Please note that:

  • The behavior and structure may change before public release.
  • Some features or results may still be incomplete or evolving.

This endpoint allows you to post your shipment by providing the details of the route (locations, assets, carriers...) and of the order shipped (number of containers, container size/type code, etc.).

The response will be a JSON including the status of the shipment creation and the unique identifier of your shipment (id). You can use this id to retrieve the shipment details later or to compute fuel consumption or emissions for the shipment.

Notes and considerations

  • id lifetime: the shipment id remains valid for a limited period (at least 1 hour) in the beta phase and will be persistent in the final release.

Support endpoints and resources

  • Get shipments: use the /v3/shipments/{id} endpoint to retrieve details of the shipment.
  • Retrieve maritime carriers: use our Carriers endpoint to search carriers by SCAC or name.
  • Find locations: use our Geocoding endpoint for location codes.
Language
Credentials
Header
Click Try It! to start a request and see the response here!