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

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

city

string

E.g. Bochum

contact_name

string

Name of the contact person

country

string

This shows either the complete country name or the short iso alpha 2 code

object

Partner defined fields for an address

value

object

Partner defined fields for an address

string

Email address

fax

string

Fax number

name

string

Name of the company this address belongs to

phone

string

Phone number

reference_no

string

Unique ID of the address

state

string

E.g. NRW

street

string

E.g. Alleestr. 80

type

string

Enum: "SHIPPER""CONSIGNEE""NOTIFY PARTY"

Address type. We used the values from the OSCA DC System

zip

string

E.g. 44793

booking_no

string

Given booking number from the OSCA system

carrier

string

The scac of the shipping company

array of Container

container_no

string

Container number from forwarder

container_type

string

Container type. We will map the same container types of the connected OSCA system.

object

Partner defined fields for a container

value

object

Partner defined fields for a container

gross_weight

number

Gross weight in kg

handover_location

string

Full hand-over address

provision_date

string <date-time>

Plan date on which the container has to be provided at the handover location

qty_ctn

integer

Quantity of cartons in the container

qty_pallets

integer

Quantity of pallets

reference_no

string

Internal number of the container in the related OSCA system. Use this field only, if you are going to create a new container (uid will be generated by the forwarder api platform)

seal_no

string

Seal number

uid

string

Unique ID of the container, generated by forwarder api platform

vendor_load

boolean

False, if the good has to be load into the container by forwarder

volume

number

Current volume load in cbm

yard_date

string <date-time>

Date on which the container has been provided at the handover location

created_at

string <date-time>

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

object

Partner defined fields for a booking

value

object

Partner defined fields for a booking

object (Partner)

object (Address)

city

string

E.g. Bochum

contact_name

string

Name of the contact person

country

string

This shows either the complete country name or the short iso alpha 2 code

object

Partner defined fields for an address

value

object

Partner defined fields for an address

string

Email address

fax

string

Fax number

name

string

Name of the company this address belongs to

phone

string

Phone number

reference_no

string

Unique ID of the address

state

string

E.g. NRW

street

string

E.g. Alleestr. 80

type

string

Enum: "SHIPPER""CONSIGNEE""NOTIFY PARTY"

Address type. We used the values from the OSCA DC System

zip

string

E.g. 44793

object

Partner defined fields for an partner

value

object

Partner defined fields for an partner

long_name

string

Long name of the partner

partner_nr

string

Partner number of the original system

short_name

string

Short name of the partner

uid

string

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

array of Delivery

additional_info

string

Some additional information that might be related to the logistics information

container_uid

string

Container uid that the order is shipped in. See container.uid

object

Partner defined fields for a delivery

value

object

Partner defined fields for a delivery

customer_refno

string

Human readable identification of the item. The content depends on how the customer wants to communicate about a purchase ordr.

customs_tariff_no

string

Customs tariff number

department

string

Customers department that is in charge of this order

dispatch_type

string

Dispatch type enumeration of possible values FLAT, HANGING

object (Partner)

object (Address)

city

string

E.g. Bochum

contact_name

string

Name of the contact person

country

string

This shows either the complete country name or the short iso alpha 2 code

object

Partner defined fields for an address

value

object

Partner defined fields for an address

string

Email address

fax

string

Fax number

name

string

Name of the company this address belongs to

phone

string

Phone number

reference_no

string

Unique ID of the address

state

string

E.g. NRW

street

string

E.g. Alleestr. 80

type

string

Enum: "SHIPPER""CONSIGNEE""NOTIFY PARTY"

Address type. We used the values from the OSCA DC System

zip

string

E.g. 44793

object

Partner defined fields for an partner

value

object

Partner defined fields for an partner

long_name

string

Long name of the partner

partner_nr

string

Partner number of the original system

short_name

string

Short name of the partner

uid

string

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

item_description

string

Item description

item_number

string

Item number, e.g. article number

item_position

string

Item position

order_date

string <date>

Order date as defined by full-date RFC3339

order_no

string

Purchase order number

order_type

string

Order type as defined in the original database

origin_country

string

Country of origin

qty_ctn

integer

Quantity of cartons

qty_pcs

integer

