Skip to main content
API docs by Redocly

Logistics API (1.0.0)

Download OpenAPI specification:Download

Loads

Search for loads

Search for loads by organisation, carrier and date range

Authorizations:
jwt
query Parameters
limit
integer

Limit page size of results

offset
integer

Number of results to skip for the current page

sortBy
string

Sort results by this field

sortDesc
boolean

Sort results descending if true, otherwise ascending

startDateISO
string

Filter by start date ISO

endDateISO
string

Filter by end date ISO

f:organiserId
string

Filter by organiser

f:carrierId
string

Filter by carrier

f:status
string

Filter by status

query
string

Free text search field for querying

format
string

Format for the endpoint response, supports JSON (default) or CSV

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new load

Create a new load

Authorizations:
jwt
Request Body schema: application/json
Array
organiserId
required
string
organiserName
required
string
commodityId
required
number
reference
required
string
deliveryDateISO
required
string
weight
required
number or null
weightNet
required
number or null
ticketNumber
string
vehicleRegistration
string
required
Array of objects or null
tags
required
Array of strings

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "id": "string",
  • "reference": "string",
  • "organiser": {
    },
  • "carrier": {
    },
  • "commodity": {
    },
  • "deliveryDateISO": "string",
  • "dropoffPostcode": "string",
  • "pickupPostcode": "string",
  • "weight": {
    },
  • "weightNet": {
    },
  • "vehicleRegistration": "string",
  • "ticketNumber": "string",
  • "status": "upcoming",
  • "files": [
    ],
  • "tags": [
    ]
}

Gets loads by IDs

Gets loads by IDs

Authorizations:
jwt
query Parameters
ids
required
string

Comma separated list of ids

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets the details of a load

Gets the details of a load

Authorizations:
jwt
path Parameters
id
required
string

Id of the resource

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "reference": "string",
  • "organiser": {
    },
  • "carrier": {
    },
  • "commodity": {
    },
  • "deliveryDateISO": "string",
  • "dropoffPostcode": "string",
  • "pickupPostcode": "string",
  • "weight": {
    },
  • "weightNet": {
    },
  • "vehicleRegistration": "string",
  • "ticketNumber": "string",
  • "status": "upcoming",
  • "files": [
    ],
  • "tags": [
    ]
}

Send to driver

Sends a notification to the driver of a load

Authorizations:
jwt
Request Body schema: application/json
Array
loadId
required
string
driverId
required
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Search for loads

Search for loads by organisation, carrier and date range

Authorizations:
jwt
query Parameters
limit
integer

Limit page size of results

offset
integer

Number of results to skip for the current page

sortBy
string

Sort results by this field

sortDesc
boolean

Sort results descending if true, otherwise ascending

startDateISO
string

Filter by start date ISO

endDateISO
string

Filter by end date ISO

f:organiserId
string

Filter by organiser

f:carrierId
string

Filter by carrier

f:status
string

Filter by status

query
string

Free text search field for querying

format
string

Format for the endpoint response, supports JSON (default) or CSV

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new load

Create a new load

Authorizations:
jwt
Request Body schema: application/json
Array
organisationId
string
organisationName
string
carrierId
required
string
carrierName
required
string
commodityId
required
number
reference
required
string
deliveryDateISO
required
string
weight
required
number or null
tags
required
Array of strings

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "id": "string",
  • "reference": "string",
  • "organiser": {
    },
  • "carrier": {
    },
  • "commodity": {
    },
  • "deliveryDateISO": "string",
  • "dropoffPostcode": "string",
  • "pickupPostcode": "string",
  • "weight": {
    },
  • "weightNet": {
    },
  • "vehicleRegistration": "string",
  • "ticketNumber": "string",
  • "status": "upcoming",
  • "files": [
    ],
  • "tags": [
    ]
}

Deletes loads

Deletes loads

Authorizations:
jwt
Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Gets loads by IDs

Gets loads by IDs

