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:

• https://www.aircargobook.com

• https://demo.aircargobook.com

• http://localhost:8080

Authentication

• API Key (ApiKeyAuth)
  • Parameter Name: auth_token, in: query. Most API methods require a user to be performed. You can create a new user account in your company settings (menu -> manage users and permissions) or you can use at least for testing your own account. Click on the user menu in the upper right corner, select "my business card" and on the right side the button "connect mobile.". You can also follow this link directly https://www.aircargobook.com/users/mobile+connect

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

Responses

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

Detailed descriptions

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

Milkrun import trucking

Milkrun import forwarding

Example responses

200 Response

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

Responses

Response Schema

Status Code 200

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

Example responses

200 Response

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

Responses

Response Schema

Status Code 200

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

Milkrun import trucking & handling

Milkrun import forwarding

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

Response Schema

Status Code 200

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

Example responses

200 Response

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

Responses

Response Schema

Status Code 200

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

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

Response Schema

Status Code 200

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

Response Schema

Status Code 200

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

Response Schema

Status Code 200

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

Response Schema

Status Code 200

Schemas

AuthResponse

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

Properties

Company

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

Properties

Shipment

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

Properties

User

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

Properties