Quantity of pieces

uid

string

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

unit

string

Unit related to ordered quantities. enumeration of possible values PCS, CTN, SET

version

integer

Version of the delivery, if exists

volume

number

Volume of the delivery, in cbm

weight

number

Chargeable weight of the delivery, in kg

object (Partner)

object (Address)

city

string

E.g. Bochum

contact_name

string

Name of the contact person

country

string

This shows either the complete country name or the short iso alpha 2 code

object

Partner defined fields for an address

value

object

Partner defined fields for an address

string

Email address

fax

string

Fax number

name

string

Name of the company this address belongs to

phone

string

Phone number

reference_no

string

Unique ID of the address

state

string

E.g. NRW

street

string

E.g. Alleestr. 80

type

string

Enum: "SHIPPER""CONSIGNEE""NOTIFY PARTY"

Address type. We used the values from the OSCA DC System

zip

string

E.g. 44793

object

Partner defined fields for an partner

value

object

Partner defined fields for an partner

long_name

string

Long name of the partner

partner_nr

string

Partner number of the original system

short_name

string

Short name of the partner

uid

string

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

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)

value

string

Enum: "PENDING""CONFIRMED""REJECTED""CANCELLED""ARCHIVED"

Status of the booking

object (Partner)

object (Address)

city

string

E.g. Bochum

contact_name

string

Name of the contact person

country

string

This shows either the complete country name or the short iso alpha 2 code

object

Partner defined fields for an address

value

object

Partner defined fields for an address

string

Email address

fax

string

Fax number

name

string

Name of the company this address belongs to

phone

string

Phone number

reference_no

string

Unique ID of the address

state

string

E.g. NRW

street

string

E.g. Alleestr. 80

type

string

Enum: "SHIPPER""CONSIGNEE""NOTIFY PARTY"

Address type. We used the values from the OSCA DC System

zip

string

E.g. 44793

object

Partner defined fields for an partner

value

object

Partner defined fields for an partner

long_name

string

Long name of the partner

partner_nr

string

Partner number of the original system

short_name

string

Short name of the partner

uid

string

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

object (Timetable)

eta	string <date-time> Estimated local time of arrival as defined by date-time - RFC3339
etd	string <date-time> Estimated local time of delivery as defined by date-time - RFC3339
handover	string <date-time> Local time that the supplier hands over the goods to the forwarder on as defined by date-time - RFC3339
incoterm	string Enum: "EXW""FCA""FAS""FOB""CFR""CIF""CPT""CIP""DPU""DAP""DDP"
mot	string Enum: "SEA""AIR""SEA-AIR""TRUCK""RAIL""COURIER" Mode of transportation
poa	string UnLocode of the port of arrival, e.g. DEHAM for DE = Germany, HAM = Hamburg
poa_name	string Full name of the port of arrival. E.g. Hamburg
pol	string UnLocode of the port of loading, e.g. CNSHA for CN = China, SHA = Shanghai
pol_name	string Full name of the port of loading. E.g. Shanghai
service	string Enum: "REGULAR""FAST""A-CLASS""B-CLASS""C-CLASS""FLASH""NORMAL""SPEED""EXPRESS" Service of transportation. Those values are only valid in combination with a mode of transport

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)

object (Address)

city

string

E.g. Bochum

contact_name

string

Name of the contact person

country

string

This shows either the complete country name or the short iso alpha 2 code

object

Partner defined fields for an address

value

object

Partner defined fields for an address

string

Email address

fax

string

Fax number

name

string

Name of the company this address belongs to

phone

string

Phone number

reference_no

string

Unique ID of the address

state

string

E.g. NRW

street

string

E.g. Alleestr. 80

type

string

Enum: "SHIPPER""CONSIGNEE""NOTIFY PARTY"

Address type. We used the values from the OSCA DC System

zip

string

E.g. 44793

object

Partner defined fields for an partner

value

object

Partner defined fields for an partner

long_name

string

Long name of the partner

partner_nr

string

Partner number of the original system

short_name

string

Short name of the partner

uid

string

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

weight

number

Chargeable weight, in kg

Workflow

Setlog Booking API (0.9.0)

Webhooks

POSTReceives Booking Request

Request Body Schema: application/json