Authorizations:
jwt
query Parameters
ids
required
string

Comma separated list of ids

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets the details of a load

Gets the details of a load

Authorizations:
jwt
path Parameters
id
required
string

Id of the resource

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "reference": "string",
  • "organiser": {
    },
  • "carrier": {
    },
  • "commodity": {
    },
  • "deliveryDateISO": "string",
  • "dropoffPostcode": "string",
  • "pickupPostcode": "string",
  • "weight": {
    },
  • "weightNet": {
    },
  • "vehicleRegistration": "string",
  • "ticketNumber": "string",
  • "status": "upcoming",
  • "files": [
    ],
  • "tags": [
    ]
}

Send to carrier

Sends a notification to the carrier of a load

Authorizations:
jwt
Request Body schema: application/json
Array
loadId
required
string
carrierId
required
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Gets the details of a load

Gets the details of a load

Authorizations:
jwt
path Parameters
id
required
string

Id of the resource

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "reference": "string",
  • "organiser": {
    },
  • "carrier": {
    },
  • "commodity": {
    },
  • "deliveryDateISO": "string",
  • "dropoffPostcode": "string",
  • "pickupPostcode": "string",
  • "weight": {
    },
  • "weightNet": {
    },
  • "vehicleRegistration": "string",
  • "ticketNumber": "string",
  • "status": "upcoming",
  • "files": [
    ],
  • "tags": [
    ]
}

Upload a batch of loads to process

Upload a batch of loads to process

Authorizations:
jwt
Request Body schema: multipart/form-data
organisationId
string or null
organisationName
string or null
file
required
Array of strings <binary>

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "stack": "string",
  • "code": "string",
  • "body": { },
  • "validation": [
    ]
}

Download loads that have completed

Download loads that have completed

Authorizations:
jwt
query Parameters
startDateISO
string

Filter by start date ISO

endDateISO
string

Filter by end date ISO

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "stack": "string",
  • "code": "string",
  • "body": { },
  • "validation": [
    ]
}

loads

Upload proof of delivery

Upload proof of delivery for loads

Authorizations:
jwt
Request Body schema: application/json
Array
loadId
required
string
weightNet
required
number
ticketNumber
required
string
vehicleRegistration
required
string
required
Array of objects or null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "id": "string",
  • "reference": "string",
  • "organiser": {
    },
  • "carrier": {
    },
  • "commodity": {
    },
  • "deliveryDateISO": "string",
  • "dropoffPostcode": "string",
  • "pickupPostcode": "string",
  • "weight": {
    },
  • "weightNet": {
    },
  • "vehicleRegistration": "string",
  • "ticketNumber": "string",
  • "status": "upcoming",
  • "files": [
    ],
  • "tags": [
    ]
}

Upload proof of delivery

Upload proof of delivery for loads

Authorizations:
jwt
path Parameters
id
required
string

Id of the resource

Request Body schema: application/json
Array
loadId
required
string
weightNet
required
number
ticketNumber
required
string
vehicleRegistration
required
string
required
Array of objects or null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "id": "string",
  • "reference": "string",
  • "organiser": {
    },
  • "carrier": {
    },
  • "commodity": {
    },
  • "deliveryDateISO": "string",
  • "dropoffPostcode": "string",
  • "pickupPostcode": "string",
  • "weight": {
    },
  • "weightNet": {
    },
  • "vehicleRegistration": "string",
  • "ticketNumber": "string",
  • "status": "upcoming",
  • "files": [
    ],
  • "tags": [
    ]
}

Logistics System

Ping api

Ping logistics api

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Execute event

Execute event in logistics module

Authorizations:
jwt
path Parameters
action
required
string

Action to perform

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Update system settings

Change the system settings document in the logistics module

Authorizations:
jwt
Request Body schema: application/json
required
object
level
required
string
filter
required
string or null

Responses

Request samples

Content type
application/json
{
  • "logging": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}