NAV Navigation
Shell Node.js PHP Python

aircargobook api (preview) v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

This document is currently under active development. Please get in contact with our integration team (api@aircargobook.com) before you start developing your own solutions. Changes on the api may occure. We will add you to our ingetration newsletter to prevent conflicts.

Base URLs:

Authentication

Default

post__files_push.json

Code samples

# You can also use wget
curl -X POST https://www.aircargobook.com/files/push.json \
  -H 'Content-Type: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "encoding": "base64",
  "content": "SGVsbG8gV29ybGQ=",
  "name": "sampleFileWithName.txt",
  "action": "ta-logistics.shipment.add"
};
const headers = {
  'Content-Type':'application/json'
};

fetch('https://www.aircargobook.com/files/push.json',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://www.aircargobook.com/files/push.json', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('https://www.aircargobook.com/files/push.json', headers = headers)

print(r.json())

POST /files/push.json

Send a file for further processing

Body parameter

{
  "encoding": "base64",
  "content": "SGVsbG8gV29ybGQ=",
  "name": "sampleFileWithName.txt",
  "action": "ta-logistics.shipment.add"
}

Parameters

Name In Type Required Description
body body object false none
» encoding body string false none
» content body string false file content (encoded base64)
» name body string false none
» action body string false none

Responses

Status Meaning Description Schema
200 OK Received file in good order None
406 Not Acceptable No content provided, error parsing None

shipments

Everything about your shipments

get__routes_enlist_{filterId}.json

Code samples

# You can also use wget
curl -X GET https://www.aircargobook.com/routes/enlist/{filterId}.json \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('https://www.aircargobook.com/routes/enlist/{filterId}.json',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://www.aircargobook.com/routes/enlist/{filterId}.json', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://www.aircargobook.com/routes/enlist/{filterId}.json', headers = headers)

print(r.json())

GET /routes/enlist/{filterId}.json

Requests a list of shipments

Parameters

Name In Type Required Description
filterId path integer true One of multiple id's of predefined filters.

Detailed descriptions

filterId: One of multiple id's of predefined filters.

Milkrun import trucking

filterId Description
73 Upcomming milkrun deliveries
74 Running milkruns
75 Successfully delivered milkruns

Milkrun import forwarding

filterId Description
80 Upcomming milkrun deliveries
81 Selected for delivery
82 Deselected for delivery
83 In delivery
84 Successfully delivered milkrun shipments

Example responses

200 Response

{
  "auth": {
    "email": "string",
    "token": "string",
    "language": "string"
  },
  "data": {
    "routes": [
      {
        "id": 0,
        "from": "string",
        "to": "string",
        "weight": 0,
        "capacity": 0
      }
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK All good Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» auth AuthResponse false none none
»» email string false none Email of current user
»» token string false none Used token
»» language string false none Language of the response (3 letter code)
» data object false none none
»» routes [Shipment] false none none
»»» id integer false none none
»»» from string false none Origin shortcode of a shipment
»»» to string false none Destination shortcode of a shipment
»»» weight integer false none Chargable weight of the shipment in kg
»»» capacity integer false none capacity you need for this shipment in cbm

get__routes_view_{id}.json

Code samples

# You can also use wget
curl -X GET https://www.aircargobook.com/routes/view/{id}.json \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('https://www.aircargobook.com/routes/view/{id}.json',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://www.aircargobook.com/routes/view/{id}.json', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://www.aircargobook.com/routes/view/{id}.json', headers = headers)

print(r.json())

GET /routes/view/{id}.json

Requests a list of shipments

Parameters

Name In Type Required Description
id path integer true Shipments

Example responses

200 Response

{
  "auth": {
    "email": "string",
    "token": "string",
    "language": "string"
  },
  "data": {
    "route": {
      "id": 0,
      "from": "string",
      "to": "string",
      "weight": 0,
      "capacity": 0
    }
  }
}

Responses

Status Meaning Description Schema
200 OK All good Inline
404 Not Found Shipment not found or access denid None

Response Schema

Status Code 200

Name Type Required Restrictions Description
» auth AuthResponse false none none
»» email string false none Email of current user
»» token string false none Used token
»» language string false none Language of the response (3 letter code)
» data object false none none
»» route Shipment false none none
»»» id integer false none none
»»» from string false none Origin shortcode of a shipment
»»» to string false none Destination shortcode of a shipment
»»» weight integer false none Chargable weight of the shipment in kg
»»» capacity integer false none capacity you need for this shipment in cbm

milkrun

Everything about the import

get__milkrun_import_short_{id}.json

Code samples

# You can also use wget
curl -X GET https://www.aircargobook.com/milkrun/import/short/{id}.json \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('https://www.aircargobook.com/milkrun/import/short/{id}.json',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://www.aircargobook.com/milkrun/import/short/{id}.json', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://www.aircargobook.com/milkrun/import/short/{id}.json', headers = headers)

print(r.json())

GET /milkrun/import/short/{id}.json

For monitoring purporses you can use the following api

Milkrun import handling

filterId Description
70 Waiting for selection
71 Selected for delivery
78 To follow-up
72 Deselected from delivery

Milkrun import trucking & handling

filterId Description
73 Upcomming milkrun deliveries
74 Running milkruns
75 Successfully delivered milkruns

Milkrun import forwarding

filterId Description
80 Upcomming milkrun deliveries
81 Selected for delivery
82 Deselected for delivery
83 In delivery
84 Successfully delivered milkrun shipments

Example responses

200 Response

{
  "auth": {
    "email": "string",
    "token": "string",
    "language": "string"
  },
  "data": {
    "shipments": [
      {
        "id": 0,
        "awb": "string",
        "weight": 0,
        "awd_received": "string",
        "nfd_received": "string",
        "special_handling_codes": "string",
        "warehouse_location": "string",
        "flight_number": "string",
        "ata": "string"
      }
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK asdf2 Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» auth #/paths/~1milkrun~1import~1short~1%7Bid%7D.json/get/responses/200/content/application~1json/schema/properties/auth false none none
»» email string false none Email of current user
»» token string false none Used token
»» language string false none Language of the response (3 letter code)
» data object false none none
»» shipments [object] false none none
»»» id integer false none none
»»» awb string false none Master awb
»»» weight integer false none Chargable weight of the shipment in kg
»»» awd_received string false none time when received first awd message
»»» nfd_received string false none time when received first nfd message
»»» special_handling_codes string false none list of contained special handling codes
»»» warehouse_location string false none location in warehouse
»»» flight_number string false none flight number
»»» ata string false none ata

tms

The transport managment system is the core for shipment and tour planning

get__freights_enlist_{id}.json

Code samples

# You can also use wget
curl -X GET https://www.aircargobook.com/freights/enlist/{id}.json \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('https://www.aircargobook.com/freights/enlist/{id}.json',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://www.aircargobook.com/freights/enlist/{id}.json', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://www.aircargobook.com/freights/enlist/{id}.json', headers = headers)

print(r.json())

GET /freights/enlist/{id}.json

For monitoring purporses you can use the following api

In order to follow your tours and shipments, both are represented in lists like the following

TMS

filterId Short Description
51 In planning Contains shipments not planned on tours yet
52 planned shipments Contains shipments planned on tours
53 planned tours Contains planned tours

Example responses

200 Response

{
  "auth": {
    "email": "string",
    "token": "string",
    "language": "string"
  },
  "data": {
    "routes": [
      {
        "id": 0,
        "from": "string",
        "to": "string",
        "weight": 0,
        "capacity": 0
      }
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK asdf2 Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» auth #/paths/~1milkrun~1import~1short~1%7Bid%7D.json/get/responses/200/content/application~1json/schema/properties/auth false none none
»» email string false none Email of current user
»» token string false none Used token
»» language string false none Language of the response (3 letter code)
» data object false none none
»» routes [#/paths/~1freights~1enlist~1%7Bid%7D.json/get/responses/200/content/application~1json/schema/properties/data/properties/routes/items] false none none
»»» id integer false none none
»»» from string false none Origin shortcode of a shipment
»»» to string false none Destination shortcode of a shipment
»»» weight integer false none Chargable weight of the shipment in kg
»»» capacity integer false none capacity you need for this shipment in cbm

auth

Everything about your current user

External documentation

post__users_login.json

Code samples

# You can also use wget
curl -X POST https://www.aircargobook.com/users/login.json

const fetch = require('node-fetch');

fetch('https://www.aircargobook.com/users/login.json',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

request('POST','https://www.aircargobook.com/users/login.json', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

import requests

r = requests.post('https://www.aircargobook.com/users/login.json')

print(r.json())

POST /users/login.json

Authentificates with credentials

asdf

Responses

Status Meaning Description Schema
200 OK All good None

cdr

blabla

get__cdr_cases_index.json

Code samples

# You can also use wget
curl -X GET https://www.aircargobook.com/cdr/cases/index.json \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('https://www.aircargobook.com/cdr/cases/index.json',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://www.aircargobook.com/cdr/cases/index.json', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://www.aircargobook.com/cdr/cases/index.json', headers = headers)

print(r.json())

GET /cdr/cases/index.json

See all your cases

To see all your cases

Example responses

200 Response

{
  "auth": {
    "email": "string",
    "token": "string",
    "language": "string"
  },
  "data": {
    "cases": [
      {
        "id": 0,
        "name": "string",
        "author_user_id": 0,
        "author_company_id": 0,
        "created": "2019-05-17 12:44",
        "modified": "2019-05-17 12:44",
        "_links": [
          {
            "id": 0,
            "author_user_id": 0,
            "author_company_id": 0,
            "created": "2019-05-17 12:44",
            "modified": "2019-05-17 12:44",
            "object": {
              "id": 0,
              "from": "string",
              "to": "string",
              "weight": 0,
              "capacity": 0
            }
          }
        ]
      }
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK asdf2 Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» auth #/paths/~1milkrun~1import~1short~1%7Bid%7D.json/get/responses/200/content/application~1json/schema/properties/auth false none none
»» email string false none Email of current user
»» token string false none Used token
»» language string false none Language of the response (3 letter code)
» data object false none none
»» cases [#/paths/~1cdr~1cases~1index.json/get/responses/200/content/application~1json/schema/properties/data/properties/cases/items] false none none
»»» id integer false none none
»»» name string false none a name, can be used as reference for humans
»»» author_user_id integer false none none
»»» author_company_id integer false none none
»»» created string false none Time when case has been created
»»» modified string false none Time when case has been created
»»» _links [object] false none none
»»»» id integer false none none
»»»» author_user_id integer false none none
»»»» author_company_id integer false none none
»»»» created string false none Time when case has been created
»»»» modified string false none Time when case has been created
»»»» object #/paths/~1freights~1enlist~1%7Bid%7D.json/get/responses/200/content/application~1json/schema/properties/data/properties/routes/items false none none
»»»»» id integer false none none
»»»»» from string false none Origin shortcode of a shipment
»»»»» to string false none Destination shortcode of a shipment
»»»»» weight integer false none Chargable weight of the shipment in kg
»»»»» capacity integer false none capacity you need for this shipment in cbm

post__cdr_cases_add.json

Code samples

# You can also use wget
curl -X POST https://www.aircargobook.com/cdr/cases/add.json \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('https://www.aircargobook.com/cdr/cases/add.json',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://www.aircargobook.com/cdr/cases/add.json', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('https://www.aircargobook.com/cdr/cases/add.json', headers = headers)

print(r.json())

POST /cdr/cases/add.json

Creates a new cdr case without any links, files or anything

To see all your cases

Example responses

200 Response

{
  "auth": {
    "email": "string",
    "token": "string",
    "language": "string"
  },
  "data": {
    "case": {
      "id": 0,
      "name": "string",
      "author_user_id": 0,
      "author_company_id": 0,
      "created": "2019-05-17 12:44",
      "modified": "2019-05-17 12:44",
      "_links": [
        {
          "id": 0,
          "author_user_id": 0,
          "author_company_id": 0,
          "created": "2019-05-17 12:44",
          "modified": "2019-05-17 12:44",
          "object": {
            "id": 0,
            "from": "string",
            "to": "string",
            "weight": 0,
            "capacity": 0
          }
        }
      ]
    }
  }
}

Responses

Status Meaning Description Schema
200 OK Success Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» auth #/paths/~1milkrun~1import~1short~1%7Bid%7D.json/get/responses/200/content/application~1json/schema/properties/auth false none none
»» email string false none Email of current user
»» token string false none Used token
»» language string false none Language of the response (3 letter code)
» data object false none none
»» case #/paths/~1cdr~1cases~1index.json/get/responses/200/content/application~1json/schema/properties/data/properties/cases/items false none none
»»» id integer false none none
»»» name string false none a name, can be used as reference for humans
»»» author_user_id integer false none none
»»» author_company_id integer false none none
»»» created string false none Time when case has been created
»»» modified string false none Time when case has been created
»»» _links [object] false none none
»»»» id integer false none none
»»»» author_user_id integer false none none
»»»» author_company_id integer false none none
»»»» created string false none Time when case has been created
»»»» modified string false none Time when case has been created
»»»» object #/paths/~1freights~1enlist~1%7Bid%7D.json/get/responses/200/content/application~1json/schema/properties/data/properties/routes/items false none none
»»»»» id integer false none none
»»»»» from string false none Origin shortcode of a shipment
»»»»» to string false none Destination shortcode of a shipment
»»»»» weight integer false none Chargable weight of the shipment in kg
»»»»» capacity integer false none capacity you need for this shipment in cbm

get__cdr_cases_view_{id}.json

Code samples

# You can also use wget
curl -X GET https://www.aircargobook.com/cdr/cases/view/{id}.json \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('https://www.aircargobook.com/cdr/cases/view/{id}.json',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://www.aircargobook.com/cdr/cases/view/{id}.json', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://www.aircargobook.com/cdr/cases/view/{id}.json', headers = headers)

print(r.json())

GET /cdr/cases/view/{id}.json

Creates a new cdr case without any links, files or anything

To see all your cases

Example responses

200 Response

{
  "auth": {
    "email": "string",
    "token": "string",
    "language": "string"
  },
  "data": {
    "case": {
      "id": 0,
      "name": "string",
      "author_user_id": 0,
      "author_company_id": 0,
      "created": "2019-05-17 12:44",
      "modified": "2019-05-17 12:44",
      "_links": [
        {
          "id": 0,
          "author_user_id": 0,
          "author_company_id": 0,
          "created": "2019-05-17 12:44",
          "modified": "2019-05-17 12:44",
          "object": {
            "id": 0,
            "from": "string",
            "to": "string",
            "weight": 0,
            "capacity": 0
          }
        }
      ]
    }
  }
}

Responses

Status Meaning Description Schema
200 OK Success Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» auth #/paths/~1milkrun~1import~1short~1%7Bid%7D.json/get/responses/200/content/application~1json/schema/properties/auth false none none
»» email string false none Email of current user
»» token string false none Used token
»» language string false none Language of the response (3 letter code)
» data object false none none
»» case #/paths/~1cdr~1cases~1index.json/get/responses/200/content/application~1json/schema/properties/data/properties/cases/items false none none
»»» id integer false none none
»»» name string false none a name, can be used as reference for humans
»»» author_user_id integer false none none
»»» author_company_id integer false none none
»»» created string false none Time when case has been created
»»» modified string false none Time when case has been created
»»» _links [object] false none none
»»»» id integer false none none
»»»» author_user_id integer false none none
»»»» author_company_id integer false none none
»»»» created string false none Time when case has been created
»»»» modified string false none Time when case has been created
»»»» object #/paths/~1freights~1enlist~1%7Bid%7D.json/get/responses/200/content/application~1json/schema/properties/data/properties/routes/items false none none
»»»»» id integer false none none
»»»»» from string false none Origin shortcode of a shipment
»»»»» to string false none Destination shortcode of a shipment
»»»»» weight integer false none Chargable weight of the shipment in kg
»»»»» capacity integer false none capacity you need for this shipment in cbm

post__cdr_cases_link_{id}.json

Code samples

# You can also use wget
curl -X POST https://www.aircargobook.com/cdr/cases/link/{id}.json \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('https://www.aircargobook.com/cdr/cases/link/{id}.json',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://www.aircargobook.com/cdr/cases/link/{id}.json', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('https://www.aircargobook.com/cdr/cases/link/{id}.json', headers = headers)

print(r.json())

POST /cdr/cases/link/{id}.json

Creates a new link to your cdr case

To see all your cases

Example responses

200 Response

{
  "auth": {
    "email": "string",
    "token": "string",
    "language": "string"
  },
  "data": {
    "routes": [
      {
        "id": 0,
        "from": "string",
        "to": "string",
        "weight": 0,
        "capacity": 0
      }
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK asdf2 Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» auth #/paths/~1milkrun~1import~1short~1%7Bid%7D.json/get/responses/200/content/application~1json/schema/properties/auth false none none
»» email string false none Email of current user
»» token string false none Used token
»» language string false none Language of the response (3 letter code)
» data object false none none
»» routes [#/paths/~1freights~1enlist~1%7Bid%7D.json/get/responses/200/content/application~1json/schema/properties/data/properties/routes/items] false none none
»»» id integer false none none
»»» from string false none Origin shortcode of a shipment
»»» to string false none Destination shortcode of a shipment
»»» weight integer false none Chargable weight of the shipment in kg
»»» capacity integer false none capacity you need for this shipment in cbm

Schemas

AuthResponse

{
  "email": "string",
  "token": "string",
  "language": "string"
}

Properties

Name Type Required Restrictions Description
email string false none Email of current user
token string false none Used token
language string false none Language of the response (3 letter code)

Company

{
  "id": 0,
  "name": "string"
}

Properties

Name Type Required Restrictions Description
id integer false none none
name string false none Name of the company

Shipment

{
  "id": 0,
  "from": "string",
  "to": "string",
  "weight": 0,
  "capacity": 0
}

Properties

Name Type Required Restrictions Description
id integer false none none
from string false none Origin shortcode of a shipment
to string false none Destination shortcode of a shipment
weight integer false none Chargable weight of the shipment in kg
capacity integer false none capacity you need for this shipment in cbm

User

{
  "id": 0,
  "realname": "string"
}

Properties

Name Type Required Restrictions Description
id integer false none none
realname string false none First- and lastname of a specific user