RouteLogic Documentation

Introduction

Base URL: http://localhost

This documentation aims to provide all the information you need to work with the RouteLogic API.

As you scroll, you'll see code examples for working with the API in different programming languages in the dark area to the right (or as part of the content on mobile). You can switch the language used with the tabs at the top right (or from the nav menu at the top left on mobile).

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {YOUR_API_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting your account click your name and go to synchronisation.

V2

Tasks

Tasks are the deliveries or pickups that need to be done by your drivers.

GET Tasks

GET

http://localhost

/api/v2/tasks

requires authentication

Get paginated collection of tasks from your company

RateLimit (5/min)
If you like to receive tasks quicker, use webhooks read more here

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

Query Parameters

filters

object

filters.search

string

Search for specific tasks. (customer name, city, street, house number, postal, external identifier and external reference). Must not be greater than 128 characters.

Example:

Amsterdam

filters.from_date

string

Find tasks on this date and later. Combine with to_date to select a specific day or a range. Must be a valid date in the format Y-m-d.

Example:

2026-08-27

filters.to_date

string

Find tasks on this date and earlier. Combine with from_date to select a specific day or a range. Must be a valid date in the format Y-m-d.

Example:

2026-08-27

filters.types

string[]

Filter on specific task types.

Must be one of:

delivery
pickup
recurring

Example:

["pickup"]

filters.statuses

string[]

Filter on tasks with a specific status.

Must be one of:

planned
not_planned
delivered
delivery_failed

Example:

["not_planned"]

filters.deleted

string

Include or only return deleted items in the response. Leave empty to not show deleted items at all.

Must be one of:

include
only

Example:

only

filters.limit

integer

Amount of items on each page. 24 by default. Must not be greater than 100. Must be at least 1.

Example:

filters.page

integer

Must be at least 1.

Example:

Response Fields

data

object

data

object[]

Collection of tasks

object

uuid

string

The uuid of this task

type

string

enum(delivery|pickup|shipment) The type of this task

external_identifier

string

Unique identifier like order number

external_reference

string|null

Reference for api connections

note

string|null

Internal note for the driver / note from customer on order for the driver

custom_field_1

string|null

Custom field for attaching extra data to a task, displayed in the driver app.

custom_field_2

string|null

Custom field for attaching extra data to a task, displayed in the driver app.

custom_field_3

string|null

Custom field for attaching extra data to a task, displayed in the driver app.

custom_field_4

string|null

Custom field for attaching extra data to a task, displayed in the driver app.

pending_payment_amount

number

Amount the customer needs to pay on delivery

external_link

string|null

Link visible on the track and trace page like a bill

track_and_trace_link

string

Link to the track and trace page

delivery_from_date

string|null

The earliest date the task is allowed to be completed

delivery_date

string

The date the task is supposed to be completed

start_time

string|null

The time window start time. Timezone: Europe/Amsterdam

end_time

string|null

The time window end time. Timezone: Europe/Amsterdam

delivery_duration_minutes

integer

The time needed on location to complete the task

return_required

boolean

Specifies if the task should also have a corresponding 'pickup' task

signature_required

boolean

If the customer is required to place a signature for this task

used_capacity_1

integer

The amount of capacity this task takes

used_capacity_2

integer

The amount of capacity this task takes

used_capacity_3

integer

The amount of capacity this task takes

created_at

string

Date and time when this task was created

updated_at

string

Date and time when this task was updated

tags[]

string[]

The identifier of a tag. Tasks with a tag will only be planned in to vehicles with the same tag.

return_task_uuid

string|null

The uuid of a related return task if available

notification_template_uuid

string|null

The uuid of the related notification template, null if using the default template

recurring

object|null

Recurring information

address

object

Address information

street

string

The street name

house_number

string

The house number

house_number_extension

string|null

Extra information about the house number

postal_code

string

The postal code

city

string

The city

latitude

number

The latitude of the address

longitude

number

The longitude of the address

country

object

Country information

customer

object

Customer information

additional_emails

object[]|null

Additional email recipients for notifications. Maximum 5.

next_visit

object|null

Information of the next visit. Keep in mind that this is the next visit if u make use of recurring tasks then tasks can have more than 1 visit. This might not be the visit information u are expecting then. Please use the schedule endpoint to relate to the right visit.

uuid

string

The uuid of this visit

type

string

enum(start|end|task|break|charge) The type of visit

order_index

integer

Index on which order the visits should be visited

delivery_time

string

The time which this visit should be completed

delivered_at

string|null

Date and time when this visit was completed

task_uuid

string|null

The related task to this visit

address

object|null

Address information

street

string

The street name

house_number

string

The house number

house_number_extension

string|null

Extra information about the house number

postal_code

string

The postal code

city

string

The city

latitude

number

The latitude of the address

longitude

number

The longitude of the address

country[]

object

Country information

country

object

scanned_codes

object[]|null

Collection of ScannedCodes

returnable_packaging

object[]|null

Collection of Returnable packaging

data

object

files

object[]|null

Collection of Files

signature

string

The key of this file. Used for retrieving the file through the files endpoint.

shipment_steps

object|null

The shipment steps when a task has a shipment type. Shipments always consist of exactly 2 steps: pickup and delivery. The pickup step must be executed before the delivery step.

pickup

object

The pickup step of the shipment.

delivery_duration_minutes

integer

The time needed on location to complete this step.

start_time

string

The time window start time for the pickup. Timezone: Europe/Amsterdam

end_time

string

The time window end time for the pickup. Timezone: Europe/Amsterdam

address

object

Address information for the pickup location.

street

string

The street name

house_number

string

The house number

house_number_extension

string|null

Extra information about the house number

postal_code

string

The postal code

city

string

The city

latitude

number

The latitude of the address

longitude

number

The longitude of the address

country

object

Country information

delivery

object

The delivery step of the shipment.

delivery_duration_minutes

integer

The time needed on location to complete this step.

start_time

string

The time window start time for the delivery. Timezone: Europe/Amsterdam

end_time

string

The time window end time for the delivery. Timezone: Europe/Amsterdam

address

object

Address information for the delivery location.

street

string

The street name

house_number

string

The house number

house_number_extension

string|null

Extra information about the house number

postal_code

string

The postal code

city

string

The city

latitude

number

The latitude of the address

longitude

number

The longitude of the address

country

object

Country information

POST Tasks

POST

http://localhost

/api/v2/tasks

requires authentication

Create a task for your company. If the task already exists it will be updated based on the external identifier.

RateLimit (60/min)

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

Content-Type

Example:

application/json

Body Parameters

type

string

The type of this task.

Must be one of:

delivery
pickup
shipment

Example:

delivery

external_identifier

string

required

Unique identifier like order number. Must not be greater than 255 characters.

Example:

bktsoiory

external_reference

string

Reference for api connections. Must not be greater than 255 characters.

Example:

lfsgvjkuzdgtyuoh

custom_field_1

string

Custom field for attaching extra data to a task, displayed in the driver app. Must not be greater than 255 characters.

Example:

foludgjmkcdypdxse

custom_field_2

string

Custom field for attaching extra data to a task, displayed in the driver app. Must not be greater than 255 characters.

Example:

leohwmg

custom_field_3

string

Custom field for attaching extra data to a task, displayed in the driver app. Must not be greater than 255 characters.

Example:

adt

custom_field_4

string

Custom field for attaching extra data to a task, displayed in the driver app. Must not be greater than 255 characters.

Example:

djc

note

string

Internal note for the driver / note from customer on order for the driver. Must not be greater than 20000 characters.

Example:

Please deliver at the side door.

pending_payment_amount

number

Amount the customer needs to pay on delivery. Must be at least 0. Must not be greater than 99999999.99.

Example:

100

external_link

string

Link visible on the track and trace page like a bill. Must not be greater than 2048 characters.

Example:

https://example.com/

delivery_from_date

string

The earliest date the task is allowed to be completed. Must be a valid date. Must be a date before or equal to delivery_date.

Example:

2022-07-11

start_time

string

The time window start time. Timezone: Europe/Amsterdam. This value can be null if the task should be an appointment and you have the appointments addon. Must be a valid date in the format H:i.

Example:

08:00

end_time

string

The time window end time. Timezone: Europe/Amsterdam. This value can be null if the task should be an appointment and you have the appointments addon. Must be a valid date in the format H:i. Must be a date after start_time.

Example:

17:00

delivery_duration_minutes

integer

The time needed on location to complete the task. Must be at least 0. Must not be greater than 1440.

Example:

return_required

boolean

Specifies if the task should also have a corresponding "pickup" task.

return_task_uuid

string

The uuid of the corresponding "pickup" task. Must be a valid UUID.

Example:

3ec110cf-f7e7-3373-a2c3-c2054867f8c1

signature_required

boolean

If the customer is required to place a signature for this task.

Example:

used_capacity

number

The amount of capacity this task takes. Must be at least 0. Must not be greater than 99999999.99.

Example:

used_capacity_2

number

The amount of capacity this task takes. Must be at least 0. Must not be greater than 99999999.99.

Example:

used_capacity_3

number

The amount of capacity this task takes. Must be at least 0. Must not be greater than 99999999.99.

Example:

notification_template_uuid

string

The uuid of the related notification template, null if using the default template. Must be a valid UUID.

Example:

c3423400-a2fe-37eb-a4e4-940f7fb7cc31

recurring

object

Recurring information.

period

string

When a task is recurring. This field is required when recurring is present.

Must be one of:

week
month

Example:

week

interval

integer

The interval at which the task is repeated. This field is required when recurring is present. Must be at least 1. Must not be greater than 60.

Example:

settings

string

Settings when to repeat.

With a period of a week:
Example: [1,3,5] means that the task is repeated every monday, wednesday and friday

With a period of a month:
Example: ["number", 10] means the task is repeated on the 10th of every month.
Example: ["string", "third", "monday"] means the task is repeated on the third Monday of every month.

. This field is required when recurring is present.

Example:

["string", "third", "monday"]

end_date

string

When recurring should end. Must be a valid date. Must be a date after or equal to delivery_date.

Example:

2028-05-28

address

object

house_number

string

The house number. Must not be greater than 255 characters.

Example:

house_number_extension

string

Extra information about the house number. Must not be greater than 255 characters.

Example:

street

string

The street name. This field is required when address.latitude or address.longitude is not present. Must not be greater than 255 characters.

Example:

LongStreet

postal_code

string

The postal code. This field is required when address.latitude or address.longitude is not present. Must not be greater than 255 characters.

Example:

1234AB

city

string

The city. This field is required when address.latitude or address.longitude is not present. Must not be greater than 255 characters.

Example:

Amsterdam

country

string

required

The iso code of the country. Must match an existing stored value.

Example:

latitude

number

The latitude of the address. This field is required when address.city, address.street, or address.postal_code is not present. This field is required when address.longitude is present. Must be at least -90. Must not be greater than 90.

Example:

52.3676

longitude

number

The longitude of the address. This field is required when address.city, address.street, or address.postal_code is not present. This field is required when address.latitude is present. Must be at least -180. Must not be greater than 180.

Example:

4.9041

customer

object

additional_emails

object[]

Additional email recipients for notifications. Maximum 5 entries. Must not have more than 5 items.

tags

string[]

The identifier of a tag. Tasks with a tag will only be planned in to vehicles with the same tag. This field is required when tags is present. Must not be greater than 250 characters.

Example:

["cooled"]

delivery_date

string

required

The date the task is supposed to be completed. This value can be null if the task should be an appointment and you have the appointments addon. Must be a valid date.

Example:

2026-08-27T14:37:39

pickup_address

object

Pickup address information (required for shipment tasks). This field is required when type is shipment.

street

string

The pickup street name. This field is required when pickup_address.latitude or pickup_address.longitude is not present. Must not be greater than 255 characters.

Example:

PickupStreet

house_number

string

The pickup house number. This field is required when pickup_address.latitude or pickup_address.longitude is not present. Must not be greater than 255 characters.

Example:

postal_code

string

The pickup postal code. This field is required when pickup_address.latitude or pickup_address.longitude is not present. Must not be greater than 255 characters.

Example:

5678CD

city

string

The pickup city. This field is required when pickup_address.latitude or pickup_address.longitude is not present. Must not be greater than 255 characters.

Example:

Rotterdam

country

string

required

The iso code of the pickup country. Must match an existing stored value.

Example:

latitude

number

The latitude of the pickup address. This field is required when pickup_address.city, pickup_address.street, or pickup_address.postal_code is not present. This field is required when pickup_address.longitude is present. Must be at least -90. Must not be greater than 90.

Example:

52.3676

longitude

number

The longitude of the pickup address. This field is required when pickup_address.city, pickup_address.street, or pickup_address.postal_code is not present. This field is required when pickup_address.latitude is present. Must be at least -180. Must not be greater than 180.

Example:

4.9041

pickup_start_time

string

The pickup time window start time (for shipment tasks). Must be a valid date in the format H:i.

Example:

09:00

pickup_end_time

string

The pickup time window end time (for shipment tasks). Must be a valid date in the format H:i. Must be a date after pickup_start_time.

Example:

11:00

pickup_delivery_duration_minutes

integer

The time needed at pickup location to complete the pickup (for shipment tasks). Must be at least 0. Must not be greater than 1440.

Example:

Response Fields

uuid

string

The uuid of this task

type

string

enum(delivery|pickup|shipment) The type of this task

external_identifier

string

Unique identifier like order number

external_reference

string|null

Reference for api connections

note

string|null

Internal note for the driver / note from customer on order for the driver

custom_field_1

string|null

Custom field for attaching extra data to a task, displayed in the driver app.

custom_field_2

string|null

Custom field for attaching extra data to a task, displayed in the driver app.

custom_field_3

string|null

Custom field for attaching extra data to a task, displayed in the driver app.

custom_field_4

string|null

Custom field for attaching extra data to a task, displayed in the driver app.

pending_payment_amount

number

Amount the customer needs to pay on delivery

external_link

string|null

Link visible on the track and trace page like a bill

track_and_trace_link

string

Link to the track and trace page

delivery_from_date

string|null

The earliest date the task is allowed to be completed

delivery_date

string

The date the task is supposed to be completed

start_time

string|null

The time window start time. Timezone: Europe/Amsterdam

end_time

string|null

The time window end time. Timezone: Europe/Amsterdam

delivery_duration_minutes

integer

The time needed on location to complete the task

return_required

boolean

Specifies if the task should also have a corresponding 'pickup' task

signature_required

boolean

If the customer is required to place a signature for this task

used_capacity_1

integer

The amount of capacity this task takes

used_capacity_2

integer

The amount of capacity this task takes

used_capacity_3

integer

The amount of capacity this task takes

created_at

string

Date and time when this task was created

updated_at

string

Date and time when this task was updated

tags[]

string[]

The identifier of a tag. Tasks with a tag will only be planned in to vehicles with the same tag.

return_task_uuid

string|null

The uuid of a related return task if available

notification_template_uuid

string|null

The uuid of the related notification template, null if using the default template

recurring

object|null

Recurring information

address

object

Address information

street

string

The street name

house_number

string

The house number

house_number_extension

string|null

Extra information about the house number

postal_code

string

The postal code

city

string

The city

latitude

number

The latitude of the address

longitude

number

The longitude of the address

country

object

Country information

customer

object

Customer information

additional_emails

object[]|null

Additional email recipients for notifications. Maximum 5.

next_visit

object|null

uuid

string

The uuid of this visit

type

string

enum(start|end|task|break|charge) The type of visit

order_index

integer

Index on which order the visits should be visited

delivery_time

string

The time which this visit should be completed

delivered_at

string|null

Date and time when this visit was completed

task_uuid

string|null

The related task to this visit

address

object|null

Address information

street

string

The street name

house_number

string

The house number

house_number_extension

string|null

Extra information about the house number

postal_code

string

The postal code

city

string

The city

latitude

number

The latitude of the address

longitude

number

The longitude of the address

country[]

object

Country information

country

object

scanned_codes

object[]|null

Collection of ScannedCodes

returnable_packaging

object[]|null

Collection of Returnable packaging

data

object

files

object[]|null

Collection of Files

data

object

shipment_steps

object|null

The shipment steps when a task has a shipment type. Shipments always consist of exactly 2 steps: pickup and delivery. The pickup step must be executed before the delivery step.

pickup

object

The pickup step of the shipment.

delivery_duration_minutes

integer

The time needed on location to complete this step.

start_time

string

The time window start time for the pickup. Timezone: Europe/Amsterdam

end_time

string

The time window end time for the pickup. Timezone: Europe/Amsterdam

address

object

Address information for the pickup location.

street

string

The street name

house_number

string

The house number

house_number_extension

string|null

Extra information about the house number

postal_code

string

The postal code

city

string

The city

latitude

number

The latitude of the address

longitude

number

The longitude of the address

country

object

Country information

delivery

object

The delivery step of the shipment.

delivery_duration_minutes

integer

The time needed on location to complete this step.

start_time

string

The time window start time for the delivery. Timezone: Europe/Amsterdam

end_time

string

The time window end time for the delivery. Timezone: Europe/Amsterdam

address

object

Address information for the delivery location.

street

string

The street name

house_number

string

The house number

house_number_extension

string|null

Extra information about the house number

postal_code

string

The postal code

city

string

The city

latitude

number

The latitude of the address

longitude

number

The longitude of the address

country

object

Country information

Auth

Bearer

Headers

Body

{ "type": "delivery", "external_identifier": "bktsoiory", "external_reference": "lfsgvjkuzdgtyuoh", "custom_field_1": "foludgjmkcdypdxse", "custom_field_2": "leohwmg", "custom_field_3": "adt", "custom_field_4": "djc", "note": "Please deliver at the side door.", "pending_payment_amount": 100, "external_link": "https:\/\/example.com\/", "delivery_from_date": "2022-07-11", "start_time": "08:00", "end_time": "17:00", "delivery_duration_minutes": 10, "return_required": false, "return_task_uuid": "3ec110cf-f7e7-3373-a2c3-c2054867f8c1", "signature_required": true, "used_capacity": 16, "used_capacity_2": 1, "used_capacity_3": 7, "notification_template_uuid": "c3423400-a2fe-37eb-a4e4-940f7fb7cc31", "recurring": { "period": "week", "interval": 9, "settings": "[\"string\", \"third\", \"monday\"]", "end_date": "2028-05-28" }, "address": { "house_number": "12", "house_number_extension": "1A", "street": "LongStreet", "postal_code": "1234AB", "city": "Amsterdam", "country": "NL", "latitude": 52.3676, "longitude": 4.9041 }, "customer": { "email": "[email protected]", "phone_number": "+01 234567890", "name": "Andrew" }, "additional_emails": [ { "email": "[email protected]", "type": "cc" } ], "tags": [ "cooled" ], "delivery_date": "2026-08-27T14:37:39", "pickup_address": { "street": "PickupStreet", "house_number": "42", "postal_code": "5678CD", "city": "Rotterdam", "country": "NL", "latitude": 52.3676, "longitude": 4.9041 }, "pickup_start_time": "09:00", "pickup_end_time": "11:00", "pickup_delivery_duration_minutes": 15 }

Received response

Example request:

curl --request POST \
    "http://localhost/api/v2/tasks" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"type\": \"delivery\",
    \"external_identifier\": \"bktsoiory\",
    \"external_reference\": \"lfsgvjkuzdgtyuoh\",
    \"custom_field_1\": \"foludgjmkcdypdxse\",
    \"custom_field_2\": \"leohwmg\",
    \"custom_field_3\": \"adt\",
    \"custom_field_4\": \"djc\",
    \"note\": \"Please deliver at the side door.\",
    \"pending_payment_amount\": 100,
    \"external_link\": \"https:\\/\\/example.com\\/\",
    \"delivery_from_date\": \"2022-07-11\",
    \"start_time\": \"08:00\",
    \"end_time\": \"17:00\",
    \"delivery_duration_minutes\": 10,
    \"return_required\": false,
    \"return_task_uuid\": \"3ec110cf-f7e7-3373-a2c3-c2054867f8c1\",
    \"signature_required\": true,
    \"used_capacity\": 16,
    \"used_capacity_2\": 1,
    \"used_capacity_3\": 7,
    \"notification_template_uuid\": \"c3423400-a2fe-37eb-a4e4-940f7fb7cc31\",
    \"recurring\": {
        \"period\": \"week\",
        \"interval\": 9,
        \"settings\": \"[\\\"string\\\", \\\"third\\\", \\\"monday\\\"]\",
        \"end_date\": \"2028-05-28\"
    },
    \"address\": {
        \"house_number\": \"12\",
        \"house_number_extension\": \"1A\",
        \"street\": \"LongStreet\",
        \"postal_code\": \"1234AB\",
        \"city\": \"Amsterdam\",
        \"country\": \"NL\",
        \"latitude\": 52.3676,
        \"longitude\": 4.9041
    },
    \"customer\": {
        \"email\": \"[email protected]\",
        \"phone_number\": \"+01 234567890\",
        \"name\": \"Andrew\"
    },
    \"tags\": [
        \"cooled\"
    ],
    \"delivery_date\": \"2026-08-27T14:37:39\",
    \"pickup_address\": {
        \"street\": \"PickupStreet\",
        \"house_number\": \"42\",
        \"postal_code\": \"5678CD\",
        \"city\": \"Rotterdam\",
        \"country\": \"NL\",
        \"latitude\": 52.3676,
        \"longitude\": 4.9041
    },
    \"pickup_start_time\": \"09:00\",
    \"pickup_end_time\": \"11:00\",
    \"pickup_delivery_duration_minutes\": 15,
    \"additional_emails\": [
        {
            \"email\": \"[email protected]\",
            \"type\": \"cc\"
        }
    ]
}"

