Custom Automations Apps

Logistics
infrastructure for
developers.

ShipThis is the API layer for logistics operations — shipments, quotations, invoices, and the events they emit. First-party JS and Python SDKs. Production-ready in minutes.

All systems operational99.99% uptime
terminal — bash
$ pip install shipthisapi-python
✓ shipthisapi-python 3.1.2 installed

>>> api.connect()
>>> api.get_list('sea_shipment', page=1)
[{ 'id': 'SHP-001', 'status': 'draft' }, ...]
create-shipment.js — shipthisapi-js
import { ShipthisAPI } from 'shipthisapi-js'await api.connect();
const { items } = await api.Shipment.getCustomers();
await api.Shipment.createSeaFreight({
  customer_name: items[0],
  shipment_type: 'import',
});
// → { id: 'SHP-001', status: 'draft' }
Quick start

Up and running in minutes.

Pick your language or call the REST API directly. Same operations, same resources.

1Install the SDKWorks in Node.js ≥18 and the browser. TypeScript types included.
2ConnectInstantiate ShipthisAPI with your API key, org ID, location, and region.
3Fetch reference dataLoad customers and shipment terms before creating a shipment.
4Create a shipmentCall createSeaFreight, createAirLoad, or createLandFtlLoad.
install.sh
# npm
$ npm i shipthisapi-js

# yarn
$ yarn add shipthisapi-js

# pnpm
$ pnpm add shipthisapi-js
create-shipment.js
C58FFF">import { ShipthisAPI } C58FFF">from 'shipthisapi-js';

C58FFF">const api = C58FFF">new ShipthisAPI({
  userType: 'employee',
  organisationId: YOUR_ORG_ID,
  xApiKey: SHIPTHIS_API_KEY,
  locationId: YOUR_LOCATION_ID,
  regionId: YOUR_REGION_ID,
});
C58FFF">await api.connect();

C58FFF">const { items: customers } = C58FFF">await api.Shipment.getCustomers();
C58FFF">const shipment = C58FFF">await api.Shipment.createSeaFreight({
  shipment_name: 'My first shipment',
  customer_name: customers[FFB47A">0],
  shipment_type: 'C58FFF">import',
});
console.log(shipment);
Collection-based REST

One API across every logistics object.

Every resource follows the same pattern — list, create, read, update, delete. Consistent headers across all 20+ collections.

Sea Freight
sea_shipment
Air Freight
air_shipment
Quotations
quotation
Invoice
invoice
Customer
customer
Clearance Job
clearance_job

Resources built for freight forwarding.

Every collection follows the same REST shape. Authentication via x-api-key header. Pagination via page and count params. All requests require organisation, location, and region headers.

Collection-based REST
Every resource at /incollection/{resource} — same GET/POST/PUT/DELETE shape.
Cursor pagination
All list endpoints support page and count params for stable iteration.
API key auth
x-api-key + organisation + location + region headers required on every call.
Multi-modal freight
Sea (FCL/LCL/Bulk/RORO), Air, Land (FTL/LTL), Clearance, Pickup & Delivery.
POST/incollection/sea_shipment200 OK184 ms
Request body
{
  "reqbody": {
    "shipment_class": "house",
    "shipment_type": "import",
    "shipment_name": "My first shipment",
    "customer_name": { "$oid": "cust_id" },
    "shipment_term": { "$oid": "term_id" },
    "hbl_no": "HBL-2026-001"
  },
}
Response
{
  "success": true,
  "data": {
    "items": {
      "_cls_": "sea_shipment",
      "shipment_class": "house",
      "shipment_type": "import"
    }
  },
}