Skip to content

Data sharing and API

Three ways to get your shipment data

One shipment record, three routes: Delta Sharing to your data platform, data streaming to your control tower, and our Integrations API to your ERP. Choose based on who needs the data.

Illustrative data

One shipment record

SHP-2026-10442

Status
Shipping
Devices
2
Excursions
0
  • Your data platform

    Delta Sharing · once a day

    BI, analytics, your own AI

  • Your control tower

    Streaming · as devices report

    Each new reading, pushed to you

  • Your ERP and quality systems

    Integrations API · on request and on event

    Create, ask, get told

Each system receives the same shipment data, in the form and at the pace it needs.Source: An invented shipment; the three ways and their pace are the published ones.

Each route serves a different team

Choose by who needs the data and how quickly they need it. Most customers use more than one route.

  • Delta Sharing

    Who uses it
    Your data team, your BI analysts, and the people building your own AI.
    The question it answers
    How did our lanes, sites, and carriers perform last quarter?
    How often data arrives
    Once a day, with the newest information.
    What your team needs
    A data platform or notebook that reads Delta Sharing. Nothing from Controlant to install.

    Delta Sharing, an open protocol

    activation link + credentials file

  • Data streaming

    Who uses it
    A control tower or an operational system that cannot wait a day.
    The question it answers
    Where is the shipment now, and what was its latest reading?
    How often data arrives
    In small batches as the devices report, from hourly to daily, and immediately if there is an alarm.
    What your team needs
    An HTTPS address you run. Your account team switches it on for your API key.

    shipment.data.temperatures.added

    shipment.data.geotraces.added

  • Integrations API

    Who uses it
    Your ERP, your quality system, your logistics partners' systems.
    The question it answers
    Create this shipment. Where is it now? Tell me when it changes.
    How often data arrives
    Whenever your system asks, and pushed to you as soon as something changes, across 20 event types.
    What your team needs
    One API key header and a test environment. Our specialists help.

    POST /api/scm/shipments/create

    42 endpoints · 20 event types

Option 1 · Delta Sharing, for your data team

Your shipment data, in your data platform daily

Delta Sharing is an open protocol for sharing curated tables that your data platform reads directly. Through it you receive the Data Foundation datasets, which cover ongoing and finished shipments.

What the datasets cover

  • Every shipment, with the properties your own systems gave it.
  • Every temperature reading and every location, device by device.
  • Status changes and what happened to each device on the way.
  • Excursions, and the limits each shipment was held to.

Any tool that reads the protocol works the same way, for example Databricks, Apache Spark and Python (pandas). No Controlant software to install.

Setting up Delta Sharing

  1. Step 1

    We create the share

    We set it up for you, for your shipments.

  2. Step 2

    You receive a link and a file

    We share an activation link and credentials file with your data team.

  3. Step 3

    You connect

    You connect directly from your data platform. All your shipment data loads once, then the changes arrive on a daily refresh.

Monitor showing the Supply Chain Soft Spots dashboard for one airport: excursion locations on a satellite map, temperature by hour after arrival, and shipments with excursions by leg
Pinpoint Excursions, Supply Chain Soft Spots view.

What a data team builds on the same datasets

This is a Pinpoint Excursions dashboard for one airport. The Pinpoint data models are shared through the same mechanism, on top of the Data Foundation.

The record stays in the platform

The validated record of each shipment lives in the platform. The shared datasets are curated copies for analytics and BI.

Option 2 · Data streaming, for your control tower

Each new reading, as the device reports it

New temperature and location readings are pushed to an HTTPS address you run, in small batches.