$client = new \GuzzleHttp\Client();
$url = 'http://localhost/api/v2/tasks';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_KEY}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'type' => 'delivery',
            'external_identifier' => 'bktsoiory',
            'external_reference' => 'lfsgvjkuzdgtyuoh',
            'custom_field_1' => 'foludgjmkcdypdxse',
            'custom_field_2' => 'leohwmg',
            'custom_field_3' => 'adt',
            'custom_field_4' => 'djc',
            'note' => 'Please deliver at the side door.',
            'pending_payment_amount' => 100.0,
            'external_link' => 'https://example.com/',
            'delivery_from_date' => '2022-07-11',
            'start_time' => '08:00',
            'end_time' => '17:00',
            'delivery_duration_minutes' => 10,
            'return_required' => false,
            'return_task_uuid' => '3ec110cf-f7e7-3373-a2c3-c2054867f8c1',
            'signature_required' => true,
            'used_capacity' => 16,
            'used_capacity_2' => 1,
            'used_capacity_3' => 7,
            'notification_template_uuid' => 'c3423400-a2fe-37eb-a4e4-940f7fb7cc31',
            'recurring' => ['period' => 'week', 'interval' => 9, 'settings' => '["string", "third", "monday"]', 'end_date' => '2028-05-28'],
            'address' => ['house_number' => '12', 'house_number_extension' => '1A', 'street' => 'LongStreet', 'postal_code' => '1234AB', 'city' => 'Amsterdam', 'country' => 'NL', 'latitude' => 52.3676, 'longitude' => 4.9041],
            'customer' => ['email' => '[email protected]', 'phone_number' => '+01 234567890', 'name' => 'Andrew'],
            'tags' => ['cooled'],
            'delivery_date' => '2026-08-27T14:37:39',
            'pickup_address' => ['street' => 'PickupStreet', 'house_number' => '42', 'postal_code' => '5678CD', 'city' => 'Rotterdam', 'country' => 'NL', 'latitude' => 52.3676, 'longitude' => 4.9041],
            'pickup_start_time' => '09:00',
            'pickup_end_time' => '11:00',
            'pickup_delivery_duration_minutes' => 15,
            'additional_emails' => [
                ['email' => '[email protected]', 'type' => 'cc'],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "http://localhost/api/v2/tasks"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "type": "delivery",
    "external_identifier": "bktsoiory",
    "external_reference": "lfsgvjkuzdgtyuoh",
    "custom_field_1": "foludgjmkcdypdxse",
    "custom_field_2": "leohwmg",
    "custom_field_3": "adt",
    "custom_field_4": "djc",
    "note": "Please deliver at the side door.",
    "pending_payment_amount": 100,
    "external_link": "https:\/\/example.com\/",
    "delivery_from_date": "2022-07-11",
    "start_time": "08:00",
    "end_time": "17:00",
    "delivery_duration_minutes": 10,
    "return_required": false,
    "return_task_uuid": "3ec110cf-f7e7-3373-a2c3-c2054867f8c1",
    "signature_required": true,
    "used_capacity": 16,
    "used_capacity_2": 1,
    "used_capacity_3": 7,
    "notification_template_uuid": "c3423400-a2fe-37eb-a4e4-940f7fb7cc31",
    "recurring": {
        "period": "week",
        "interval": 9,
        "settings": "[\"string\", \"third\", \"monday\"]",
        "end_date": "2028-05-28"
    },
    "address": {
        "house_number": "12",
        "house_number_extension": "1A",
        "street": "LongStreet",
        "postal_code": "1234AB",
        "city": "Amsterdam",
        "country": "NL",
        "latitude": 52.3676,
        "longitude": 4.9041
    },
    "customer": {
        "email": "[email protected]",
        "phone_number": "+01 234567890",
        "name": "Andrew"
    },
    "tags": [
        "cooled"
    ],
    "delivery_date": "2026-08-27T14:37:39",
    "pickup_address": {
        "street": "PickupStreet",
        "house_number": "42",
        "postal_code": "5678CD",
        "city": "Rotterdam",
        "country": "NL",
        "latitude": 52.3676,
        "longitude": 4.9041
    },
    "pickup_start_time": "09:00",
    "pickup_end_time": "11:00",
    "pickup_delivery_duration_minutes": 15,
    "additional_emails": [
        {
            "email": "[email protected]",
            "type": "cc"
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

import requests
import json

url = 'http://localhost/api/v2/tasks'
payload = {
    "type": "delivery",
    "external_identifier": "bktsoiory",
    "external_reference": "lfsgvjkuzdgtyuoh",
    "custom_field_1": "foludgjmkcdypdxse",
    "custom_field_2": "leohwmg",
    "custom_field_3": "adt",
    "custom_field_4": "djc",
    "note": "Please deliver at the side door.",
    "pending_payment_amount": 100,
    "external_link": "https:\/\/example.com\/",
    "delivery_from_date": "2022-07-11",
    "start_time": "08:00",
    "end_time": "17:00",
    "delivery_duration_minutes": 10,
    "return_required": false,
    "return_task_uuid": "3ec110cf-f7e7-3373-a2c3-c2054867f8c1",
    "signature_required": true,
    "used_capacity": 16,
    "used_capacity_2": 1,
    "used_capacity_3": 7,
    "notification_template_uuid": "c3423400-a2fe-37eb-a4e4-940f7fb7cc31",
    "recurring": {
        "period": "week",
        "interval": 9,
        "settings": "[\"string\", \"third\", \"monday\"]",
        "end_date": "2028-05-28"
    },
    "address": {
        "house_number": "12",
        "house_number_extension": "1A",
        "street": "LongStreet",
        "postal_code": "1234AB",
        "city": "Amsterdam",
        "country": "NL",
        "latitude": 52.3676,
        "longitude": 4.9041
    },
    "customer": {
        "email": "[email protected]",
        "phone_number": "+01 234567890",
        "name": "Andrew"
    },
    "tags": [
        "cooled"
    ],
    "delivery_date": "2026-08-27T14:37:39",
    "pickup_address": {
        "street": "PickupStreet",
        "house_number": "42",
        "postal_code": "5678CD",
        "city": "Rotterdam",
        "country": "NL",
        "latitude": 52.3676,
        "longitude": 4.9041
    },
    "pickup_start_time": "09:00",
    "pickup_end_time": "11:00",
    "pickup_delivery_duration_minutes": 15,
    "additional_emails": [
        {
            "email": "[email protected]",
            "type": "cc"
        }
    ]
}
headers = {
  'Authorization': 'Bearer {YOUR_API_KEY}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response:

{
    "uuid": "a29a4296-f8e4-4f17-a65b-0302f0f4708e",
    "type": "delivery",
    "external_identifier": "RLfQwnnLBpQn",
    "external_reference": null,
    "custom_field_1": null,
    "custom_field_2": null,
    "custom_field_3": null,
    "custom_field_4": null,
    "note": null,
    "pending_payment_amount": 0,
    "external_link": null,
    "track_and_trace_link": "http://localhost/tr/oGehWOdCBzrm",
    "delivery_from_date": null,
    "delivery_date": "2026-08-27",
    "start_time": "08:00:00",
    "end_time": "18:00:00",
    "delivery_duration_minutes": 5,
    "recurring": null,
    "return_required": false,
    "signature_required": false,
    "used_capacity": 0,
    "used_capacity_2": 0,
    "used_capacity_3": 0,
    "updated_at": "2026-08-27T12:37:38.000000Z",
    "created_at": "2026-08-27T12:37:38.000000Z",
    "tags": [],
    "notification_template_uuid": null,
    "return_task_uuid": null,
    "address": {
        "street": "",
        "house_number": "",
        "house_number_extension": "",
        "postal_code": "",
        "city": "",
        "latitude": 5.4321,
        "longitude": 5.4321,
        "address_line": "",
        "full_address_line": "",
        "country": {
            "iso_code": "NL",
            "description": "Nederland"
        }
    },
    "customer": {
        "name": "customer 1",
        "email": null,
        "phone_number": null
    },
    "additional_emails": [],
    "shipment_steps": null,
    "visit_uuids": [],
    "next_visit": null
}

GET Task

GET

http://localhost

/api/v2/tasks/{task_uuid}

requires authentication

Get a task from your company

RateLimit (60/min)

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

URL Parameters

task_uuid

string

uuid of the corresponding task

Example:

7fa9a972-df70-39d1-8a00-6938a844581d

Response Fields

uuid

string

The uuid of this task

type

string

enum(delivery|pickup|shipment) The type of this task

external_identifier

string

Unique identifier like order number

external_reference

string|null

Reference for api connections

note

string|null

Internal note for the driver / note from customer on order for the driver

custom_field_1

string|null

Custom field for attaching extra data to a task, displayed in the driver app.

custom_field_2

string|null

Custom field for attaching extra data to a task, displayed in the driver app.

custom_field_3

string|null

Custom field for attaching extra data to a task, displayed in the driver app.

custom_field_4

string|null

Custom field for attaching extra data to a task, displayed in the driver app.

pending_payment_amount

number

Amount the customer needs to pay on delivery

external_link

string|null

Link visible on the track and trace page like a bill

track_and_trace_link

string

Link to the track and trace page

delivery_from_date

string|null

The earliest date the task is allowed to be completed

delivery_date

string

The date the task is supposed to be completed

start_time

string|null

The time window start time. Timezone: Europe/Amsterdam

end_time

string|null

The time window end time. Timezone: Europe/Amsterdam

delivery_duration_minutes

integer

The time needed on location to complete the task

return_required

boolean

Specifies if the task should also have a corresponding 'pickup' task

signature_required

boolean

If the customer is required to place a signature for this task

used_capacity_1

integer

The amount of capacity this task takes

used_capacity_2

integer

The amount of capacity this task takes

used_capacity_3

integer

The amount of capacity this task takes

created_at

string

Date and time when this task was created

updated_at

string

Date and time when this task was updated

tags[]

string[]

The identifier of a tag. Tasks with a tag will only be planned in to vehicles with the same tag.

return_task_uuid

string|null

The uuid of a related return task if available

notification_template_uuid

string|null

The uuid of the related notification template, null if using the default template

recurring

object|null

Recurring information

address

object

Address information

street

string

The street name

house_number

string

The house number

house_number_extension

string|null

Extra information about the house number

postal_code

string

The postal code

city

string

The city

latitude

number

The latitude of the address

longitude

number

The longitude of the address

country

object

Country information

customer

object

Customer information

additional_emails

object[]|null

Additional email recipients for notifications. Maximum 5.

next_visit

object|null

uuid

string

The uuid of this visit

type

string

enum(start|end|task|break|charge) The type of visit

order_index

integer

Index on which order the visits should be visited

delivery_time

string

The time which this visit should be completed

delivered_at

string|null

Date and time when this visit was completed

task_uuid

string|null

The related task to this visit

address

object|null

Address information

street

string

The street name

house_number

string

The house number

house_number_extension

string|null

Extra information about the house number

postal_code

string

The postal code

city

string

The city

latitude

number

The latitude of the address

longitude

number

The longitude of the address

country[]

object

Country information

country

object

scanned_codes

object[]|null

Collection of ScannedCodes

returnable_packaging

object[]|null

Collection of Returnable packaging

data

object

files

object[]|null

Collection of Files

data

object

shipment_steps

object|null

The shipment steps when a task has a shipment type. Shipments always consist of exactly 2 steps: pickup and delivery. The pickup step must be executed before the delivery step.

pickup

object

The pickup step of the shipment.

delivery_duration_minutes

integer

The time needed on location to complete this step.

start_time

string

The time window start time for the pickup. Timezone: Europe/Amsterdam

end_time

string

The time window end time for the pickup. Timezone: Europe/Amsterdam

address

object

Address information for the pickup location.

street

string

The street name

house_number

string

The house number

house_number_extension

string|null

Extra information about the house number

postal_code

string

The postal code

city

string

The city

latitude

number

The latitude of the address

longitude

number

The longitude of the address

country

object

Country information

delivery

object

The delivery step of the shipment.

delivery_duration_minutes

integer

The time needed on location to complete this step.

start_time

string

The time window start time for the delivery. Timezone: Europe/Amsterdam

end_time

string

The time window end time for the delivery. Timezone: Europe/Amsterdam

address

object

Address information for the delivery location.

street

string

The street name

house_number

string

The house number

house_number_extension

string|null

Extra information about the house number

postal_code

string

The postal code

city

string

The city

latitude

number

The latitude of the address

longitude

number

The longitude of the address

country

object

Country information

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost/api/v2/tasks/7fa9a972-df70-39d1-8a00-6938a844581d" \
    --header "Authorization: Bearer {YOUR_API_KEY}"

Example response:

{
    "uuid": "a29a4296-0ba7-4ec7-8518-f2eb258bf1fb",
    "type": "delivery",
    "external_identifier": "AXi10k",
    "external_reference": null,
    "custom_field_1": null,
    "custom_field_2": null,
    "custom_field_3": null,
    "custom_field_4": null,
    "note": null,
    "pending_payment_amount": 0,
    "external_link": null,
    "track_and_trace_link": "http://localhost/tr/NyZ9jxBkoswp",
    "delivery_from_date": null,
    "delivery_date": "2026-08-27",
    "start_time": "08:00:00",
    "end_time": "17:00:00",
    "delivery_duration_minutes": 0,
    "recurring": null,
    "return_required": false,
    "signature_required": false,
    "used_capacity": 0,
    "used_capacity_2": 0,
    "used_capacity_3": 0,
    "updated_at": "2026-08-27T12:37:38.000000Z",
    "created_at": "2026-08-27T12:37:37.000000Z",
    "tags": [],
    "notification_template_uuid": null,
    "return_task_uuid": null,
    "address": {
        "street": "8575 Bins Centers",
        "house_number": "97445",
        "house_number_extension": null,
        "postal_code": "63049-1298",
        "city": "Mitchellborough",
        "latitude": 5.4321,
        "longitude": 5.4321,
        "address_line": "8575 Bins Centers 97445",
        "full_address_line": "8575 Bins Centers 97445, 63049-1298, Mitchellborough",
        "country": {
            "iso_code": "NL",
            "description": "Nederland"
        }
    },
    "customer": {
        "name": "Omari Lueilwitz",
        "email": "[email protected]",
        "phone_number": null
    },
    "additional_emails": [],
    "shipment_steps": null,
    "visit_uuids": [
        "a29a4296-2856-4c97-9088-10a7923dc09a"
    ],
    "next_visit": {
        "uuid": "a29a4296-2856-4c97-9088-10a7923dc09a",
        "type": "task",
        "order_index": 0,
        "delivery_time": "09:00:00",
        "delivered_at": "2026-08-27T07:05:00.000000Z",
        "schedule_date": "2026-08-26T22:00:00.000000Z",
        "address": {
            "street": "8575 Bins Centers",
            "house_number": "97445",
            "house_number_extension": null,
            "postal_code": "63049-1298",
            "city": "Mitchellborough",
            "latitude": 5.4321,
            "longitude": 5.4321,
            "address_line": "8575 Bins Centers 97445",
            "full_address_line": "8575 Bins Centers 97445, 63049-1298, Mitchellborough",
            "country": {
                "iso_code": "NL",
                "description": "Nederland"
            }
        },
        "scanned_codes": {
            "data": [
                {
                    "type": "task_code",
                    "code_uuid": "a29a4296-2152-4d6d-8182-c4d00900ffbe",
                    "scanned_count": 1
                },
                {
                    "type": "schedule_visit_code",
                    "code_uuid": "a29a4296-381b-48e1-a394-eb6972686fed",
                    "scanned_count": 1
                }
            ]
        },
        "returnable_packaging": {
            "data": [
                {
                    "uuid": "a29a4296-3b40-4d81-9920-e139158f5e2e",
                    "count": -2,
                    "returnable_packaging_type": {
                        "uuid": "a29a4296-3a09-4cf8-b84d-c7fe7441195d",
                        "type": "pallets"
                    }
                }
            ]
        },
        "status": {
            "status_identifier": "delivered"
        },
        "signature": "YTI5YTQyOTYtMjg1Ni00Yzk3LTkwODgtMTBhNzkyM2RjMDlh",
        "files": {
            "data": [
                {
                    "type": "image",
                    "key": "OEhHbzZZdlBVVnRrU1QzNA"
                }
            ]
        }
    }
}

PUT/PATCH Task

PUT

PATCH

http://localhost

/api/v2/tasks/{task_uuid}

requires authentication

Update a task from your company

RateLimit (60/min)

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

Content-Type

Example:

application/json

URL Parameters

task_uuid

string

uuid of the corresponding task

Example:

720a146a-a0e1-36dc-b811-8d0f487525c8

Body Parameters

type

string

The type of this task.

Must be one of:

delivery
pickup
shipment

Example:

delivery

external_identifier

string

required

Unique identifier like order number. Must not be greater than 255 characters.

Example:

wqtbvsy

external_reference

string

Reference for api connections. Must not be greater than 255 characters.

Example:

odnikhckysd

custom_field_1

string

Custom field for attaching extra data to a task, displayed in the driver app. Must not be greater than 255 characters.

Example:

dxylsqdzpirvmsxlndsnk

custom_field_2

string

Custom field for attaching extra data to a task, displayed in the driver app. Must not be greater than 255 characters.

Example:

jvglnwrnvnzxtnxax

custom_field_3

string

Custom field for attaching extra data to a task, displayed in the driver app. Must not be greater than 255 characters.

Example:

imztmddrk

custom_field_4

string

Custom field for attaching extra data to a task, displayed in the driver app. Must not be greater than 255 characters.

Example:

wdznjlqtfjuoeeanwyecp

note

string

Internal note for the driver / note from customer on order for the driver. Must not be greater than 20000 characters.

Example:

Please deliver at the side door.

pending_payment_amount

number

Amount the customer needs to pay on delivery. Must be at least 0. Must not be greater than 99999999.99.

Example:

100

external_link

string

Link visible on the track and trace page like a bill. Must not be greater than 2048 characters.

Example:

https://example.com/

delivery_from_date

string

The earliest date the task is allowed to be completed. Must be a valid date. Must be a date before or equal to delivery_date.

Example:

2017-09-05

start_time

string

The time window start time. Timezone: Europe/Amsterdam. This value can be null if the task should be an appointment and you have the appointments addon. Must be a valid date in the format H:i.

Example:

08:00

end_time

string

Example:

17:00

delivery_duration_minutes

integer

The time needed on location to complete the task. Must be at least 0. Must not be greater than 1440.

Example:

return_required

boolean

Specifies if the task should also have a corresponding "pickup" task.

return_task_uuid

string

The uuid of the corresponding "pickup" task. Must be a valid UUID.

Example:

8852add4-f436-37b4-ade9-c5b1fe48b293

signature_required

boolean

If the customer is required to place a signature for this task.

Example:

used_capacity

number

The amount of capacity this task takes. Must be at least 0. Must not be greater than 99999999.99.

Example:

used_capacity_2

number

The amount of capacity this task takes. Must be at least 0. Must not be greater than 99999999.99.

Example:

used_capacity_3

number

The amount of capacity this task takes. Must be at least 0. Must not be greater than 99999999.99.

Example:

notification_template_uuid

string

The uuid of the related notification template, null if using the default template. Must be a valid UUID.

Example:

57821af3-1937-3a1f-850a-b7d072416c9c

recurring

object

Recurring information.

period

string

When a task is recurring. This field is required when recurring is present.

Must be one of:

week
month

Example:

week

interval

integer

The interval at which the task is repeated. This field is required when recurring is present. Must be at least 1. Must not be greater than 60.

Example:

settings

string

Settings when to repeat.

. This field is required when recurring is present.

Example:

["string", "third", "monday"]

end_date

string

When recurring should end. Must be a valid date. Must be a date after or equal to delivery_date.

Example:

2083-02-03

address

object

house_number

string

The house number. Must not be greater than 255 characters.

Example:

house_number_extension

string

Extra information about the house number. Must not be greater than 255 characters.

Example:

street

string

The street name. Must not be greater than 255 characters.

Example:

LongStreet

postal_code

string

The postal code. Must not be greater than 255 characters.

Example:

1234AB

city

string

The city. Must not be greater than 255 characters.

Example:

Amsterdam

country

string

The iso code of the country. Must match an existing stored value.

Example:

latitude

number

The latitude of the address. This field is required when address.longitude is present. Must be at least -90. Must not be greater than 90.

Example:

52.3676

longitude

number

The longitude of the address. This field is required when address.latitude is present. Must be at least -180. Must not be greater than 180.

Example:

4.9041

customer

object

additional_emails

object[]

Additional email recipients for notifications. Maximum 5 entries. Must not have more than 5 items.

tags

string[]

The identifier of a tag. Tasks with a tag will only be planned in to vehicles with the same tag. This field is required when tags is present. Must not be greater than 250 characters.

Example:

["cooled"]

delivery_date

string

The date the task is supposed to be completed. This value can be null if the task should be an appointment and you have the appointments addon. Must be a valid date.

Example:

2026-08-27T14:37:39

pickup_address

object

Pickup address information (required for shipment tasks).

street

string

The pickup street name. This field is required when pickup_address.latitude or pickup_address.longitude is not present. Must not be greater than 255 characters.

Example:

PickupStreet

house_number

string

The pickup house number. This field is required when pickup_address.latitude or pickup_address.longitude is not present. Must not be greater than 255 characters.

Example:

postal_code

string

The pickup postal code. This field is required when pickup_address.latitude or pickup_address.longitude is not present. Must not be greater than 255 characters.

Example:

5678CD

city

string

The pickup city. This field is required when pickup_address.latitude or pickup_address.longitude is not present. Must not be greater than 255 characters.

Example:

Rotterdam

country

string

required

The iso code of the pickup country. Must match an existing stored value.

Example:

latitude

number

Example:

52.3676

longitude

number

Example:

4.9041

pickup_start_time

string

The pickup time window start time (for shipment tasks). Must be a valid date in the format H:i.

Example:

09:00

pickup_end_time

string

The pickup time window end time (for shipment tasks). Must be a valid date in the format H:i. Must be a date after pickup_start_time.

Example:

11:00

pickup_delivery_duration_minutes

integer

The time needed at pickup location to complete the pickup (for shipment tasks). Must be at least 0. Must not be greater than 1440.

Example:

Response Fields

uuid

string

The uuid of this task

type

string

enum(delivery|pickup|shipment) The type of this task

external_identifier

string

Unique identifier like order number

external_reference

string|null

Reference for api connections

note

string|null

Internal note for the driver / note from customer on order for the driver

custom_field_1

string|null

Custom field for attaching extra data to a task, displayed in the driver app.

custom_field_2

string|null

Custom field for attaching extra data to a task, displayed in the driver app.

custom_field_3

string|null

Custom field for attaching extra data to a task, displayed in the driver app.

custom_field_4

string|null

Custom field for attaching extra data to a task, displayed in the driver app.

pending_payment_amount

number

Amount the customer needs to pay on delivery

external_link

string|null

Link visible on the track and trace page like a bill

track_and_trace_link

string

Link to the track and trace page

delivery_from_date

string|null

The earliest date the task is allowed to be completed

delivery_date

string

The date the task is supposed to be completed

start_time

string|null

The time window start time. Timezone: Europe/Amsterdam

end_time

string|null

The time window end time. Timezone: Europe/Amsterdam

delivery_duration_minutes

integer

The time needed on location to complete the task

return_required

boolean

Specifies if the task should also have a corresponding 'pickup' task

signature_required

boolean

If the customer is required to place a signature for this task

used_capacity_1

integer

The amount of capacity this task takes

used_capacity_2

integer

The amount of capacity this task takes

used_capacity_3

integer

The amount of capacity this task takes

created_at

string

Date and time when this task was created

updated_at

string

Date and time when this task was updated

tags[]

string[]

The identifier of a tag. Tasks with a tag will only be planned in to vehicles with the same tag.

return_task_uuid

string|null

The uuid of a related return task if available

notification_template_uuid

string|null

The uuid of the related notification template, null if using the default template

recurring

object|null

Recurring information

address

object

Address information

street

string

The street name

house_number

string

The house number

house_number_extension

string|null

Extra information about the house number

postal_code

string

The postal code

city

string

The city

latitude

number

The latitude of the address

longitude

number

The longitude of the address

country

object

Country information

customer

object

Customer information

additional_emails

object[]|null

Additional email recipients for notifications. Maximum 5.

next_visit

object|null

uuid

string

The uuid of this visit

type

string

enum(start|end|task|break|charge) The type of visit

order_index

integer

Index on which order the visits should be visited

delivery_time

string

The time which this visit should be completed

delivered_at

string|null

Date and time when this visit was completed

task_uuid

string|null

The related task to this visit

address

object|null

Address information

street

string

The street name

house_number

string

The house number

house_number_extension

string|null

Extra information about the house number

postal_code

string

The postal code

city

string

The city

latitude

number

The latitude of the address

longitude

number

The longitude of the address

country[]

object

Country information

country

object

scanned_codes

object[]|null

Collection of ScannedCodes

returnable_packaging

object[]|null

Collection of Returnable packaging

data

object

files

object[]|null

Collection of Files

data

object

shipment_steps

object|null

The shipment steps when a task has a shipment type. Shipments always consist of exactly 2 steps: pickup and delivery. The pickup step must be executed before the delivery step.

pickup

object

The pickup step of the shipment.

delivery_duration_minutes

integer

The time needed on location to complete this step.

start_time

string

The time window start time for the pickup. Timezone: Europe/Amsterdam

end_time

string

The time window end time for the pickup. Timezone: Europe/Amsterdam

address

object

Address information for the pickup location.

street

string

The street name

house_number

string

The house number

house_number_extension

string|null

Extra information about the house number

postal_code

string

The postal code

city

string

The city

latitude

number

The latitude of the address

longitude

number

The longitude of the address

country

object

Country information

delivery

object

The delivery step of the shipment.

delivery_duration_minutes

integer

The time needed on location to complete this step.

start_time

string

The time window start time for the delivery. Timezone: Europe/Amsterdam

end_time

string

The time window end time for the delivery. Timezone: Europe/Amsterdam

address

object

Address information for the delivery location.

street

string

The street name

house_number

string

The house number

house_number_extension

string|null

Extra information about the house number

postal_code

string

The postal code

city

string

The city

latitude

number

The latitude of the address

longitude

number

The longitude of the address

country

object

Country information

Auth

Bearer

Headers

URL Parameters

Body

{ "type": "delivery", "external_identifier": "wqtbvsy", "external_reference": "odnikhckysd", "custom_field_1": "dxylsqdzpirvmsxlndsnk", "custom_field_2": "jvglnwrnvnzxtnxax", "custom_field_3": "imztmddrk", "custom_field_4": "wdznjlqtfjuoeeanwyecp", "note": "Please deliver at the side door.", "pending_payment_amount": 100, "external_link": "https:\/\/example.com\/", "delivery_from_date": "2017-09-05", "start_time": "08:00", "end_time": "17:00", "delivery_duration_minutes": 8, "return_required": false, "return_task_uuid": "8852add4-f436-37b4-ade9-c5b1fe48b293", "signature_required": true, "used_capacity": 18, "used_capacity_2": 23, "used_capacity_3": 4, "notification_template_uuid": "57821af3-1937-3a1f-850a-b7d072416c9c", "recurring": { "period": "week", "interval": 19, "settings": "[\"string\", \"third\", \"monday\"]", "end_date": "2083-02-03" }, "address": { "house_number": "12", "house_number_extension": "1A", "street": "LongStreet", "postal_code": "1234AB", "city": "Amsterdam", "country": "NL", "latitude": 52.3676, "longitude": 4.9041 }, "customer": { "email": "[email protected]", "phone_number": "+01 234567890", "name": "Andrew" }, "additional_emails": [ { "email": "[email protected]", "type": "cc" } ], "tags": [ "cooled" ], "delivery_date": "2026-08-27T14:37:39", "pickup_address": { "street": "PickupStreet", "house_number": "42", "postal_code": "5678CD", "city": "Rotterdam", "country": "NL", "latitude": 52.3676, "longitude": 4.9041 }, "pickup_start_time": "09:00", "pickup_end_time": "11:00", "pickup_delivery_duration_minutes": 15 }

Received response

Example request:

curl --request PUT \
    "http://localhost/api/v2/tasks/720a146a-a0e1-36dc-b811-8d0f487525c8" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"type\": \"delivery\",
    \"external_identifier\": \"wqtbvsy\",
    \"external_reference\": \"odnikhckysd\",
    \"custom_field_1\": \"dxylsqdzpirvmsxlndsnk\",
    \"custom_field_2\": \"jvglnwrnvnzxtnxax\",
    \"custom_field_3\": \"imztmddrk\",
    \"custom_field_4\": \"wdznjlqtfjuoeeanwyecp\",
    \"note\": \"Please deliver at the side door.\",
    \"pending_payment_amount\": 100,
    \"external_link\": \"https:\\/\\/example.com\\/\",
    \"delivery_from_date\": \"2017-09-05\",
    \"start_time\": \"08:00\",
    \"end_time\": \"17:00\",
    \"delivery_duration_minutes\": 8,
    \"return_required\": false,
    \"return_task_uuid\": \"8852add4-f436-37b4-ade9-c5b1fe48b293\",
    \"signature_required\": true,
    \"used_capacity\": 18,
    \"used_capacity_2\": 23,
    \"used_capacity_3\": 4,
    \"notification_template_uuid\": \"57821af3-1937-3a1f-850a-b7d072416c9c\",
    \"recurring\": {
        \"period\": \"week\",
        \"interval\": 19,
        \"settings\": \"[\\\"string\\\", \\\"third\\\", \\\"monday\\\"]\",
        \"end_date\": \"2083-02-03\"
    },
    \"address\": {
        \"house_number\": \"12\",
        \"house_number_extension\": \"1A\",
        \"street\": \"LongStreet\",
        \"postal_code\": \"1234AB\",
        \"city\": \"Amsterdam\",
        \"country\": \"NL\",
        \"latitude\": 52.3676,
        \"longitude\": 4.9041
    },
    \"customer\": {
        \"email\": \"[email protected]\",
        \"phone_number\": \"+01 234567890\",
        \"name\": \"Andrew\"
    },
    \"tags\": [
        \"cooled\"
    ],
    \"delivery_date\": \"2026-08-27T14:37:39\",
    \"pickup_address\": {
        \"street\": \"PickupStreet\",
        \"house_number\": \"42\",
        \"postal_code\": \"5678CD\",
        \"city\": \"Rotterdam\",
        \"country\": \"NL\",
        \"latitude\": 52.3676,
        \"longitude\": 4.9041
    },
    \"pickup_start_time\": \"09:00\",
    \"pickup_end_time\": \"11:00\",
    \"pickup_delivery_duration_minutes\": 15,
    \"additional_emails\": [
        {
            \"email\": \"[email protected]\",
            \"type\": \"cc\"
        }
    ]
}"

