Skip to content
Documentation sections

Getting started with the Shipment Management API

The Safecube Shipment Management API manages the shipments of your Safecube web application workspace from your own tools and systems. Use it to:

  • keep the shipments of your workspace in sync with your internal tools, automatically;
  • retrieve the public sharing link of a shipment, to share or embed its tracking without login. A public sharing link can be embedded as an iframe.

The API creates shipments asynchronously, deletes shipments, and searches the public links of several shipments at once. Its base URL is https://api.sinay.ai/safecube/api/v1.

Get access

The Shipment Management API is included in every Safecube plan: there is no access to request. Embedding a public sharing link as an iframe is different: it is part of the white label pack and stays on request, because Safecube must authorize your domain. The Embed a shipment in an iframe page details that request.

Every request is authenticated with your Safecube API key in the API_KEY header, as described on the Authentication page.

Create shipments

POST /public/shipments creates one or more shipments in your workspace, asynchronously.

  • An email is sent to you once the creation process is complete.
  • The email gives the creation status and any errors.

Delete shipments

DELETE /public/shipments deletes one or more shipments from your Safecube workspace. A deleted shipment is no longer updated, no longer triggers alerts and is no longer charged.

POST /public/shipments/search returns the details of shipments of your workspace and their public sharing links.

The public link opens the public shipment page, which requires no login. The page shows:

  • the bill of lading number and the carrier;
  • the origin and the destination, with the departure date and the ETA;
  • a progress bar of the voyage;
  • the ETA, the ETD, the vessel and the number of containers;
  • the timeline of events — date, description, location and vessel — with a button to show them on a map;
  • the containers table — container number, last event, location, last date and status.

When iframe embedding is allowed for your domain, the public link can be embedded in your own pages as an iframe. The Embed a shipment in an iframe page details the integration.