How often
It follows each device's reporting schedule, set per shipment from hourly to daily. A device reports immediately if there is an alarm.
Locations
Traces carry latitude, longitude (WGS 84) and accuracyInMeters.
Switch-on
Your account team enables it for your API key.
Event types
shipment.data.temperatures.addedshipment.data.geotraces.added
POSThttps://your-endpoint.example.com/streamarrives at your address
{  "deliveryId": "…",  "attempt": 1,  "reference": "control-tower-stream",  "eventType": "shipment.data.temperatures.added",  "payloadVersion": "latest",  "environment": "Live",   // lets you ignore payloads that are not Live  "generated": "2026-10-02T08:14:03Z",  "payload": {    "items": [{      "shipmentReference": "SHP-2026-10442",      "loggers": [{        "loggerId": "…",        "temperatures": [          // value is in tenths of a degree Celsius: 52 = 5.2 °C          { "timeStamp": "2026-10-02T08:00:00Z", "value": 52 }        ],        "temperaturesCount": 1      }]    }]  }}

Illustrative. Reference, times, and values are examples.

Option 3 · Integrations API and webhooks, for your ERP and quality systems

Your ERP asks. We tell your systems

Your ERP creates and updates shipments in the Controlant Platform through the API, and your systems, such as your ERP or quality system, pull shipment data and reports whenever they need them. When something happens to a shipment, we call a webhook, an address your systems run, so they know straight away.

Your ERP creates the shipment

POST/api/scm/shipments/createintegrations.controlant.com
Authorization: ApiKey YOUR_API_KEY{  "reference": "SHP-2026-10442",  "description": "Plant A to distribution center",  "originReference": "PLANT-A",  "destinationReference": "DC-EU-1",  "loggerTemplateReference": "LANE-TEMPLATE",  "loggers": [    { "loggerId": "…", "palletReference": "PAL-01" }  ],  "properties": [    { "name": "ERPShipmentRef", "value": "4500012345" }  ]}// The same reference twice returns an error, so a retry never duplicates.

We tell your systems when it moves

POSTshipment.status.changedarrives at your address
x-signature: …   // SHA-512 hash, made with your secret token{  "ShipmentReference": "SHP-2026-10442",  "Status": "Shipping",  "PreviousStatus": "Ready",  "TransitionType": "Manual",  "StatusChangedTimeStamp": "2026-10-02T08:14:03Z",  "EffectiveTimeStamp": "2026-10-02T08:14:03Z"}// Verify x-signature, then answer HTTP 200 within 2 seconds.// Delivery is at least once. Pin payloadVersion to 1.

Also pushed, among 20 event types

shipment.logger.excursion.raisedshipment.product.quality.changedshipment.analysis.completedshipment.report.created

Illustrative. Reference, times, and values are examples.

Try it before it goes live

Your Customer Success Manager issues a test API key along with your live one, so your team can build and test before a real shipment moves.

  • Connectivity test

    POST /api/echo

    Send {"reference": "Test-Echo-Request-01"}. It has no side effects, so you can check your key and connection safely.

  • Simulator

    POST /api/events/simulate

    Sends a simulated payload (mode: Simulated) to your address, so you can build the receiver before a real shipment moves.

  • Test environment

    separate from live

    Its own API key. Every response carries an x-correlation-id for tracing a call.

endpoints in seven groups, in an OpenAPI 3.0.1 reference
42
event types, signed and pushed as they happen
20
header to authenticate: Authorization: ApiKey
1
environments, test and live, each with its own key
2

Pull endpoints cover ongoing shipments and those delivered in the last 30 days. The full history is what the shared datasets are for. Plain JSON over HTTPS.

Read the API reference

AI-ready, with the facts to prove it

Your AI and BI tools can use the shipment data from all three options because it is documented, structured, and versioned, and it arrives in your own platforms.

  • A machine-readable OpenAPI 3.0.1 reference for the whole Integrations API.
  • Plain JSON with pinned, versioned payloads. Pin payloadVersion to 1 and a schema change never breaks your parser.
  • Signed events: every delivery carries an x-signature you can verify.
  • The same shipment reference in every channel: datasets, streaming, API and webhooks.
  • Curated, documented tables, delivered through an open protocol into the platform where your own AI and BI tools already run.
  • A complete audit trail in the platform behind all of it.
In development

An MCP server

The Model Context Protocol is the open standard AI assistants use to read from other systems. We are building an MCP server, so the assistant your team already uses gets read-only access to your shipment data.

Who builds what

Choose how much your team builds. Our team of experts helps either way.

  • Your team builds it

    Your team builds against the published reference, using the test environment and the simulator.

  • We build it with you

    A custom integration, built with us. Our team of experts works alongside yours.

  • Implementation specialistsHelp set up your integration.

  • 24/7 technical supportFor your IT and integration teams.

  • A Customer Solution ArchitectWho issues your API keys.

Getting started with each option

Integrations API and webhooks
API keys come from your Customer Solution Architect. Your account team switches event subscriptions on for your key.
Shared datasets, through Delta Sharing
We create the share. Your data team connects.
Data streaming
Switched on for your API key by your account team.

Questions your IT and data teams may ask

Which of the three do we need?

Most customers use more than one. Your ERP calls the Integrations API to create shipments and receives events when something happens. Your data team reads the shared datasets for reporting and analytics. Streaming is for a control tower or operational system that needs each new reading as the devices report it.

Is the shared data validated?

The Controlant Platform is validated to comply with FDA 21 CFR Part 11 and EU GMP Annex 11, and the validated record of each shipment, with its audit trail, stays there. The shared datasets are curated copies of that record for analytics and BI, and are not a validated system themselves.

What do we need to read Delta Sharing?

A data platform or notebook that reads the Delta Sharing protocol, such as Databricks, Apache Spark, or Python with pandas. We create the share; your data team receives an activation link and a credentials file and connects. Nothing from Controlant is installed on your side, and access can be limited to your own IP ranges.

Can we test the integration before it goes live?

Yes. A separate test environment has its own API key. The echo endpoint checks your connection with no side effects, the simulator sends a simulated event to your address, and the delivery log shows what happened to each event for 180 days.

How do we get streaming and the datasets?

Your account team switches streaming on for your API key and sets up the share for the datasets, and covers both when you discuss pricing.

Bring your integration and data teams to the first call

Bring your data team, your integration team, and your questions, and we will show you which option fits each one.