$client = new \GuzzleHttp\Client();
$url = 'http://localhost/api/v2/tasks/720a146a-a0e1-36dc-b811-8d0f487525c8';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_KEY}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'type' => 'delivery',
            'external_identifier' => 'wqtbvsy',
            'external_reference' => 'odnikhckysd',
            'custom_field_1' => 'dxylsqdzpirvmsxlndsnk',
            'custom_field_2' => 'jvglnwrnvnzxtnxax',
            'custom_field_3' => 'imztmddrk',
            'custom_field_4' => 'wdznjlqtfjuoeeanwyecp',
            'note' => 'Please deliver at the side door.',
            'pending_payment_amount' => 100.0,
            'external_link' => 'https://example.com/',
            'delivery_from_date' => '2017-09-05',
            'start_time' => '08:00',
            'end_time' => '17:00',
            'delivery_duration_minutes' => 8,
            'return_required' => false,
            'return_task_uuid' => '8852add4-f436-37b4-ade9-c5b1fe48b293',
            'signature_required' => true,
            'used_capacity' => 18,
            'used_capacity_2' => 23,
            'used_capacity_3' => 4,
            'notification_template_uuid' => '57821af3-1937-3a1f-850a-b7d072416c9c',
            'recurring' => ['period' => 'week', 'interval' => 19, 'settings' => '["string", "third", "monday"]', 'end_date' => '2083-02-03'],
            'address' => ['house_number' => '12', 'house_number_extension' => '1A', 'street' => 'LongStreet', 'postal_code' => '1234AB', 'city' => 'Amsterdam', 'country' => 'NL', 'latitude' => 52.3676, 'longitude' => 4.9041],
            'customer' => ['email' => '[email protected]', 'phone_number' => '+01 234567890', 'name' => 'Andrew'],
            'tags' => ['cooled'],
            'delivery_date' => '2026-08-27T14:37:39',
            'pickup_address' => ['street' => 'PickupStreet', 'house_number' => '42', 'postal_code' => '5678CD', 'city' => 'Rotterdam', 'country' => 'NL', 'latitude' => 52.3676, 'longitude' => 4.9041],
            'pickup_start_time' => '09:00',
            'pickup_end_time' => '11:00',
            'pickup_delivery_duration_minutes' => 15,
            'additional_emails' => [
                ['email' => '[email protected]', 'type' => 'cc'],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "http://localhost/api/v2/tasks/720a146a-a0e1-36dc-b811-8d0f487525c8"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "type": "delivery",
    "external_identifier": "wqtbvsy",
    "external_reference": "odnikhckysd",
    "custom_field_1": "dxylsqdzpirvmsxlndsnk",
    "custom_field_2": "jvglnwrnvnzxtnxax",
    "custom_field_3": "imztmddrk",
    "custom_field_4": "wdznjlqtfjuoeeanwyecp",
    "note": "Please deliver at the side door.",
    "pending_payment_amount": 100,
    "external_link": "https:\/\/example.com\/",
    "delivery_from_date": "2017-09-05",
    "start_time": "08:00",
    "end_time": "17:00",
    "delivery_duration_minutes": 8,
    "return_required": false,
    "return_task_uuid": "8852add4-f436-37b4-ade9-c5b1fe48b293",
    "signature_required": true,
    "used_capacity": 18,
    "used_capacity_2": 23,
    "used_capacity_3": 4,
    "notification_template_uuid": "57821af3-1937-3a1f-850a-b7d072416c9c",
    "recurring": {
        "period": "week",
        "interval": 19,
        "settings": "[\"string\", \"third\", \"monday\"]",
        "end_date": "2083-02-03"
    },
    "address": {
        "house_number": "12",
        "house_number_extension": "1A",
        "street": "LongStreet",
        "postal_code": "1234AB",
        "city": "Amsterdam",
        "country": "NL",
        "latitude": 52.3676,
        "longitude": 4.9041
    },
    "customer": {
        "email": "[email protected]",
        "phone_number": "+01 234567890",
        "name": "Andrew"
    },
    "tags": [
        "cooled"
    ],
    "delivery_date": "2026-08-27T14:37:39",
    "pickup_address": {
        "street": "PickupStreet",
        "house_number": "42",
        "postal_code": "5678CD",
        "city": "Rotterdam",
        "country": "NL",
        "latitude": 52.3676,
        "longitude": 4.9041
    },
    "pickup_start_time": "09:00",
    "pickup_end_time": "11:00",
    "pickup_delivery_duration_minutes": 15,
    "additional_emails": [
        {
            "email": "[email protected]",
            "type": "cc"
        }
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

import requests
import json

url = 'http://localhost/api/v2/tasks/720a146a-a0e1-36dc-b811-8d0f487525c8'
payload = {
    "type": "delivery",
    "external_identifier": "wqtbvsy",
    "external_reference": "odnikhckysd",
    "custom_field_1": "dxylsqdzpirvmsxlndsnk",
    "custom_field_2": "jvglnwrnvnzxtnxax",
    "custom_field_3": "imztmddrk",
    "custom_field_4": "wdznjlqtfjuoeeanwyecp",
    "note": "Please deliver at the side door.",
    "pending_payment_amount": 100,
    "external_link": "https:\/\/example.com\/",
    "delivery_from_date": "2017-09-05",
    "start_time": "08:00",
    "end_time": "17:00",
    "delivery_duration_minutes": 8,
    "return_required": false,
    "return_task_uuid": "8852add4-f436-37b4-ade9-c5b1fe48b293",
    "signature_required": true,
    "used_capacity": 18,
    "used_capacity_2": 23,
    "used_capacity_3": 4,
    "notification_template_uuid": "57821af3-1937-3a1f-850a-b7d072416c9c",
    "recurring": {
        "period": "week",
        "interval": 19,
        "settings": "[\"string\", \"third\", \"monday\"]",
        "end_date": "2083-02-03"
    },
    "address": {
        "house_number": "12",
        "house_number_extension": "1A",
        "street": "LongStreet",
        "postal_code": "1234AB",
        "city": "Amsterdam",
        "country": "NL",
        "latitude": 52.3676,
        "longitude": 4.9041
    },
    "customer": {
        "email": "[email protected]",
        "phone_number": "+01 234567890",
        "name": "Andrew"
    },
    "tags": [
        "cooled"
    ],
    "delivery_date": "2026-08-27T14:37:39",
    "pickup_address": {
        "street": "PickupStreet",
        "house_number": "42",
        "postal_code": "5678CD",
        "city": "Rotterdam",
        "country": "NL",
        "latitude": 52.3676,
        "longitude": 4.9041
    },
    "pickup_start_time": "09:00",
    "pickup_end_time": "11:00",
    "pickup_delivery_duration_minutes": 15,
    "additional_emails": [
        {
            "email": "[email protected]",
            "type": "cc"
        }
    ]
}
headers = {
  'Authorization': 'Bearer {YOUR_API_KEY}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Example response:

{
    "uuid": "a29a4296-0ba7-4ec7-8518-f2eb258bf1fb",
    "type": "delivery",
    "external_identifier": "RL2fJ8nO6aiB",
    "external_reference": null,
    "custom_field_1": null,
    "custom_field_2": null,
    "custom_field_3": null,
    "custom_field_4": null,
    "note": null,
    "pending_payment_amount": 0,
    "external_link": null,
    "track_and_trace_link": "http://localhost/tr/NyZ9jxBkoswp",
    "delivery_from_date": null,
    "delivery_date": "2026-08-27",
    "start_time": "08:00:00",
    "end_time": "17:00:00",
    "delivery_duration_minutes": 0,
    "recurring": null,
    "return_required": false,
    "signature_required": false,
    "used_capacity": 0,
    "used_capacity_2": 0,
    "used_capacity_3": 0,
    "updated_at": "2026-08-27T12:37:38.000000Z",
    "created_at": "2026-08-27T12:37:37.000000Z",
    "tags": [],
    "notification_template_uuid": null,
    "return_task_uuid": null,
    "address": {
        "street": "8575 Bins Centers",
        "house_number": "97445",
        "house_number_extension": null,
        "postal_code": "63049-1298",
        "city": "Mitchellborough",
        "latitude": 5.4321,
        "longitude": 5.4321,
        "address_line": "8575 Bins Centers 97445",
        "full_address_line": "8575 Bins Centers 97445, 63049-1298, Mitchellborough",
        "country": {
            "iso_code": "NL",
            "description": "Nederland"
        }
    },
    "customer": {
        "name": "Omari Lueilwitz",
        "email": "[email protected]",
        "phone_number": null
    },
    "additional_emails": [],
    "shipment_steps": null,
    "visit_uuids": [
        "a29a4296-2856-4c97-9088-10a7923dc09a"
    ],
    "next_visit": {
        "uuid": "a29a4296-2856-4c97-9088-10a7923dc09a",
        "type": "task",
        "order_index": 0,
        "delivery_time": "09:00:00",
        "delivered_at": "2026-08-27T07:05:00.000000Z",
        "schedule_date": "2026-08-26T22:00:00.000000Z",
        "address": {
            "street": "8575 Bins Centers",
            "house_number": "97445",
            "house_number_extension": null,
            "postal_code": "63049-1298",
            "city": "Mitchellborough",
            "latitude": 5.4321,
            "longitude": 5.4321,
            "address_line": "8575 Bins Centers 97445",
            "full_address_line": "8575 Bins Centers 97445, 63049-1298, Mitchellborough",
            "country": {
                "iso_code": "NL",
                "description": "Nederland"
            }
        },
        "scanned_codes": {
            "data": [
                {
                    "type": "task_code",
                    "code_uuid": "a29a4296-2152-4d6d-8182-c4d00900ffbe",
                    "scanned_count": 1
                },
                {
                    "type": "schedule_visit_code",
                    "code_uuid": "a29a4296-381b-48e1-a394-eb6972686fed",
                    "scanned_count": 1
                }
            ]
        },
        "returnable_packaging": {
            "data": [
                {
                    "uuid": "a29a4296-3b40-4d81-9920-e139158f5e2e",
                    "count": -2,
                    "returnable_packaging_type": {
                        "uuid": "a29a4296-3a09-4cf8-b84d-c7fe7441195d",
                        "type": "pallets"
                    }
                }
            ]
        },
        "status": {
            "status_identifier": "delivered"
        },
        "signature": "YTI5YTQyOTYtMjg1Ni00Yzk3LTkwODgtMTBhNzkyM2RjMDlh",
        "files": {
            "data": [
                {
                    "type": "image",
                    "key": "OEhHbzZZdlBVVnRrU1QzNA"
                }
            ]
        }
    }
}

DELETE Task

DELETE

http://localhost

/api/v2/tasks/{task_uuid}

requires authentication

Delete a task from your company

RateLimit (60/min)

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

URL Parameters

task_uuid

string

uuid of the corresponding task

Example:

0f3ac21c-00f5-3d01-9789-eac72b867f40

Query Parameters

forceRemoveFromSchedules

boolean

Optionally force remove task from all schedules.

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request DELETE \
    "http://localhost/api/v2/tasks/0f3ac21c-00f5-3d01-9789-eac72b867f40?forceRemoveFromSchedules=" \
    --header "Authorization: Bearer {YOUR_API_KEY}"

Example response:

[Empty response]

Visits

Visits are the delivery or pickup attempts linked to a schedule.

GET Visit

GET

http://localhost

/api/v2/visits/{scheduleVisit_uuid}

requires authentication

Get a visit from your company

RateLimit (60/min)

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

URL Parameters

scheduleVisit_uuid

string

uuid of the corresponding visit

Example:

362e579c-af9f-3c36-9ea4-d06be6205eaf

Response Fields

data

object

uuid

string

The uuid of this visit

type

string

enum(start|end|task|break|charge) The type of visit

order_index

integer

Index on which order the visits should be visited

delivery_time

string

The time which this visit should be completed

delivered_at

string|null

Date and time when this visit was completed

task_uuid

string|null

The related task to this visit

address

object|null

Address information

street

string

The street name

house_number

string

The house number

house_number_extension

string|null

Extra information about the house number

postal_code

string

The postal code

city

string

The city

latitude

number

The latitude of the address

longitude

number

The longitude of the address

country[]

object

Country information

country

object

scanned_codes

object[]|null

Collection of ScannedCodes

returnable_packaging

object[]|null

Collection of Returnable packaging

data

object

files

object[]|null

Collection of Files

signature

string

The key of this file. Used for retrieving the file through the files endpoint.

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost/api/v2/visits/362e579c-af9f-3c36-9ea4-d06be6205eaf" \
    --header "Authorization: Bearer {YOUR_API_KEY}"

Example response:

{
    "data": {
        "uuid": "a29a4296-2856-4c97-9088-10a7923dc09a",
        "type": "task",
        "order_index": 0,
        "delivery_time": "09:00:00",
        "delivered_at": "2026-08-27T07:05:00.000000Z",
        "task_uuid": "a29a4296-0ba7-4ec7-8518-f2eb258bf1fb",
        "schedule_date": "2026-08-26T22:00:00.000000Z",
        "address": {
            "street": "8575 Bins Centers",
            "house_number": "97445",
            "house_number_extension": null,
            "postal_code": "63049-1298",
            "city": "Mitchellborough",
            "latitude": 5.4321,
            "longitude": 5.4321,
            "address_line": "8575 Bins Centers 97445",
            "full_address_line": "8575 Bins Centers 97445, 63049-1298, Mitchellborough",
            "country": {
                "iso_code": "NL",
                "description": "Nederland"
            }
        },
        "scanned_codes": {
            "data": [
                {
                    "type": "task_code",
                    "code_uuid": "a29a4296-2152-4d6d-8182-c4d00900ffbe",
                    "scanned_count": 1
                },
                {
                    "type": "schedule_visit_code",
                    "code_uuid": "a29a4296-381b-48e1-a394-eb6972686fed",
                    "scanned_count": 1
                }
            ]
        },
        "returnable_packaging": {
            "data": [
                {
                    "uuid": "a29a4296-3b40-4d81-9920-e139158f5e2e",
                    "count": -2
                }
            ]
        },
        "status": {
            "status_identifier": "delivered"
        },
        "signature": "YTI5YTQyOTYtMjg1Ni00Yzk3LTkwODgtMTBhNzkyM2RjMDlh",
        "files": {
            "data": [
                {
                    "type": "image",
                    "key": "OEhHbzZZdlBVVnRrU1QzNA"
                }
            ]
        }
    }
}

GET Visit Proof Of Delivery

GET

http://localhost

/api/v2/visits/{scheduleVisit_uuid}/pod

requires authentication

Download the proof of delivery (POD) PDF for a visit.

RateLimit (5/min)

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

URL Parameters

scheduleVisit_uuid

string

uuid of the corresponding visit

Example:

91650491-4a39-32f9-b0f4-b5cc19559629

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost/api/v2/visits/91650491-4a39-32f9-b0f4-b5cc19559629/pod" \
    --header "Authorization: Bearer {YOUR_API_KEY}"

Example response:

[Binary data] -  The PDF file

Task Products

Products are the items that are being delivered or picked up in a task.

GET Products

GET

http://localhost

/api/v2/tasks/{task_uuid}/products

requires authentication

Get collection of products of a task

RateLimit (60/min)

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

URL Parameters

task_uuid

string

uuid of the corresponding task

Example:

26d3e40f-d2e3-3c94-9795-cb59bd039960

Response Fields

data

object

data

object[]

Collection of products

object

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost/api/v2/tasks/26d3e40f-d2e3-3c94-9795-cb59bd039960/products" \
    --header "Authorization: Bearer {YOUR_API_KEY}"

Example response:

{
    "data": [
        {
            "uuid": "a29a4296-1f89-4b4d-92a3-e95098db01cb",
            "quantity": "1.00",
            "description": "Test line",
            "unit": "pieces",
            "identifier": "2f7e673aae64ffbe3821016e253b45ed"
        }
    ]
}

POST Products

POST

http://localhost

/api/v2/tasks/{task_uuid}/products

requires authentication

Create a or multiple products of a task

RateLimit (60/min)

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

Content-Type

Example:

application/json

URL Parameters

task_uuid

string

uuid of the corresponding task

Example:

42c9787b-bfff-394e-8faf-d15504317f8a

Body Parameters

data

object[]

identifier

string

Identifier so items can be grouped with different descriptions Example: If you classify both the Oak tree and Birch tree under the identifier "tree", they will be grouped together on the vehicle product list. Must not be greater than 255 characters.

Example:

sotcsybyswpdbtl

quantity

number

The quantity of this product. Must be at least 0.01. Must not be greater than 999999.99.

Example:

unit

string

The unit of this product.

Must be one of:

pieces
weight

Example:

sit

description

string

required

The description of this product. Must not be greater than 2000 characters.

Example:

Table

Response Fields

data

object

data

object[]

Collection of products

object

Auth

Bearer

Headers

URL Parameters

Body

{ "data": [ { "identifier": "sotcsybyswpdbtl", "quantity": 21, "unit": "sit", "description": "Table" } ] }

Received response

Example request:

curl --request POST \
    "http://localhost/api/v2/tasks/42c9787b-bfff-394e-8faf-d15504317f8a/products" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"data\": [
        {
            \"identifier\": \"sotcsybyswpdbtl\",
            \"quantity\": 21,
            \"unit\": \"sit\",
            \"description\": \"Table\"
        }
    ]
}"

Example response:

{
    "data": [
        {
            "uuid": "a29a4297-84bb-4e25-937e-ccef39ec4365",
            "quantity": 1,
            "description": "Test line",
            "unit": "pieces",
            "identifier": "2f7e673aae64ffbe3821016e253b45ed"
        },
        {
            "uuid": "a29a4297-8543-4258-b2a7-d0ce7f303a7d",
            "quantity": 5,
            "description": "Test line 2",
            "unit": "weight",
            "identifier": "838c87eb890a63944ecc8e83ffb0e4bb"
        }
    ]
}

GET Product

GET

http://localhost

/api/v2/tasks/{task_uuid}/products/{product_uuid}

requires authentication

Get a product of a task

RateLimit (60/min)

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

URL Parameters

task_uuid

string

uuid of the corresponding task

Example:

edb25fe1-77ed-37f9-9d1d-05f77ac68a71

product_uuid

string

uuid of the corresponding product

Example:

df06534b-a73c-3f36-9f73-9a043bd96a2e

Response Fields

data

object

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost/api/v2/tasks/edb25fe1-77ed-37f9-9d1d-05f77ac68a71/products/df06534b-a73c-3f36-9f73-9a043bd96a2e" \
    --header "Authorization: Bearer {YOUR_API_KEY}"

Example response:

{
    "data": {
        "uuid": "a29a4296-1f89-4b4d-92a3-e95098db01cb",
        "quantity": "1.00",
        "description": "Test line",
        "unit": "pieces",
        "identifier": "2f7e673aae64ffbe3821016e253b45ed"
    }
}

PUT/PATCH Product

PUT

PATCH

http://localhost

/api/v2/tasks/{task_uuid}/products/{product_uuid}

requires authentication

Update a product of a task

RateLimit (60/min)

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

Content-Type

Example:

application/json

URL Parameters

task_uuid

string

uuid of the corresponding task

Example:

aa884814-5017-35d6-a938-da9ceb5f69ca

product_uuid

string

uuid of the corresponding product

Example:

68945a1b-a6c4-30ca-9404-095c5a3fe870

Body Parameters

identifier

string

Example:

gnbfhjlxqahfukk

quantity

number

The quantity of this product. Must be at least 0.01. Must not be greater than 999999.99.

Example:

unit

string

The unit of this product.

Must be one of:

pieces
weight

Example:

non

description

string

The description of this product. Must not be greater than 255 characters.

Example:

Table

Response Fields

data

object

Auth

Bearer

Headers

URL Parameters

Body

{ "identifier": "gnbfhjlxqahfukk", "quantity": 25, "unit": "non", "description": "Table" }

Received response

Example request:

curl --request PUT \
    "http://localhost/api/v2/tasks/aa884814-5017-35d6-a938-da9ceb5f69ca/products/68945a1b-a6c4-30ca-9404-095c5a3fe870" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"identifier\": \"gnbfhjlxqahfukk\",
    \"quantity\": 25,
    \"unit\": \"non\",
    \"description\": \"Table\"
}"

