General
This documentation explains the digital processes of the CHI Group together with the interfaces available for them.
The processes are explained in chronological order and are always accompanied by examples.
If you have any questions about the processes or interfaces, you can contact us at the following e-mail address helpdesk@chi-deutschland.com .
Basically, no classic REST API is provided here. Many of our customers use EDI middleware for their interfaces, which often makes it difficult to "serve" many different HTTP endpoints with one interface.
We have chosen to provide a single HTTP endpoint that accepts data types supported by the CHI Group. This includes MAWB + HAWB data for the air cargo import and export process. It is also possible to send work orders for consignments and MAWBs, as well as truck information about an upcoming tour. For us, the link between the MAWB and the HAWBs is also an important information. The incoming data follows the principle "everything can, nothing must".
Throughout the documentation, concrete examples of possible data transmissions are explained and all data fields are described.
Grundsätzlich ist die API Idempotent . Es gibt hier nur eine ... TBD
Staging
POST https://api.staging.chi-deutschland.cloud/v1/Production
POST https://api.production.chi-deutschland.cloud/v1/Headers
Content-Type : application/json
x-chi-api-token : API Key
{
"data": {
"inbound_masters": [{
"mawb_number": "10051770456",
"origin": "ORD",
"destination": "FRA",
"alt_refs": "34523523"
}],
"inbound_shipments": [{
"hawb_number": "ORD12343452",
"origin": "ORD",
"destination": "FRA",
"pieces": 1,
"weight": 230.0,
"consigner": "Engineering Inc",
"consignee": "XYZ GMBH"
},
{
"hawb_number": "ATW12345567",
"origin": "ATW",
"destination": "LNZ",
"pieces": 1,
"weight": 100.5,
"content": "ELECTRICAL SWITCHES",
"alt_refs": "8407003465345621040134",
"consigner": "Test Inc",
"consignee": "Test GmbH"
}
]
},
"actions": {
"attach_shipment": [{
"mawb_number": "10051770456",
"hawb_number": "ORD12343452",
"process_type": "inbound"
},
{
"mawb_number": "10051770456",
"hawb_number": "ATW12345567",
"process_type": "inbound"
}
]
}
}
The newest JSON schema version can be downloaded here .
Changelog
Version
Date
Changes
v1.0
01.03.2020
Initial release
v1.1
18.09.2020
Adding Additional Data Objects so that customers, for example, transmit their own internal consignment numbers with an inbound shipment in order to find this number later in the status messages.
v1.2
15.12.2021
Adding the Inbound Arrival process to enable the announcement of import shipments.
Es gibt Datenfelder die z.B. bei einer Importsendung und bei einer Exportsendung vorkommen. Diese Felder werden hier beschrieben und bei den jeweiligen Datensätzen hierhin referenziert.
Attribute
Description
hazard_class
string
Gefahrgut Klasse. Standardwert wenn nicht gesetzt ist
nonhazardous
additional_data
object
Beliebiges JSON Objekt einfügen das später auf den Statusmeldungen erscheint
Gerade Kunden die Cargo Wise One bei sich einsetzen brauchen die Shipment / Consol ID um die
Statusmeldungen referenzieren zu können. Da wir bei eingehenden Daten auf eine HAWB / MAWB / Manifest
Nummer referenzieren ist additional_data eine Möglichkeit diese Daten mitzuübertragen.
consolidation_type
string
consol
Consol: MAWB hat n verschiedene HAWBs
b2b
Back to back: MAWB hat 1 HAWB mit einer beliebigen HAWB Nummer
iata_direct
IATA direkt: MAWB hat 1 HAWB der die gleiche HAWB Nummer hat wie die MAWB Nummer