Workflow

Supplier requests booking

Forwarder confirms booking acknowledgement

Forwarder confirms/rejects booking

Flight is changed

Supplier cancels booking

Full container has arrived at POL

Mother airplane has departed from POL

Forwarder uploads documents

Mother airplane is delayed at POA

Container arrival is planned at delivery location

Mother airplane has arrived at POA

Container is unloaded from mother airplane

Container has departed from POA

Container arrival is scheduled at delivery location

Container has arrived at delivery location

Setlog Booking API (0.9.0)

Download OpenAPI specification: Download

E-mail: interfaces@setlog-support.com

The Setlog API provides simple RESTful HTTP interfaces to share your logistics data with your partners

Supplier requests or cancels booking

This request is triggered by the request or cancellation of the booking by supplier in the OSCA system.

Field Name	Field Type	Description
uid	string	Identifies the booking entity. In the outbound shipment messages it is expected to get back the booking uid
customer.uid	string	Identifies the customer for all bookings. In the outbound shipment messages it is expected to get back the customer uid
supplier.uid	string	Identifies the supplier for all bookings
warehouse.uid	string	Identifies the warehouse for all bookings
container.uid	string	Identifies the container within a booking. In the outbound shipment messages it is expected to get back the container uid

Webhooks

POSTReceives Booking Request

Authorizations: apiKey

Header parameter name: apikey

Request Body Schema: application/json

Receives the booking request from OSCA System

array of Address

booking_no

string

Given booking number from the OSCA system

carrier

string

The scac of the shipping company

array of Container

created_at

string <date-time>

Creation time of the booking as defined by date-time RFC3339

object

Partner defined fields for a booking

object (Partner)

array of Delivery

object (Partner)

hbl_hawb

string

House bill of lading/house airway bill from forwarder

qty_ctn

integer

Quantity of cartons

qty_pcs

integer

Quantity of pieces

remark

string

Remark for the booking

object (BookingStatus)

object (Partner)

object (Timetable)

uid

string

Unique ID of the booking. This id is crucial, if it is necessary to relate to this booking in other messages.

updated_at

string <date-time>

Last update time of the booking as defined by date-time RFC3339

version

integer

Version of the booking, if exists. 0 – this is a new booking, larger than 0 – an update of an existing one (according to booking.uid)

vessel_airline

string

Vessel name (for SEA), Airline (for AIR)

volume

number

Volume of the booking, in cbm

voyage_no

string

Voyage number for SEA or AIR

object (Partner)

weight

number

Chargeable weight, in kg

Booking Request

{
  "uid": "DCT-38",
  "reference_no": "38",
  "version": 0,
  "booking_no": "DCT-B000056",
  "created_at": "2025-04-04T08:14:00Z",
  "updated_at": "2025-04-04T08:14:00Z",
  "status": "PENDING",
  "volume": 5.0,
  "weight": 1440.0,
  "qty_pcs": 1000,
  "qty_ctn": 100,
  "container": [
    {
      "uid": "DCT-47",
      "reference_no": "DCT-T000090",
      "container_type": "AIR",
      "vendor_load": false,
      "volume": 5.0,
      "gross_weight": 1440.0,
      "qty_ctn": 100,
      "qty_pallets": 0
    }
  ],
  "address": [
    {
      "reference_no": "DCT-62",
      "name": "Ozone Tekstil Factory Limited",
      "type": "SHIPPER",
      "street": "Yuen Shun Circuit 11",
      "zip": null,
      "city": "Hongkong",
      "country": "HK"
    },
    {
      "reference_no": "DCT-160",
      "name": "DC Logistic Center",
      "type": "NOTIFY PARTY",
      "street": "Alleestraße 80",
      "zip": "45793",
      "city": "Bochum",
      "country": "DE"
    },
    {
      "reference_no": "DCT-95",
      "name": "DC Warehouse",
      "type": "CONSIGNEE",
      "street": "Alleestraße 86",
      "zip": "45793",
      "city": "Bochum",
      "country": "DE"
    }
  ],
  "timetable": {
    "mot": "AIR",
    "service": "B-CLASS",
    "handover": "2025-05-10T00:00:00Z",
    "pol": "HKHKG",
    "pol_name": "Hong Kong",
    "etd": "2025-05-10T00:00:00Z",
    "poa": "DEHAM",
    "poa_name": "Hamburg",
    "eta": "2025-05-11T00:00:00Z",
    "incoterm": "FCA"
  },
  "customer": {
    "uid": "DCT-1",
    "partner_nr": "1",
    "short_name": "DCT"
  },
  "supplier": {
    "uid": "DCT-33",
    "partner_nr": "1102",
    "long_name": "Ozone Tekstil Limited"
  },
  "warehouse": {
    "uid": "DCT-35",
    "partner_nr": "3333",
    "short_name": "DC Logistic Center",
    "long_name": "DC Logistic Center"
  },
  "delivery": [
    {
      "uid": "DCT-98",
      "qty_pcs": 1000,
      "qty_ctn": 100,
      "volume": 5.0,
      "weight": 1440.0,
      "dispatch_type": "FLAT PACKED",
      "container_uid": "DCT-47",
      "customer_refno": "300348-1",
      "order_no": "300348",
      "order_date": "2025-01-23",
      "department": "Department 2",
      "item_number": "703667",
      "item_description": "Jeans Slim Fit",
      "item_position": "1",
      "unit": "PCS",
      "customs_tariff_no": "37646513",
      "factory": {
        "uid": "DCT-30",
        "partner_nr": "9747",
        "long_name": "Ozone Tekstil Factory Limited"
      }
    }
  ]
}