Example response:

{
    "data": {
        "uuid": "a29a4296-1f89-4b4d-92a3-e95098db01cb",
        "quantity": "1.00",
        "description": "Test line",
        "unit": "pieces",
        "identifier": "2f7e673aae64ffbe3821016e253b45ed"
    }
}

DELETE Product

DELETE

http://localhost

/api/v2/tasks/{task_uuid}/products/{product_uuid}

requires authentication

Delete a product of a task

RateLimit (60/min)

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

URL Parameters

task_uuid

string

uuid of the corresponding task

Example:

70dbdfdd-63f4-38f5-91b9-7535f16aa7be

product_uuid

string

uuid of the corresponding product

Example:

18cd7602-a210-3f67-9fac-230964965636

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://localhost/api/v2/tasks/70dbdfdd-63f4-38f5-91b9-7535f16aa7be/products/18cd7602-a210-3f67-9fac-230964965636" \
    --header "Authorization: Bearer {YOUR_API_KEY}"

Example response:

[Empty response]

DELETE Products

DELETE

http://localhost

/api/v2/tasks/{task_uuid}/products

requires authentication

RateLimit (60/min)

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

URL Parameters

task_uuid

string

uuid of the corresponding task

Example:

a31d8ded-7212-3416-b69f-925985f545ce

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://localhost/api/v2/tasks/a31d8ded-7212-3416-b69f-925985f545ce/products" \
    --header "Authorization: Bearer {YOUR_API_KEY}"

Example response:

[Empty response]

Task Codes

Task Codes are the bar/qr codes that are being scanned in a task.

GET Task Codes

GET

http://localhost

/api/v2/tasks/{task_uuid}/codes

requires authentication

Get collection of codes of a task

RateLimit (60/min)

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

URL Parameters

task_uuid

string

uuid of the corresponding task

Example:

613b42e5-d326-3171-8606-187ccfb107a3

Response Fields

data

object

data

object[]

Collection of codes

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost/api/v2/tasks/613b42e5-d326-3171-8606-187ccfb107a3/codes" \
    --header "Authorization: Bearer {YOUR_API_KEY}"

Example response:

{
    "data": [
        {
            "uuid": "a29a4296-2152-4d6d-8182-c4d00900ffbe",
            "amount": 1,
            "code": "s0wRAWXsemk10CR0",
            "description": "lamp"
        }
    ]
}

POST Task Codes

POST

http://localhost

/api/v2/tasks/{task_uuid}/codes

requires authentication

Create a or multiple codes of a task

RateLimit (60/min)

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

Content-Type

Example:

application/json

URL Parameters

task_uuid

string

uuid of the corresponding task

Example:

39a6193e-ab52-3900-94e6-2035f2bd5d53

Body Parameters

data

object[]

Response Fields

data

object

data

object[]

Collection of codes

Auth

Bearer

Headers

URL Parameters

Body

{ "data": [ { "amount": 23, "code": "smp", "description": "Table" } ] }

Received response

Example request:

curl --request POST \
    "http://localhost/api/v2/tasks/39a6193e-ab52-3900-94e6-2035f2bd5d53/codes" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"data\": [
        {
            \"amount\": 23,
            \"code\": \"smp\",
            \"description\": \"Table\"
        }
    ]
}"

Example response:

{
    "data": [
        {
            "uuid": "a29a4297-a9b5-4a70-a61d-31f12a185043",
            "amount": 1,
            "code": "1234567890",
            "description": "Box"
        },
        {
            "uuid": "a29a4297-aa6a-4864-9d0a-ebcc52dc2868",
            "amount": 2,
            "code": "ABCDEFGHIJ",
            "description": "Table"
        }
    ]
}

GET Task Code

GET

http://localhost

/api/v2/tasks/{task_uuid}/codes/{taskCode_uuid}

requires authentication

Get a code of a task

RateLimit (60/min)

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

URL Parameters

task_uuid

string

uuid of the corresponding task

Example:

be7dc8e4-5f11-33e3-b822-58f4252d749c

taskCode_uuid

string

uuid of the corresponding task code

Example:

a5439d1e-ba8f-391d-a8d4-dc0473444de1

Response Fields

data

object

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost/api/v2/tasks/be7dc8e4-5f11-33e3-b822-58f4252d749c/codes/a5439d1e-ba8f-391d-a8d4-dc0473444de1" \
    --header "Authorization: Bearer {YOUR_API_KEY}"

Example response:

{
    "data": {
        "uuid": "a29a4296-2152-4d6d-8182-c4d00900ffbe",
        "amount": 1,
        "code": "s0wRAWXsemk10CR0",
        "description": "lamp"
    }
}

PUT/PATCH Task Code

PUT

PATCH

http://localhost

/api/v2/tasks/{task_uuid}/codes/{taskCode_uuid}

requires authentication

Update a code of a task

RateLimit (60/min)

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

Content-Type

Example:

application/json

URL Parameters

task_uuid

string

uuid of the corresponding task

Example:

d0d43115-4912-35b1-941b-9acc324d407c

taskCode_uuid

string

uuid of the corresponding task code

Example:

1df8e254-5056-3997-895c-ca0509dfe494

Body Parameters

amount

integer

The amount of times this code needs to be scanned. Must be at least 1. Must not be greater than 100.

Example:

code

string

The code that is needed to be scanned. Must not be greater than 255 characters.

Example:

ccflducuuxdouixoktttvms

description

string

The description of this code. Must not be greater than 255 characters.

Example:

Table

Response Fields

data

object

Auth

Bearer

Headers

URL Parameters

Body

{ "amount": 5, "code": "ccflducuuxdouixoktttvms", "description": "Table" }

Received response

Example request:

curl --request PUT \
    "http://localhost/api/v2/tasks/d0d43115-4912-35b1-941b-9acc324d407c/codes/1df8e254-5056-3997-895c-ca0509dfe494" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"amount\": 5,
    \"code\": \"ccflducuuxdouixoktttvms\",
    \"description\": \"Table\"
}"

Example response:

{
    "data": {
        "uuid": "a29a4296-2152-4d6d-8182-c4d00900ffbe",
        "amount": 1,
        "code": "s0wRAWXsemk10CR0",
        "description": "lamp"
    }
}

DELETE Task Code

DELETE

http://localhost

/api/v2/tasks/{task_uuid}/codes/{taskCode_uuid}

requires authentication

Delete a code of a task

RateLimit (60/min)

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

URL Parameters

task_uuid

string

uuid of the corresponding task

Example:

4d00551f-38ec-38db-b7f0-f0ca24b6f165

taskCode_uuid

string

uuid of the corresponding task code

Example:

9f20dc1f-4a0f-300a-a80d-3e721589adba

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://localhost/api/v2/tasks/4d00551f-38ec-38db-b7f0-f0ca24b6f165/codes/9f20dc1f-4a0f-300a-a80d-3e721589adba" \
    --header "Authorization: Bearer {YOUR_API_KEY}"

Example response:

[Empty response]

Visit Codes

Visit Codes are the bar/qr codes that are being scanned in a visit. A visit is a delivery or pickup attempt for a specific task. Usually, the visit codes are only set when using recurring tasks.

GET Visit Codes

GET

http://localhost

/api/v2/visits/{scheduleVisit_uuid}/codes

requires authentication

Get collection of codes of a visit

RateLimit (60/min)

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

URL Parameters

scheduleVisit_uuid

string

uuid of the corresponding scheduled visit

Example:

4a3c8ada-c65c-33ee-8768-8c9aa62e8bb8

Response Fields

data

object

data

object[]

Collection of codes

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost/api/v2/visits/4a3c8ada-c65c-33ee-8768-8c9aa62e8bb8/codes" \
    --header "Authorization: Bearer {YOUR_API_KEY}"

Example response:

{
    "data": [
        {
            "uuid": "a29a4296-381b-48e1-a394-eb6972686fed",
            "amount": 1,
            "code": "BhtgI5k0ChAPnpnF",
            "description": "table"
        }
    ]
}

POST Visit Codes

POST

http://localhost

/api/v2/visits/{scheduleVisit_uuid}/codes

requires authentication

Create a or multiple codes of a visit

RateLimit (60/min)

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

Content-Type

Example:

application/json

URL Parameters

scheduleVisit_uuid

string

uuid of the corresponding scheduled visit

Example:

3c8e1e6a-54e5-368b-8ea0-684710fd600d

Body Parameters

data

object[]

Response Fields

data

object

data

object[]

Collection of codes

Auth

Bearer

Headers

URL Parameters

Body

{ "data": [ { "amount": 24, "code": "sdrbhmdpsklouwqcarbxsejzf", "description": "Table" } ] }

Received response

Example request:

curl --request POST \
    "http://localhost/api/v2/visits/3c8e1e6a-54e5-368b-8ea0-684710fd600d/codes" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"data\": [
        {
            \"amount\": 24,
            \"code\": \"sdrbhmdpsklouwqcarbxsejzf\",
            \"description\": \"Table\"
        }
    ]
}"

Example response:

{
    "data": [
        {
            "uuid": "a29a4298-64e0-4f27-b2f8-80efb37dfec9",
            "amount": 1,
            "code": "1234567890",
            "description": "Box"
        },
        {
            "uuid": "a29a4298-6583-4a8e-95fb-4af5245c6b0e",
            "amount": 2,
            "code": "ABCDEFGHIJ",
            "description": "Table"
        }
    ]
}

GET Visit Code

GET

http://localhost

/api/v2/visits/{scheduleVisit_uuid}/codes/{scheduleVisitCode_uuid}

requires authentication

Get a code of a visit

RateLimit (60/min)

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

URL Parameters

scheduleVisit_uuid

string

uuid of the corresponding scheduled visit

Example:

a340d38d-dd38-3fa7-8bf8-1c47e26528d2

scheduleVisitCode_uuid

string

uuid of the corresponding scheduled visit code

Example:

d0fb6c1f-3e60-38df-98d9-961de383b83f

Response Fields

data

object

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost/api/v2/visits/a340d38d-dd38-3fa7-8bf8-1c47e26528d2/codes/d0fb6c1f-3e60-38df-98d9-961de383b83f" \
    --header "Authorization: Bearer {YOUR_API_KEY}"

Example response:

{
    "data": {
        "uuid": "a29a4296-381b-48e1-a394-eb6972686fed",
        "amount": 1,
        "code": "BhtgI5k0ChAPnpnF",
        "description": "table"
    }
}

PUT/PATCH Visit Code

PUT

PATCH

http://localhost

/api/v2/visits/{scheduleVisit_uuid}/codes/{scheduleVisitCode_uuid}

requires authentication

Update a code of a visit

RateLimit (60/min)

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

Content-Type

Example:

application/json

URL Parameters

scheduleVisit_uuid

string

uuid of the corresponding scheduled visit

Example:

0ccc5df4-2875-3229-b4ca-2177b6bd1447

scheduleVisitCode_uuid

string

uuid of the corresponding scheduled visit code

Example:

bc064227-1988-38b1-913c-2b015b1aab7b

Body Parameters

amount

integer

The amount of times this code needs to be scanned. Must be at least 1. Must not be greater than 100.

Example:

code

string

The code that is needed to be scanned. Must not be greater than 255 characters.

Example:

vkn

description

string

The description of this code. Must not be greater than 255 characters.

Example:

Table

Response Fields

data

object

Auth

Bearer

Headers

URL Parameters

Body

{ "amount": 9, "code": "vkn", "description": "Table" }

Received response

Example request:

curl --request PUT \
    "http://localhost/api/v2/visits/0ccc5df4-2875-3229-b4ca-2177b6bd1447/codes/bc064227-1988-38b1-913c-2b015b1aab7b" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"amount\": 9,
    \"code\": \"vkn\",
    \"description\": \"Table\"
}"

Example response:

{
    "data": {
        "uuid": "a29a4296-381b-48e1-a394-eb6972686fed",
        "amount": 1,
        "code": "BhtgI5k0ChAPnpnF",
        "description": "table"
    }
}

DELETE Visit Code

DELETE

http://localhost

/api/v2/visits/{scheduleVisit_uuid}/codes/{scheduleVisitCode_uuid}

requires authentication

Delete a code of a visit

RateLimit (60/min)

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

URL Parameters

scheduleVisit_uuid

string

uuid of the corresponding scheduled visit

Example:

7712f069-3c97-3c53-8cf6-2f44f25fd00a

scheduleVisitCode_uuid

string

uuid of the corresponding scheduled visit code

Example:

3e13e9dd-d79e-34b2-bb39-9fa05dda542d

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://localhost/api/v2/visits/7712f069-3c97-3c53-8cf6-2f44f25fd00a/codes/3e13e9dd-d79e-34b2-bb39-9fa05dda542d" \
    --header "Authorization: Bearer {YOUR_API_KEY}"

Example response:

[Empty response]

Task Returnable Packaging

Task Returnable Packaging are the default packaging items beeing expected to be delivered and picked up.

GET Task Returnable Packaging

GET

http://localhost

/api/v2/tasks/{task_uuid}/returnablePackaging

requires authentication

Get collection of returnable packaging of a task

RateLimit (60/min)

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

URL Parameters

task_uuid

string

uuid of the corresponding task

Example:

090dd708-efca-336b-a8c6-5434d3c5bee3

Response Fields

data

object

data

object[]|null

Collection of Task returnable packaging

object

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost/api/v2/tasks/090dd708-efca-336b-a8c6-5434d3c5bee3/returnablePackaging" \
    --header "Authorization: Bearer {YOUR_API_KEY}"

Example response:

{
    "data": [
        {
            "uuid": "a29a4296-23aa-43cc-8a96-02d3f3adc406",
            "count": 1,
            "returnable_packaging_type": {
                "uuid": "a29a4296-22d6-4141-b2ea-0adfa03e8766",
                "type": "crate"
            }
        }
    ]
}

POST Task Returnable Packaging

POST

http://localhost

/api/v2/tasks/{task_uuid}/returnablePackaging

requires authentication

Create a or multiple returnable packaging of a task

RateLimit (60/min)

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

Content-Type

Example:

application/json

URL Parameters

task_uuid

string

uuid of the corresponding task

Example:

0ece2fab-e175-3fc4-bb55-4cb6dcab5633

Body Parameters

data

object[]

Response Fields

data

object

data

object[]|null

Collection of Task returnable packaging

object

Auth

Bearer

Headers

URL Parameters

Body

{ "data": [ { "count": 18, "returnable_packaging_type_uuid": "d3810dca-1a36-3df9-a87e-eb035b8c53de" } ] }

Received response

Example request:

curl --request POST \
    "http://localhost/api/v2/tasks/0ece2fab-e175-3fc4-bb55-4cb6dcab5633/returnablePackaging" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"data\": [
        {
            \"count\": 18,
            \"returnable_packaging_type_uuid\": \"d3810dca-1a36-3df9-a87e-eb035b8c53de\"
        }
    ]
}"

Example response:

{
    "data": [
        {
            "uuid": "a29a4297-d34a-45ca-adcb-562a3934b63c",
            "count": 1,
            "returnable_packaging_type": {
                "uuid": "a29a4296-22d6-4141-b2ea-0adfa03e8766",
                "type": "crate"
            }
        },
        {
            "uuid": "a29a4297-d43c-42cf-854f-560e06364f13",
            "count": -2,
            "returnable_packaging_type": {
                "uuid": "a29a4296-22d6-4141-b2ea-0adfa03e8766",
                "type": "crate"
            }
        }
    ]
}

GET Task Returnable Packaging

GET

http://localhost

/api/v2/tasks/{task_uuid}/returnablePackaging/{taskReturnablePackaging_uuid}

requires authentication

Get a returnable packaging of a task

RateLimit (60/min)

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

URL Parameters

task_uuid

string

uuid of the corresponding task

Example:

44711a1c-eae5-32ee-9529-e077e3ed6588

taskReturnablePackaging_uuid

string

uuid of the corresponding task returnable packaging

Example:

9a11cb0f-e3cd-37bb-ba4c-99ec3d7d7745

Response Fields

data

object

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost/api/v2/tasks/44711a1c-eae5-32ee-9529-e077e3ed6588/returnablePackaging/9a11cb0f-e3cd-37bb-ba4c-99ec3d7d7745" \
    --header "Authorization: Bearer {YOUR_API_KEY}"

Example response:

{
    "data": {
        "uuid": "a29a4296-23aa-43cc-8a96-02d3f3adc406",
        "count": 1,
        "returnable_packaging_type": {
            "uuid": "a29a4296-22d6-4141-b2ea-0adfa03e8766",
            "type": "crate"
        }
    }
}

PUT/PATCH Task Returnable Packaging

PUT

PATCH

http://localhost

/api/v2/tasks/{task_uuid}/returnablePackaging/{taskReturnablePackaging_uuid}

requires authentication

Update a returnable packaging of a task

RateLimit (60/min)

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

Content-Type

Example:

application/json

URL Parameters

task_uuid

string

uuid of the corresponding task

Example:

623db2a5-b329-3371-b528-74c4fd73f519

taskReturnablePackaging_uuid

string

uuid of the corresponding task returnable packaging

Example:

5ebe4d3a-d9c7-3073-bfe7-5a7c9d2e7db7

Body Parameters

count

integer

The amount of returnable packaging pick-up(+) or deliver(-). Must be at least -10000. Must not be greater than 10000.

Example:

code

string

Response Fields

data

object

Auth

Bearer

Headers

URL Parameters

Body

{ "count": 21, "code": null }

Received response

Example request:

curl --request PUT \
    "http://localhost/api/v2/tasks/623db2a5-b329-3371-b528-74c4fd73f519/returnablePackaging/5ebe4d3a-d9c7-3073-bfe7-5a7c9d2e7db7" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"count\": 21
}"

Example response:

{
    "data": {
        "uuid": "a29a4296-23aa-43cc-8a96-02d3f3adc406",
        "count": 1,
        "returnable_packaging_type": {
            "uuid": "a29a4296-22d6-4141-b2ea-0adfa03e8766",
            "type": "crate"
        }
    }
}

DELETE Task Returnable Packaging

DELETE

http://localhost

/api/v2/tasks/{task_uuid}/returnablePackaging/{taskReturnablePackaging_uuid}

requires authentication

Delete a returnable packaging of a task

RateLimit (60/min)

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

URL Parameters

task_uuid

string

uuid of the corresponding task

Example:

a7e625ec-1e24-313a-bf57-7c1e91c211c0

taskReturnablePackaging_uuid

string

uuid of the corresponding task returnable packaging

Example:

9773fc18-61f1-3676-a55c-0ce47a505380

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://localhost/api/v2/tasks/a7e625ec-1e24-313a-bf57-7c1e91c211c0/returnablePackaging/9773fc18-61f1-3676-a55c-0ce47a505380" \
    --header "Authorization: Bearer {YOUR_API_KEY}"

Example response:

[Empty response]

Webhook Groups

Webhook groups are the configured webhooks between Routelogic and your applications.

GET Webhook Groups

GET

http://localhost

/api/v2/webhookGroups

requires authentication

Get paginated collection of webhook groups from your company

RateLimit (60/min)

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

Query Parameters

filters

object

filters.limit

integer

Amount of items on each page. 24 by default. Must not be greater than 100. Must be at least 1.

Example:

filters.page

integer

Page number. 1 by default. Must be at least 1.

Example:

Response Fields

data

object

data

object[]

Collection of webhook events

object

POST Webhook Group

POST

http://localhost

/api/v2/webhookGroups

requires authentication

Create a webhook group for your company.

RateLimit (60/min)

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

Content-Type

Example:

application/json

Body Parameters

name

string

required

The name of the webhook group.

Example:

webhook

description

string

The description of the webhook group.

Example:

Webhook for listening to when a task is created

webhook_url

string

required

The url the webhooks get send to. Must be a valid URL.

Example:

https://example.com/webhook

webhook_secret

string

Optional Bearer token that is required for the end point receiving the webhooks.

Example:

token

events

string[]

required

Must be one of:

task_created
task_updated
task_deleted
visit_status_updated
internal_note_created
schedule_calculated
sending_notifications

Example:

["schedule_calculated"]

Response Fields

data

object

Auth

Bearer

Headers

Body

{ "name": "webhook", "description": "Webhook for listening to when a task is created", "webhook_url": "https:\/\/example.com\/webhook", "webhook_secret": "token", "events": [ "schedule_calculated" ] }

Received response

Example request:

curl --request POST \
    "http://localhost/api/v2/webhookGroups" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"webhook\",
    \"description\": \"Webhook for listening to when a task is created\",
    \"webhook_url\": \"https:\\/\\/example.com\\/webhook\",
    \"webhook_secret\": \"token\",
    \"events\": [
        \"schedule_calculated\"
    ]
}"

Example response:

{
    "data": {
        "uuid": "a29a4298-00b1-4951-9f69-0496d33dc48f",
        "name": "Demo webhook group",
        "description": "send to my api",
        "webhook_url": "https://routelogic.io",
        "events": [
            "task_created",
            "task_updated"
        ]
    }
}

GET Webhook Group

GET

http://localhost

/api/v2/webhookGroups/{webhookGroup_uuid}

requires authentication

Get a webhook group from your company

RateLimit (60/min)

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

URL Parameters

webhookGroup_uuid

string

uuid of the corresponding webhook group

Example:

b4dc4a63-18ec-3ba6-9dd5-e7fe7d3c167b

Response Fields

data

object

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost/api/v2/webhookGroups/b4dc4a63-18ec-3ba6-9dd5-e7fe7d3c167b" \
    --header "Authorization: Bearer {YOUR_API_KEY}"

Example response:

{
    "data": {
        "uuid": "a29a4296-4fb8-45ff-976f-931f1eb2a240",
        "name": "Webhook group 2",
        "description": "task webhook group 2",
        "webhook_url": "https://test.com/webhook/",
        "events": [
            "task_created"
        ]
    }
}

PUT/PATCH Webhook Group

PUT

PATCH

http://localhost

/api/v2/webhookGroups/{webhookGroup_uuid}

requires authentication

Update a webhook group from your company

RateLimit (60/min)

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

Content-Type

Example:

application/json

URL Parameters

webhookGroup_uuid

string

uuid of the corresponding webhook group

Example:

df71fc8b-c043-3fb6-9cb3-96fa5336b82c

Body Parameters

name

string

The name of the webhook group.

Example:

webhook

description

string

The description of the webhook group.

Example:

Webhook for listening to when a task is created

webhook_url

string

The url the webhooks get send to. Must be a valid URL.

Example:

https://example.com/webhook

webhook_secret

string

Optional Bearer token that is required for the end point receiving the webhooks.

Example:

token

events

string[]

required

Must be one of:

task_created
task_updated
task_deleted
visit_status_updated
internal_note_created
schedule_calculated
sending_notifications

Example:

["schedule_calculated"]

Response Fields

data

object

Auth

Bearer

Headers

URL Parameters

Body

Received response

Example request:

curl --request PUT \
    "http://localhost/api/v2/webhookGroups/df71fc8b-c043-3fb6-9cb3-96fa5336b82c" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"name\": \"webhook\",
    \"description\": \"Webhook for listening to when a task is created\",
    \"webhook_url\": \"https:\\/\\/example.com\\/webhook\",
    \"webhook_secret\": \"token\",
    \"events\": [
        \"schedule_calculated\"
    ]
}"

Example response:

{
    "data": {
        "uuid": "a29a4296-4fb8-45ff-976f-931f1eb2a240",
        "name": "Webhook group 2",
        "description": "task webhook group 2",
        "webhook_url": "https://test.com/webhook/",
        "events": [
            "task_created"
        ]
    }
}

DELETE Webhook Group

DELETE

http://localhost

/api/v2/webhookGroups/{webhookGroup_uuid}

requires authentication

Delete a webhook group from your company

RateLimit (60/min)

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

URL Parameters

webhookGroup_uuid

string

uuid of the corresponding webhook group

Example:

a29cf9b4-1396-3655-8455-8328ac95fa51

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://localhost/api/v2/webhookGroups/a29cf9b4-1396-3655-8455-8328ac95fa51" \
    --header "Authorization: Bearer {YOUR_API_KEY}"

Example response:

[Empty response]

Webhook Events

Webhooks are the events that are being sent to your system.

GET Webhooks

GET

http://localhost

/api/v2/webhookEvents

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

Query Parameters

filters

object

filters.status_failed

boolean

Filter by failed status (>= 400). False by default.

filters.limit

integer

Amount of items on each page. 24 by default. Must not be greater than 100. Must be at least 1.

Example:

filters.page

integer

Page number. 1 by default. Must be at least 1.

Example:

Response Fields

data

object

data

object[]

Collection of webhook events

object

uuid

string

Webhook event ID

webhook_url

string

Webhook URL

event_data

object

Webhook event data

response_status

integer

Webhook response status

created_at

string

Webhook event creation date

updated_at

string

Webhook event update date

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost/api/v2/webhookEvents?filters[status_failed]=&filters[limit]=45&filters[page]=8" \
    --header "Authorization: Bearer {YOUR_API_KEY}"

Example response:

{
    "data": [
        {
            "uuid": "b77af12c-5d8f-4dfa-b4af-9bcc894b1be3",
            "webhook_url": "https://test.com/webhook/",
            "event_data": {
                "data": {
                    "note": null,
                    "tags": [],
                    "type": "delivery",
                    "uuid": "a29a4296-0ba7-4ec7-8518-f2eb258bf1fb",
                    "end_time": "17:00:00",
                    "recurring": null,
                    "created_at": "2026-08-27T12:37:37.000000Z",
                    "start_time": "08:00:00",
                    "updated_at": "2026-08-27T12:37:37.000000Z",
                    "delivery_date": "2026-08-27",
                    "external_link": null,
                    "used_capacity": 0,
                    "custom_field_1": null,
                    "custom_field_2": null,
                    "custom_field_3": null,
                    "custom_field_4": null,
                    "shipment_steps": null,
                    "return_required": null,
                    "used_capacity_2": 0,
                    "used_capacity_3": 0,
                    "return_task_uuid": null,
                    "additional_emails": [],
                    "delivery_from_date": null,
                    "external_reference": null,
                    "signature_required": null,
                    "external_identifier": "AXi10k",
                    "track_and_trace_link": "http://localhost/tr/NyZ9jxBkoswp",
                    "pending_payment_amount": 0,
                    "delivery_duration_minutes": 0,
                    "notification_template_uuid": null
                },
                "type": "task_created",
                "timestamp": "2026-08-27T14:37:38+02:00"
            },
            "response_status": 200,
            "created_at": "2026-08-27T12:37:38.000000Z",
            "updated_at": "2026-08-27T12:37:38.000000Z"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 24,
        "to": 1,
        "total": 1,
        "next": null,
        "prev": null
    }
}

GET Webhook

GET

http://localhost

/api/v2/webhookEvents/{webhookEvent_uuid}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

URL Parameters

webhookEvent_uuid

string

uuid of the corresponding webhook event

Example:

f5274d06-de85-3405-9d7e-48a2fb79fa37

Response Fields

data

object

data

object

uuid

string

Webhook event ID

webhook_url

string

Webhook URL

event_data

object

Webhook event data

response_status

integer

Webhook response status

created_at

string

Webhook event creation date

updated_at

string

Webhook event update date

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost/api/v2/webhookEvents/f5274d06-de85-3405-9d7e-48a2fb79fa37" \
    --header "Authorization: Bearer {YOUR_API_KEY}"

Example response:

{
    "data": {
        "uuid": "b77af12c-5d8f-4dfa-b4af-9bcc894b1be3",
        "webhook_url": "https://test.com/webhook/",
        "event_data": {
            "data": {
                "note": null,
                "tags": [],
                "type": "delivery",
                "uuid": "a29a4296-0ba7-4ec7-8518-f2eb258bf1fb",
                "end_time": "17:00:00",
                "recurring": null,
                "created_at": "2026-08-27T12:37:37.000000Z",
                "start_time": "08:00:00",
                "updated_at": "2026-08-27T12:37:37.000000Z",
                "delivery_date": "2026-08-27",
                "external_link": null,
                "used_capacity": 0,
                "custom_field_1": null,
                "custom_field_2": null,
                "custom_field_3": null,
                "custom_field_4": null,
                "shipment_steps": null,
                "return_required": null,
                "used_capacity_2": 0,
                "used_capacity_3": 0,
                "return_task_uuid": null,
                "additional_emails": [],
                "delivery_from_date": null,
                "external_reference": null,
                "signature_required": null,
                "external_identifier": "AXi10k",
                "track_and_trace_link": "http://localhost/tr/NyZ9jxBkoswp",
                "pending_payment_amount": 0,
                "delivery_duration_minutes": 0,
                "notification_template_uuid": null
            },
            "type": "task_created",
            "timestamp": "2026-08-27T14:37:38+02:00"
        },
        "response_status": 200,
        "created_at": "2026-08-27T12:37:38.000000Z",
        "updated_at": "2026-08-27T12:37:38.000000Z"
    }
}

POST Resend Webhook

POST

http://localhost

/api/v2/webhookEvents/{webhookEvent_uuid}/resend

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

URL Parameters

webhookEvent_uuid

string

uuid of the corresponding webhook event

Example:

407c1efe-19fe-38ea-acf4-46616fb191d0

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://localhost/api/v2/webhookEvents/407c1efe-19fe-38ea-acf4-46616fb191d0/resend" \
    --header "Authorization: Bearer {YOUR_API_KEY}"

Example response:

[Empty response]

POST Resend All Failed Webhooks

POST

http://localhost

/api/v2/webhookEvents/resend-all-failed

requires authentication

RateLimit (1/min)

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "http://localhost/api/v2/webhookEvents/resend-all-failed" \
    --header "Authorization: Bearer {YOUR_API_KEY}"

Example response:

{
    "data": [],
    "meta": {
        "count": 0
    }
}

Templates

Templates are the predefined messages that are being sent to your customers.

GET Templates

GET

http://localhost

/api/v2/templates

requires authentication

Get collection of templates

RateLimit (16/min)

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

Response Fields

data

object

data

object[]

Collection of templates

object

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://localhost/api/v2/templates" \
    --header "Authorization: Bearer {YOUR_API_KEY}"

Example response:

{
    "data": [
        {
            "uuid": "a29a4295-dff3-4352-b0c1-2e4cc49e2c0f",
            "identifier": "6RUwgggpHwRyeT1G",
            "title": "Standaard e-mail en SMS notificatie voor bezorgen",
            "default": true,
            "default_pickup": false
        },
        {
            "uuid": "a29a4295-e2b6-4d9f-a1bf-56c4ce211f62",
            "identifier": "RUiahw1KoLIMAA2U",
            "title": "Standaard e-mail en SMS notificatie voor ophalen",
            "default": false,
            "default_pickup": true
        }
    ]
}

Returnable Packaging Types

Returnable packaging types are the types of packaging used in your company wich can be returned after delivery.

GET Returnable packaging types

GET

http://localhost

/api/v2/returnablePackagingTypes

requires authentication

Get collection of returnable packaging types

RateLimit (16/min)

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

Response Fields

data

object

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://localhost/api/v2/returnablePackagingTypes" \
    --header "Authorization: Bearer {YOUR_API_KEY}"

Example response:

{
    "data": [
        {
            "uuid": "a29a4295-f86c-4471-b023-6c4f954cb0cb",
            "type": "Pallet"
        },
        {
            "uuid": "a29a4295-f96d-4130-969b-6f6362670968",
            "type": "Container"
        },
        {
            "uuid": "a29a4295-fa55-4aef-b907-38873fd0b42d",
            "type": "Crate"
        },
        {
            "uuid": "a29a4296-22d6-4141-b2ea-0adfa03e8766",
            "type": "crate"
        },
        {
            "uuid": "a29a4296-3a09-4cf8-b84d-c7fe7441195d",
            "type": "pallets"
        }
    ]
}

Schedules

Schedules are the planned routes for your vehicles.

GET Schedules

GET

http://localhost

/api/v2/schedules

requires authentication

Get paginated collection of schedules including vehicles and visits from your company

RateLimit (5/min)
If you like to receive schedule information quicker use webhooks read more here

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

Query Parameters

filters

object

filters.from_date

string

Find tasks on this date and later. Combine with to_date to select a specific day or a range. Must be a valid date in the format Y-m-d.

Example:

2026-08-27

filters.to_date

string

Find tasks on this date and earlier. Combine with from_date to select a specific day or a range. Must be a valid date in the format Y-m-d.

Example:

2026-08-27

filters.limit

integer

Amount of items on each page. 24 by default. Must not be greater than 24. Must be at least 1.

Example:

filters.page

integer

Must be at least 1.

Example:

Response Fields

data

object

data

object[]

Collection of schedules

object

uuid

string

The uuid of this schedule

date

string

The date this schedule will be completed

description

string|null

Name of this schedule

total_travel_time

float|null

The total travel time of all vehicles in minutes

total_distance

float|null

The total travel distance of all vehicles in meters

notifications_send

boolean

Whether the notifications have been sent or not

schedule_vehicles

object

data

object[]

Collection of vehicles used in this schedule

object

uuid

string

The uuid of this scheduled vehicle

start_time

string|null

The time which the vehicle should start driving

end_time

string|null

The time when the vehicle should be done

started_at

string|null

The time when the vehicle actually started

finished_at

string|null

The time when the vehicle actually was done

total_travel_time

float|null

The total travel time of this vehicle in minutes

total_distance

float|null

The total travel distance of this vehicle in meters

vehicle

object

Vehicle information

user

object|null

Driver information

visits

object

data

object[]

Collection of visits the scheduled vehicle needs to visit

object

uuid

string

The uuid of this visit

type

string

enum(start|end|task|break|charge) The type of visit

order_index

integer

Index on which order the visits should be visited

delivery_time

string

The time which this visit should be completed

delivered_at

string|null

Date and time when this visit was completed

eta_start

string

Start of the estimated arrival time window

eta_end

string

End of the estimated arrival time window

task_uuid

string|null

The related task to this visit

address

object|null

Address information

street

string

The street name

house_number

string

The house number

house_number_extension

string|null

Extra information about the house number

postal_code

string

The postal code

city

string

The city

latitude

number

The latitude of the address

longitude

number

The longitude of the address

country[]

object

Country information

country

object

scanned_codes

object[]|null

Collection of ScannedCodes

returnable_packaging

object[]|null

Collection of Returnable packaging

data

object

task

object|null

Task information

uuid

string

The uuid of this task

type

string

enum(delivery|pickup) The type of this task

external_identifier

string

Unique identifier like order number

external_reference

string|null

Reference for api connections

note

string|null

Internal note for the driver / note from customer on order for the driver

custom_field_1

string|null

Custom field for attaching extra data to a task, displayed in the driver app.

custom_field_2

string|null

Custom field for attaching extra data to a task, displayed in the driver app.

custom_field_3

string|null

Custom field for attaching extra data to a task, displayed in the driver app.

custom_field_4

string|null

Custom field for attaching extra data to a task, displayed in the driver app.

pending_payment_amount

number

Amount the customer needs to pay on delivery

external_link

string|null

Link visible on the track and trace page like a bill

track_and_trace_link

string

Link to the track and trace page

delivery_from_date

string|null

The earliest date the task is allowed to be completed

delivery_date

string

The date the task is supposed to be completed

start_time

string|null

The time window start time. Timezone: Europe/Amsterdam

end_time

string|null

The time window end time. Timezone: Europe/Amsterdam

delivery_duration_minutes

integer

The time needed on location to complete the task

return_required

boolean

Specifies if the task should also have a corresponding 'pickup' task

signature_required

boolean

If the customer is required to place a signature for this task

used_capacity_1

integer

The amount of capacity this task takes

used_capacity_2

integer

The amount of capacity this task takes

used_capacity_3

integer

The amount of capacity this task takes

created_at

string

Date and time when this task was created

updated_at

string

Date and time when this task was updated

tags[]

string[]

The identifier of a tag.

return_task_uuid

string|null

The uuid of a related return task if available

notification_template_uuid

string|null

The uuid of the related notification template,

address

object

Address information

street

string

The street name

house_number

string

The house number

house_number_extension

string|null

Extra information about the house number

postal_code

string

The postal code

city

string

The city

latitude

number

The latitude of the address

longitude

number

The longitude of the address

country

object

Country information

customer

object|null

Customer information

additional_emails

object[]|null

Additional email recipients for notifications. Maximum 5.

files

object[]|null

Collection of Files

signature

string

The key of this file. Used for retrieving the file through the files endpoint.

GET Schedule

GET

http://localhost

/api/v2/schedules/{schedule_uuid}

requires authentication

Get a single schedule by its uuid

RateLimit (60/min)

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

URL Parameters

schedule_uuid

string

required

string The UUID of the schedule

Example:

92b9afbf-1735-313b-90b6-ab2255035085

Response Fields

data

object

uuid

string

The uuid of this schedule

date

string

The date this schedule will be completed

description

string|null

Name of this schedule

total_travel_time

float|null

The total travel time of all vehicles in minutes

total_distance

float|null

The total travel distance of all vehicles in meters

notifications_send

boolean

Whether the notifications have been sent or not

schedule_vehicles

object

data

object[]

Collection of vehicles used in this schedule

object

uuid

string

The uuid of this scheduled vehicle

start_time

string|null

The time which the vehicle should start driving

end_time

string|null

The time when the vehicle should be done

started_at

string|null

The time when the vehicle actually started

finished_at

string|null

The time when the vehicle actually was done

total_travel_time

float|null

The total travel time of this vehicle in minutes

total_distance

float|null

The total travel distance of this vehicle in meters

vehicle

object

Vehicle information

user

object|null

Driver information

visits

object

data

object[]

Collection of visits the scheduled vehicle needs to visit

object

uuid

string

The uuid of this visit

type

string

enum(start|end|task|break|charge) The type of visit

order_index

integer

Index on which order the visits should be visited

delivery_time

string

The time which this visit should be completed

delivered_at

string|null

Date and time when this visit was completed

eta_start

string

Start of the estimated arrival time window

eta_end

string

End of the estimated arrival time window

task_uuid

string|null

The related task to this visit

address

object|null

Address information

street

string

The street name

house_number

string

The house number

house_number_extension

string|null

Extra information about the house number

postal_code

string

The postal code

city

string

The city

latitude

number

The latitude of the address

longitude

number

The longitude of the address

country[]

object

Country information

country

object

scanned_codes

object[]|null

Collection of ScannedCodes

returnable_packaging

object[]|null

Collection of Returnable packaging

data

object

task

object|null

Task information

uuid

string

The uuid of this task

type

string

enum(delivery|pickup) The type of this task

external_identifier

string

Unique identifier like order number

external_reference

string|null

Reference for api connections

note

string|null

Internal note for the driver / note from customer on order for the driver

custom_field_1

string|null

Custom field for attaching extra data to a task, displayed in the driver app.

custom_field_2

string|null

Custom field for attaching extra data to a task, displayed in the driver app.

custom_field_3

string|null

Custom field for attaching extra data to a task, displayed in the driver app.

custom_field_4

string|null

Custom field for attaching extra data to a task, displayed in the driver app.

pending_payment_amount

number

Amount the customer needs to pay on delivery

external_link

string|null

Link visible on the track and trace page like a bill

track_and_trace_link

string

Link to the track and trace page

delivery_from_date

string|null

The earliest date the task is allowed to be completed

delivery_date

string

The date the task is supposed to be completed

start_time

string|null

The time window start time. Timezone: Europe/Amsterdam

end_time

string|null

The time window end time. Timezone: Europe/Amsterdam

delivery_duration_minutes

integer

The time needed on location to complete the task

return_required

boolean

Specifies if the task should also have a corresponding 'pickup' task

signature_required

boolean

If the customer is required to place a signature for this task

used_capacity_1

integer

The amount of capacity this task takes

used_capacity_2

integer

The amount of capacity this task takes

used_capacity_3

integer

The amount of capacity this task takes

created_at

string

Date and time when this task was created

updated_at

string

Date and time when this task was updated

tags[]

string[]

The identifier of a tag.

return_task_uuid

string|null

The uuid of a related return task if available

notification_template_uuid

string|null

The uuid of the related notification template,

address

object

Address information

street

string

The street name

house_number

string

The house number

house_number_extension

string|null

Extra information about the house number

postal_code

string

The postal code

city

string

The city

latitude

number

The latitude of the address

longitude

number

The longitude of the address

country

object

Country information

customer

object|null

Customer information

additional_emails

object[]|null

Additional email recipients for notifications. Maximum 5.

files

object[]|null

Collection of Files

signature

string

The key of this file. Used for retrieving the file through the files endpoint.

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost/api/v2/schedules/92b9afbf-1735-313b-90b6-ab2255035085" \
    --header "Authorization: Bearer {YOUR_API_KEY}"

Example response:

{
    "data": {
        "uuid": "4364f5bb-4cc7-4490-8f07-dec06e7681c2",
        "date": "2026-08-27",
        "description": "Example Schedule 1",
        "total_travel_time": 0,
        "total_distance": 0,
        "notifications_send": false,
        "schedule_vehicles": {
            "data": [
                {
                    "uuid": "a29a4296-2609-46ba-b8be-5a19b2dedd7d",
                    "start_time": "08:00:00",
                    "end_time": "10:00:00",
                    "started_at": "2026-08-27 08:03:00",
                    "finished_at": "2026-08-27 10:02:00",
                    "total_travel_time": 0,
                    "total_distance": 1850,
                    "vehicle": {
                        "uuid": "a29a4296-00f3-4dbd-9647-dbc316f5e566",
                        "licence_plate": "S9Hjtyxzl",
                        "description": "Van 1"
                    },
                    "user": {
                        "uuid": "a29a4296-07c2-4995-b050-78c5d58fd60b",
                        "name": "Prof. Aaron Lindgren DDS",
                        "public_name": "Prof. Aaron Lindgren DDS"
                    },
                    "visits": {
                        "data": [
                            {
                                "uuid": "a29a4296-2856-4c97-9088-10a7923dc09a",
                                "type": "task",
                                "order_index": 0,
                                "delivery_time": "09:00:00",
                                "eta_start": "08:25",
                                "eta_end": "09:25",
                                "delivered_at": "2026-08-27T07:05:00.000000Z",
                                "task": {
                                    "uuid": "a29a4296-0ba7-4ec7-8518-f2eb258bf1fb",
                                    "type": "delivery",
                                    "external_identifier": "RL2fJ8nO6aiB",
                                    "external_reference": null,
                                    "custom_field_1": null,
                                    "custom_field_2": null,
                                    "custom_field_3": null,
                                    "custom_field_4": null,
                                    "note": null,
                                    "pending_payment_amount": 0,
                                    "external_link": null,
                                    "track_and_trace_link": "http://localhost/tr/NyZ9jxBkoswp",
                                    "delivery_from_date": null,
                                    "delivery_date": "2026-08-27",
                                    "start_time": "08:00:00",
                                    "end_time": "17:00:00",
                                    "delivery_duration_minutes": 0,
                                    "recurring": null,
                                    "return_required": false,
                                    "signature_required": false,
                                    "used_capacity": 0,
                                    "used_capacity_2": 0,
                                    "used_capacity_3": 0,
                                    "updated_at": "2026-08-27T12:37:38.000000Z",
                                    "created_at": "2026-08-27T12:37:37.000000Z",
                                    "tags": [],
                                    "notification_template_uuid": null,
                                    "return_task_uuid": null,
                                    "address": {
                                        "street": "8575 Bins Centers",
                                        "house_number": "97445",
                                        "house_number_extension": null,
                                        "postal_code": "63049-1298",
                                        "city": "Mitchellborough",
                                        "latitude": 5.4321,
                                        "longitude": 5.4321,
                                        "address_line": "8575 Bins Centers 97445",
                                        "full_address_line": "8575 Bins Centers 97445, 63049-1298, Mitchellborough",
                                        "country": {
                                            "iso_code": "NL",
                                            "description": "Nederland"
                                        }
                                    },
                                    "customer": {
                                        "name": "Omari Lueilwitz",
                                        "email": "[email protected]",
                                        "phone_number": null
                                    },
                                    "additional_emails": [],
                                    "shipment_steps": null
                                },
                                "schedule_date": "2026-08-26T22:00:00.000000Z",
                                "address": {
                                    "street": "8575 Bins Centers",
                                    "house_number": "97445",
                                    "house_number_extension": null,
                                    "postal_code": "63049-1298",
                                    "city": "Mitchellborough",
                                    "latitude": 5.4321,
                                    "longitude": 5.4321,
                                    "address_line": "8575 Bins Centers 97445",
                                    "full_address_line": "8575 Bins Centers 97445, 63049-1298, Mitchellborough",
                                    "country": {
                                        "iso_code": "NL",
                                        "description": "Nederland"
                                    }
                                },
                                "scanned_codes": {
                                    "data": [
                                        {
                                            "type": "task_code",
                                            "code_uuid": "a29a4296-2152-4d6d-8182-c4d00900ffbe",
                                            "scanned_count": 1
                                        },
                                        {
                                            "type": "schedule_visit_code",
                                            "code_uuid": "a29a4296-381b-48e1-a394-eb6972686fed",
                                            "scanned_count": 1
                                        }
                                    ]
                                },
                                "returnable_packaging": {
                                    "data": [
                                        {
                                            "uuid": "a29a4296-3b40-4d81-9920-e139158f5e2e",
                                            "count": -2,
                                            "returnable_packaging_type": {
                                                "uuid": "a29a4296-3a09-4cf8-b84d-c7fe7441195d",
                                                "type": "pallets"
                                            }
                                        }
                                    ]
                                },
                                "status": {
                                    "status_identifier": "delivered"
                                },
                                "signature": "YTI5YTQyOTYtMjg1Ni00Yzk3LTkwODgtMTBhNzkyM2RjMDlh",
                                "files": {
                                    "data": [
                                        {
                                            "type": "image",
                                            "key": "OEhHbzZZdlBVVnRrU1QzNA"
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                }
            ]
        }
    }
}

POST Send schedule notifications

POST

http://localhost

/api/v2/schedules/{schedule_uuid}/send-notifications

requires authentication

Send the notifications to all the customers within a schedule.

RateLimit (60/min)

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

Content-Type

Example:

application/json

URL Parameters

schedule_uuid

string

required

Example:

4364f5bb-4cc7-4490-8f07-dec06e7681c2

Body Parameters

types

string[]

On what channels do you want to send this message, don't select any if you only want to receive the webhook.

Must be one of:

email
sms

Example:

["sms"]

mode

string

Must be one of:

all
resend
unsent_only

Example:

enim

Auth

Bearer

Headers

URL Parameters

Body

{ "types": [ "sms" ], "mode": "enim" }

Received response

Example request:

curl --request POST \
    "http://localhost/api/v2/schedules/4364f5bb-4cc7-4490-8f07-dec06e7681c2/send-notifications" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"types\": [
        \"sms\"
    ],
    \"mode\": \"enim\"
}"

Example response:

[Empty response]

Appointments

POST api/v2/appointments/availability

POST

http://localhost

/api/v2/appointments/availability

Headers

Content-Type

Example:

application/json

Body Parameters

data

object

latitude

number

required

The latitude of the task.

Example:

223848229.7

longitude

number

required

The longitude of the task.

Example:

38634

tags

string[]

Must not be greater than 255 characters.

Example:

["bzfbipaqjclgjhrisobqshnmg"]

delivery_duration_minutes

integer

required

The duration of the delivery in minutes. Must be at least 1. Must not be greater than 1440.

Example:

start_date

string

required

The start date to check for available timeslots. Must be a valid date in the format Y-m-d. Must be a date after or equal to today.

Example:

2126-01-26

end_date

string

required

The end date to check for available timeslots, must be after the start date. Can't be more than 7 days after the start date. Must be a valid date in the format Y-m-d. Must be a date after or equal to data.start_date.

Example:

2074-05-31

used_capacity

integer

Must be at least 0. Must not be greater than 10000.

Example:

used_capacity_2

integer

Must be at least 0. Must not be greater than 10000.

Example:

used_capacity_3

integer

Must be at least 0. Must not be greater than 10000.

Example:

type

string

required

Must be one of:

delivery
pickup

Example:

pickup

Headers

Body

{ "data": { "latitude": 223848229.7, "longitude": 38634, "tags": [ "bzfbipaqjclgjhrisobqshnmg" ], "delivery_duration_minutes": 5, "start_date": "2126-01-26", "end_date": "2074-05-31", "used_capacity": 22, "used_capacity_2": 22, "used_capacity_3": 15, "type": "pickup" } }

Received response

Example request:

curl --request POST \
    "http://localhost/api/v2/appointments/availability" \
    --header "Content-Type: application/json" \
    --data "{
    \"data\": {
        \"latitude\": 223848229.7,
        \"longitude\": 38634,
        \"tags\": [
            \"bzfbipaqjclgjhrisobqshnmg\"
        ],
        \"delivery_duration_minutes\": 5,
        \"start_date\": \"2126-01-26\",
        \"end_date\": \"2074-05-31\",
        \"used_capacity\": 22,
        \"used_capacity_2\": 22,
        \"used_capacity_3\": 15,
        \"type\": \"pickup\"
    }
}"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 1000
                                                                                                                    x-ratelimit-remaining
                                                            : 963
                                                                                                                    vary
                                                            : Origin

{
    "message": "Access token missing"
}

POST api/v2/appointments

POST

http://localhost

/api/v2/appointments

Headers

Content-Type

Example:

application/json

Body Parameters

type

string

The type of this task: delivery or pickup.

Must be one of:

delivery
pickup

Example:

delivery

external_identifier

string

required

Unique identifier like order number. Must not be greater than 255 characters.

Example:

ORD-12345

external_reference

string

Reference for api connections. Must not be greater than 255 characters.

Example:

REF-6789

note

string

Internal note for the driver / note from customer on order for the driver. Must not be greater than 20000 characters.

Example:

Please deliver at the side door.

external_link

string

Link visible on the track and trace page like a bill. Must not be greater than 2048 characters.

Example:

https://example.com/

start_time

string

The time window start time. Format: H:i. Must be a valid date in the format H:i.

Example:

08:00

end_time

string

The time window end time. Must be after start_time. Format: H:i. Must be a valid date in the format H:i. Must be a date after start_time.

Example:

17:00

delivery_duration_minutes

integer

The time needed on location to complete the task (0-1440 minutes). Must be at least 0. Must not be greater than 1440.

Example:

signature_required

boolean

If the customer is required to place a signature for this task.

Example:

used_capacity

number

The amount of capacity this task takes (up to 99999999.99 with max 2 decimal places). Must be at least 0. Must not be greater than 99999999.99.

Example:

10.5

used_capacity_2

number

The second capacity measurement for this task (up to 99999999.99 with max 2 decimal places). Must be at least 0. Must not be greater than 99999999.99.

Example:

5.25

used_capacity_3

number

The third capacity measurement for this task (up to 99999999.99 with max 2 decimal places). Must be at least 0. Must not be greater than 99999999.99.

Example:

2.75

notification_template_uuid

string

The uuid of the related notification template, requires NOTIFICATIONS feature. Must be a valid UUID.

Example:

123e4567-e89b-12d3-a456-426614174000

customer

string

required

Customer information.

tags

string[]

The identifier of a tag (max 250 characters). This field is required when tags is present. Must not be greater than 250 characters.

Example:

["cooled"]

appointment_date

string

required

The date of the appointment. Must be a valid date.

Example:

2023-12-31

address

object

required

Address information.

house_number

string

The house number. Must not be greater than 255 characters.

Example:

house_number_extension

string

Extra information about the house number. Must not be greater than 255 characters.

Example:

street

string

The street name (required unless latitude and longitude are provided). This field is required when address.latitude or address.longitude is not present. Must not be greater than 255 characters.

Example:

LongStreet

postal_code

string

The postal code (required unless latitude and longitude are provided). This field is required when address.latitude or address.longitude is not present. Must not be greater than 255 characters.

Example:

1234AB

city

string

The city (required unless latitude and longitude are provided). This field is required when address.latitude or address.longitude is not present. Must not be greater than 255 characters.

Example:

Amsterdam

country

string

required

The iso code of the country. Must match an existing stored value.

Example:

latitude

number

The latitude of the address (required with longitude if street/city/postal_code not provided). This field is required when address.city, address.street, or address.postal_code is not present. This field is required when address.longitude is present. Must be at least -90. Must not be greater than 90.

Example:

52.3675734

longitude

number

The longitude of the address (required with latitude if street/city/postal_code not provided). This field is required when address.city, address.street, or address.postal_code is not present. This field is required when address.latitude is present. Must be at least -180. Must not be greater than 180.

Example:

4.9041389

Headers

Body

{ "type": "delivery", "external_identifier": "ORD-12345", "external_reference": "REF-6789", "note": "Please deliver at the side door.", "external_link": "https:\/\/example.com\/", "start_time": "08:00", "end_time": "17:00", "delivery_duration_minutes": 30, "signature_required": true, "used_capacity": 10.5, "used_capacity_2": 5.25, "used_capacity_3": 2.75, "notification_template_uuid": "123e4567-e89b-12d3-a456-426614174000", "customer": { "name": "Andrew Smith", "email": "[email protected]", "phone_number": "+01 234567890" }, "tags": [ "cooled" ], "appointment_date": "2023-12-31", "address": { "house_number": "12", "house_number_extension": "1A", "street": "LongStreet", "postal_code": "1234AB", "city": "Amsterdam", "country": "NL", "latitude": 52.3675734, "longitude": 4.9041389 } }

Received response

Example request:

curl --request POST \
    "http://localhost/api/v2/appointments" \
    --header "Content-Type: application/json" \
    --data "{
    \"type\": \"delivery\",
    \"external_identifier\": \"ORD-12345\",
    \"external_reference\": \"REF-6789\",
    \"note\": \"Please deliver at the side door.\",
    \"external_link\": \"https:\\/\\/example.com\\/\",
    \"start_time\": \"08:00\",
    \"end_time\": \"17:00\",
    \"delivery_duration_minutes\": 30,
    \"signature_required\": true,
    \"used_capacity\": 10.5,
    \"used_capacity_2\": 5.25,
    \"used_capacity_3\": 2.75,
    \"notification_template_uuid\": \"123e4567-e89b-12d3-a456-426614174000\",
    \"customer\": \"fuga\",
    \"tags\": [
        \"cooled\"
    ],
    \"appointment_date\": \"2023-12-31\",
    \"address\": {
        \"house_number\": \"12\",
        \"house_number_extension\": \"1A\",
        \"street\": \"LongStreet\",
        \"postal_code\": \"1234AB\",
        \"city\": \"Amsterdam\",
        \"country\": \"NL\",
        \"latitude\": 52.3675734,
        \"longitude\": 4.9041389
    }
}"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 1000
                                                                                                                    x-ratelimit-remaining
                                                            : 962
                                                                                                                    vary
                                                            : Origin

{
    "message": "Access token missing"
}

Files

Files are photo's and signature's from a visit

GET File

GET

http://localhost

/api/v2/file/{key}

requires authentication

Get the image of a photo or a signature by key

RateLimit (60/min)

Headers

Authorization

Example:

Bearer {YOUR_API_KEY}

URL Parameters

key

string

required

The key of the related image

Example:

Y2DAi383qkBcm

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost/api/v2/file/Y2DAi383qkBcm" \
    --header "Authorization: Bearer {YOUR_API_KEY}"

Example response:

[Binary data] -  The image

Examples

Examples of how to use the API

How to generate an order pick list

It is possible to generate an order pick list for all routes on a specific date. This can be done by sending a GET request to the api/v2/schedules endpoint with the filters.date as a query parameter. The response will show you all the tasks for a specific date in order per vehicle.

How to sync my cms with routelogic (webhooks)

It is possible to sync your CMS with RouteLogic by using webhooks. You can create a webhook in the RouteLogic dashboard that will send a POST request to your CMS every time a task is created, updated or deleted. This way you can keep your CMS up to date with the latest information from RouteLogic. It is possible to set a bearer token for each webhook to make sure that only authorized requests are accepted by your CMS.

Moreover, you van also use the visit_status_updated webhook to get notified when the status of a visit is updated. The internal_note_created webhook can be used to get notified when an internal note is created by a driver.

How to work with barcodes / QR codes

To be able to scan barcodes or QR codes, they have to be linked to a task or visit in RouteLogic. In most cases a code should be linked to a task. This can be done by sending a POST request to the api/v2/tasks/{task_uuid}/codes endpoint with the barcode as a payload. Sometimes a package with the same code should be scanned multiple times. This can be done by adding the amount parameter to the payload.

It is possible to scan a code when delivering an order with the RouteLogic Driver App. The scanned codes will be visible in the manager portal and the scanned codes are also visible in a task endpoint.

Codes and recurring tasks

A recurring task is a task that is repeated on a regular basis. To create a recurring task, you add a recurring object to the payload of the POST request to the api/v2/tasks endpoint. If you want the same code for each delivery, you send a POST request to the api/v2/tasks/{task_uuid}/codes endpoint with the code as a payload. But if you want the code for just a specific delivery, you can add the code to the payload of the POST request to the api/v2/visits/{scheduleVisit_uuid}/codes endpoint. This will make sure that the code is only linked to that specific delivery and not to future deliveries.

Sending Notifications from Your Own Application

You can send notifications directly from your own application. To ensure this also works with the "Send Notifications" button in the Routelogic interface and to keep Routelogic aware of the notification status we recommend following this flow:

Enable Self-Managed Notifications Go to Notifications > Manage notifications yourself and make sure this setting is turned on.
Set Up the sending_notifications Webhook Configure the sending_notifications webhook. When this webhook is triggered, handle the messages in your application as needed.
Automate Notification Sending (Optional) If you want to automate notifications (without user interaction), do not send the notifications directly from your application. Instead, use the API endpoint: /api/v2/schedules/{schedule_uuid}/send-notifications This approach ensures Routelogic is aware of the notification status and triggers the webhook so you can process the messages accordingly.

Returnable Packaging

We don’t keep track of how many total returnable packaging items (like pallets or crates) are at a customer’s location. However, we do give you the tools to track this yourself using your own system. One way to do this is by using our schedule endpoint: /api/v2/schedules/{schedule_uuid} together with the visit_status_updated webhook. This includes returnable_packaging data per visit, showing how many items (like pallets) were delivered or picked up. Drivers can record these amounts in the app, so you can keep track of them through the API. Within the applications settings you can setup packaging types. To match these in your own system you can retrieve them with the /api/v2/returnablePackagingTypes endpoint.

Webhooks

This document describes the webhooks that are send by RouteLogic Webhooks are used to notify external systems about events that happen in the system. The webhooks are send to the provided webhook URL in the webhook group. The webhook URL can be set in the company synchronisation settings. It is possible to set multiple webhook URLs and only send specific events.

task_created

This event is sent when a task has been created

{
    "type": "task_created",
    "timestamp": "2026-08-27T14:37:39+02:00",
    "data": {
        "uuid": "a29a4296-0ba7-4ec7-8518-f2eb258bf1fb",
        "type": "delivery",
        "external_identifier": "AXi10k",
        "external_reference": null,
        "custom_field_1": null,
        "custom_field_2": null,
        "custom_field_3": null,
        "custom_field_4": null,
        "note": null,
        "pending_payment_amount": 0,
        "external_link": null,
        "track_and_trace_link": "http:\/\/localhost\/tr\/NyZ9jxBkoswp",
        "delivery_from_date": null,
        "delivery_date": "2026-08-27",
        "start_time": "08:00:00",
        "end_time": "17:00:00",
        "delivery_duration_minutes": 0,
        "recurring": null,
        "return_required": null,
        "signature_required": null,
        "used_capacity": 0,
        "used_capacity_2": 0,
        "used_capacity_3": 0,
        "updated_at": "2026-08-27T12:37:37.000000Z",
        "created_at": "2026-08-27T12:37:37.000000Z",
        "tags": [],
        "notification_template_uuid": null,
        "return_task_uuid": null,
        "additional_emails": [],
        "shipment_steps": null
    }
}

task_updated

This event is sent when a task has been updated

{
    "type": "task_updated",
    "timestamp": "2026-08-27T14:37:39+02:00",
    "data": {
        "uuid": "a29a4296-0ba7-4ec7-8518-f2eb258bf1fb",
        "type": "delivery",
        "external_identifier": "AXi10k",
        "external_reference": null,
        "custom_field_1": null,
        "custom_field_2": null,
        "custom_field_3": null,
        "custom_field_4": null,
        "note": null,
        "pending_payment_amount": 0,
        "external_link": null,
        "track_and_trace_link": "http:\/\/localhost\/tr\/NyZ9jxBkoswp",
        "delivery_from_date": null,
        "delivery_date": "2026-08-27",
        "start_time": "08:00:00",
        "end_time": "17:00:00",
        "delivery_duration_minutes": 0,
        "recurring": null,
        "return_required": null,
        "signature_required": null,
        "used_capacity": 0,
        "used_capacity_2": 0,
        "used_capacity_3": 0,
        "updated_at": "2026-08-27T12:37:37.000000Z",
        "created_at": "2026-08-27T12:37:37.000000Z",
        "tags": [],
        "notification_template_uuid": null,
        "return_task_uuid": null,
        "additional_emails": [],
        "shipment_steps": null
    }
}

task_deleted

This event is sent when a task has been deleted

{
    "type": "task_deleted",
    "timestamp": "2026-08-27T14:37:39+02:00",
    "data": {
        "uuid": "a29a4296-0ba7-4ec7-8518-f2eb258bf1fb",
        "type": "delivery",
        "external_identifier": "AXi10k",
        "external_reference": null,
        "custom_field_1": null,
        "custom_field_2": null,
        "custom_field_3": null,
        "custom_field_4": null,
        "note": null,
        "pending_payment_amount": 0,
        "external_link": null,
        "track_and_trace_link": "http:\/\/localhost\/tr\/NyZ9jxBkoswp",
        "delivery_from_date": null,
        "delivery_date": "2026-08-27",
        "start_time": "08:00:00",
        "end_time": "17:00:00",
        "delivery_duration_minutes": 0,
        "recurring": null,
        "return_required": null,
        "signature_required": null,
        "used_capacity": 0,
        "used_capacity_2": 0,
        "used_capacity_3": 0,
        "updated_at": "2026-08-27T12:37:37.000000Z",
        "created_at": "2026-08-27T12:37:37.000000Z",
        "tags": [],
        "notification_template_uuid": null,
        "return_task_uuid": null,
        "additional_emails": [],
        "shipment_steps": null
    }
}

visit_status_updated

This event is sent when a visit status has been updated

{
    "type": "visit_status_updated",
    "timestamp": "2026-08-27T14:37:39+02:00",
    "data": {
        "uuid": "a29a4296-2856-4c97-9088-10a7923dc09a",
        "type": "task",
        "order_index": 0,
        "delivery_time": "09:00:00",
        "eta_start": "08:25",
        "eta_end": "09:25",
        "delivered_at": "2026-08-27T07:05:00.000000Z",
        "task": {
            "uuid": "a29a4296-0ba7-4ec7-8518-f2eb258bf1fb",
            "type": "delivery",
            "external_identifier": "AXi10k",
            "external_reference": null,
            "custom_field_1": null,
            "custom_field_2": null,
            "custom_field_3": null,
            "custom_field_4": null,
            "note": null,
            "pending_payment_amount": 0,
            "external_link": null,
            "track_and_trace_link": "http:\/\/localhost\/tr\/NyZ9jxBkoswp",
            "delivery_from_date": null,
            "delivery_date": "2026-08-27",
            "start_time": "08:00:00",
            "end_time": "17:00:00",
            "delivery_duration_minutes": 0,
            "recurring": null,
            "return_required": false,
            "signature_required": false,
            "used_capacity": 0,
            "used_capacity_2": 0,
            "used_capacity_3": 0,
            "updated_at": "2026-08-27T12:37:38.000000Z",
            "created_at": "2026-08-27T12:37:37.000000Z",
            "tags": [],
            "notification_template_uuid": null,
            "return_task_uuid": null,
            "address": {
                "street": "8575 Bins Centers",
                "house_number": "97445",
                "house_number_extension": null,
                "postal_code": "63049-1298",
                "city": "Mitchellborough",
                "latitude": 5.4321,
                "longitude": 5.4321,
                "address_line": "8575 Bins Centers 97445",
                "full_address_line": "8575 Bins Centers 97445, 63049-1298, Mitchellborough",
                "country": {
                    "iso_code": "NL",
                    "description": "Nederland"
                }
            },
            "customer": {
                "name": "Omari Lueilwitz",
                "email": "[email protected]",
                "phone_number": null
            },
            "additional_emails": [],
            "shipment_steps": null
        },
        "schedule_date": "2026-08-26T22:00:00.000000Z",
        "status": {
            "status_identifier": "delivered"
        },
        "signature": "YTI5YTQyOTYtMjg1Ni00Yzk3LTkwODgtMTBhNzkyM2RjMDlh",
        "files": {
            "data": [
                {
                    "type": "image",
                    "key": "OEhHbzZZdlBVVnRrU1QzNA"
                }
            ]
        },
        "schedule_uuid": "4364f5bb-4cc7-4490-8f07-dec06e7681c2"
    }
}

internal_note_created

This event is send when an internal note has been created

{
    "type": "internal_note_created",
    "timestamp": "2026-08-27T14:37:39+02:00",
    "data": {
        "message": "This is an example message. Drivers use this to communicate with their managers",
        "visit": {
            "uuid": "a29a4296-2856-4c97-9088-10a7923dc09a",
            "type": "task",
            "order_index": 0,
            "delivery_time": "09:00:00",
            "eta_start": "08:25",
            "eta_end": "09:25",
            "delivered_at": "2026-08-27T07:05:00.000000Z",
            "task": {
                "uuid": "a29a4296-0ba7-4ec7-8518-f2eb258bf1fb",
                "type": "delivery",
                "external_identifier": "RL2fJ8nO6aiB",
                "external_reference": null,
                "custom_field_1": null,
                "custom_field_2": null,
                "custom_field_3": null,
                "custom_field_4": null,
                "note": null,
                "pending_payment_amount": 0,
                "external_link": null,
                "track_and_trace_link": "http:\/\/localhost\/tr\/NyZ9jxBkoswp",
                "delivery_from_date": null,
                "delivery_date": "2026-08-27",
                "start_time": "08:00:00",
                "end_time": "17:00:00",
                "delivery_duration_minutes": 0,
                "recurring": null,
                "return_required": false,
                "signature_required": false,
                "used_capacity": 0,
                "used_capacity_2": 0,
                "used_capacity_3": 0,
                "updated_at": "2026-08-27T12:37:38.000000Z",
                "created_at": "2026-08-27T12:37:37.000000Z",
                "tags": [],
                "notification_template_uuid": null,
                "return_task_uuid": null,
                "address": {
                    "street": "8575 Bins Centers",
                    "house_number": "97445",
                    "house_number_extension": null,
                    "postal_code": "63049-1298",
                    "city": "Mitchellborough",
                    "latitude": 5.4321,
                    "longitude": 5.4321,
                    "address_line": "8575 Bins Centers 97445",
                    "full_address_line": "8575 Bins Centers 97445, 63049-1298, Mitchellborough",
                    "country": {
                        "iso_code": "NL",
                        "description": "Nederland"
                    }
                },
                "customer": {
                    "name": "Omari Lueilwitz",
                    "email": "[email protected]",
                    "phone_number": null
                },
                "additional_emails": [],
                "shipment_steps": null
            },
            "schedule_date": "2026-08-26T22:00:00.000000Z",
            "status": {
                "status_identifier": "delivered"
            },
            "signature": "YTI5YTQyOTYtMjg1Ni00Yzk3LTkwODgtMTBhNzkyM2RjMDlh",
            "files": {
                "data": [
                    {
                        "type": "image",
                        "key": "OEhHbzZZdlBVVnRrU1QzNA"
                    }
                ]
            }
        }
    }
}

schedule_calculated

This event is sent everytime a schedule has been calculated

{
    "type": "schedule_calculated",
    "timestamp": "2026-08-27T14:37:39+02:00",
    "data": {
        "uuid": "4364f5bb-4cc7-4490-8f07-dec06e7681c2",
        "date": "2026-08-27",
        "description": "Example Schedule 1",
        "total_travel_time": 0,
        "total_distance": 0,
        "notifications_send": false,
        "schedule_vehicles": {
            "data": [
                {
                    "uuid": "a29a4296-2609-46ba-b8be-5a19b2dedd7d",
                    "start_time": "08:00:00",
                    "end_time": "10:00:00",
                    "started_at": "2026-08-27 08:03:00",
                    "finished_at": "2026-08-27 10:02:00",
                    "total_travel_time": 0,
                    "total_distance": 1850,
                    "vehicle": {
                        "uuid": "a29a4296-00f3-4dbd-9647-dbc316f5e566",
                        "licence_plate": "S9Hjtyxzl",
                        "description": "Van 1"
                    },
                    "visits": {
                        "data": [
                            {
                                "uuid": "a29a4296-2856-4c97-9088-10a7923dc09a",
                                "type": "task",
                                "order_index": 0,
                                "delivery_time": "09:00:00",
                                "delivered_at": "2026-08-27T07:05:00.000000Z",
                                "task": {
                                    "uuid": "a29a4296-0ba7-4ec7-8518-f2eb258bf1fb",
                                    "external_identifier": "RL2fJ8nO6aiB"
                                },
                                "task_uuid": "a29a4296-0ba7-4ec7-8518-f2eb258bf1fb",
                                "schedule_date": "2026-08-26T22:00:00.000000Z",
                                "status": {
                                    "status_identifier": "delivered"
                                },
                                "signature": "YTI5YTQyOTYtMjg1Ni00Yzk3LTkwODgtMTBhNzkyM2RjMDlh",
                                "files": {
                                    "data": [
                                        {
                                            "type": "image",
                                            "key": "OEhHbzZZdlBVVnRrU1QzNA"
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                }
            ]
        }
    }
}

sending_notifications

This event is sent everytime the notifications are being send through the button in the application or the api.

{
    "type": "sending_notifications",
    "timestamp": "2026-08-27T14:37:39+02:00",
    "data": {
        "uuid": "4364f5bb-4cc7-4490-8f07-dec06e7681c2",
        "date": "2026-08-27",
        "description": "Example Schedule 1",
        "total_travel_time": 0,
        "total_distance": 0,
        "notifications_send": false,
        "first_notification": true,
        "schedule_vehicles": {
            "data": [
                {
                    "uuid": "a29a4296-2609-46ba-b8be-5a19b2dedd7d",
                    "start_time": "08:00:00",
                    "end_time": "10:00:00",
                    "started_at": "2026-08-27 08:03:00",
                    "finished_at": "2026-08-27 10:02:00",
                    "total_travel_time": 0,
                    "total_distance": 1850,
                    "vehicle": {
                        "uuid": "a29a4296-00f3-4dbd-9647-dbc316f5e566",
                        "licence_plate": "S9Hjtyxzl",
                        "description": "Van 1"
                    },
                    "user": {
                        "uuid": "a29a4296-07c2-4995-b050-78c5d58fd60b",
                        "name": "Prof. Aaron Lindgren DDS",
                        "public_name": "Prof. Aaron Lindgren DDS"
                    },
                    "visits": {
                        "data": [
                            {
                                "uuid": "a29a4296-2856-4c97-9088-10a7923dc09a",
                                "type": "task",
                                "order_index": 0,
                                "delivery_time": "09:00:00",
                                "eta_start": "08:25",
                                "eta_end": "09:25",
                                "delivered_at": "2026-08-27T07:05:00.000000Z",
                                "task": {
                                    "uuid": "a29a4296-0ba7-4ec7-8518-f2eb258bf1fb",
                                    "type": "delivery",
                                    "external_identifier": "RL2fJ8nO6aiB",
                                    "external_reference": null,
                                    "custom_field_1": null,
                                    "custom_field_2": null,
                                    "custom_field_3": null,
                                    "custom_field_4": null,
                                    "note": null,
                                    "pending_payment_amount": 0,
                                    "external_link": null,
                                    "track_and_trace_link": "http:\/\/localhost\/tr\/NyZ9jxBkoswp",
                                    "delivery_from_date": null,
                                    "delivery_date": "2026-08-27",
                                    "start_time": "08:00:00",
                                    "end_time": "17:00:00",
                                    "delivery_duration_minutes": 0,
                                    "recurring": null,
                                    "return_required": false,
                                    "signature_required": false,
                                    "used_capacity": 0,
                                    "used_capacity_2": 0,
                                    "used_capacity_3": 0,
                                    "updated_at": "2026-08-27T12:37:38.000000Z",
                                    "created_at": "2026-08-27T12:37:37.000000Z",
                                    "tags": [],
                                    "notification_template_uuid": null,
                                    "return_task_uuid": null,
                                    "address": {
                                        "street": "8575 Bins Centers",
                                        "house_number": "97445",
                                        "house_number_extension": null,
                                        "postal_code": "63049-1298",
                                        "city": "Mitchellborough",
                                        "latitude": 5.4321,
                                        "longitude": 5.4321,
                                        "address_line": "8575 Bins Centers 97445",
                                        "full_address_line": "8575 Bins Centers 97445, 63049-1298, Mitchellborough",
                                        "country": {
                                            "iso_code": "NL",
                                            "description": "Nederland"
                                        }
                                    },
                                    "customer": {
                                        "name": "Omari Lueilwitz",
                                        "email": "[email protected]",
                                        "phone_number": null
                                    },
                                    "additional_emails": [],
                                    "shipment_steps": null
                                },
                                "schedule_date": "2026-08-26T22:00:00.000000Z",
                                "status": {
                                    "status_identifier": "delivered"
                                },
                                "signature": "YTI5YTQyOTYtMjg1Ni00Yzk3LTkwODgtMTBhNzkyM2RjMDlh"
                            }
                        ]
                    }
                }
            ]
        }
    }
}