RouteLogic Documentation

Postman collection → OpenAPI spec →

Introduction

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-04-09
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-04-09
filters.types
string[]

Filter on specific task types.

Must be one of:
  • delivery
  • pickup
  • recurring
Example:
["recurring"]
filters.statuses
string[]

Filter on tasks with a specific status.

Must be one of:
  • planned
  • not_planned
  • delivered
  • delivery_failed
Example:
["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:
4
filters.page
integer

Must be at least 1.

Example:
22

Response Fields

Example request: 
curl --request GET \
    --get "http://localhost/api/v2/tasks?filters[search]=Amsterdam&filters[from_date]=2026-04-09&filters[to_date]=2026-04-09&filters[types][]=recurring&filters[statuses][]=planned&filters[deleted]=only&filters[limit]=4&filters[page]=22" \
    --header "Authorization: Bearer {YOUR_API_KEY}"
Example response:
{
    "data": [
        {
            "uuid": "a180e9a4-886a-4f1c-b89d-5cf244b528c3",
            "type": "delivery",
            "external_identifier": "eEPWyE",
            "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/k4EqVr1tMUO5",
            "delivery_from_date": null,
            "delivery_date": "2026-04-09",
            "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-04-09T16:01:17.000000Z",
            "created_at": "2026-04-09T16:01:17.000000Z",
            "tags": [],
            "notification_template_uuid": null,
            "return_task_uuid": null,
            "address": {
                "street": "1576 Emerson Ridge Apt. 583",
                "house_number": "517",
                "house_number_extension": null,
                "postal_code": "28838",
                "city": "New Turner",
                "latitude": 5.4321,
                "longitude": 5.4321,
                "address_line": "1576 Emerson Ridge Apt. 583 517",
                "full_address_line": "1576 Emerson Ridge Apt. 583 517, 28838, New Turner",
                "country": {
                    "iso_code": "NL",
                    "description": "Nederland"
                }
            },
            "customer": {
                "name": "Fabian Skiles",
                "email": "[email protected]",
                "phone_number": null
            },
            "shipment_steps": null,
            "visit_uuids": [
                "a180e9a4-abed-4091-b1e1-a483b9c37e37"
            ],
            "next_visit": {
                "uuid": "a180e9a4-abed-4091-b1e1-a483b9c37e37",
                "type": "task",
                "order_index": 0,
                "delivery_time": "09:00:00",
                "delivered_at": "2026-04-09T07:05:00.000000Z",
                "schedule_date": "2026-04-08T22:00:00.000000Z",
                "address": {
                    "street": "1576 Emerson Ridge Apt. 583",
                    "house_number": "517",
                    "house_number_extension": null,
                    "postal_code": "28838",
                    "city": "New Turner",
                    "latitude": 5.4321,
                    "longitude": 5.4321,
                    "address_line": "1576 Emerson Ridge Apt. 583 517",
                    "full_address_line": "1576 Emerson Ridge Apt. 583 517, 28838, New Turner",
                    "country": {
                        "iso_code": "NL",
                        "description": "Nederland"
                    }
                },
                "scanned_codes": {
                    "data": [
                        {
                            "type": "task_code",
                            "code_uuid": "a180e9a4-a4a4-4ad6-b31e-3729a7610302",
                            "scanned_count": 1
                        },
                        {
                            "type": "schedule_visit_code",
                            "code_uuid": "a180e9a4-c5cf-4625-aaca-0fcd398fae0c",
                            "scanned_count": 1
                        }
                    ]
                },
                "returnable_packaging": {
                    "data": [
                        {
                            "uuid": "a180e9a4-cb55-4398-8047-d3201e507b46",
                            "count": -2,
                            "returnable_packaging_type": {
                                "uuid": "a180e9a4-c9ef-40b8-b068-aee1832a25ea",
                                "type": "pallets"
                            }
                        }
                    ]
                },
                "status": {
                    "status_identifier": "delivered"
                },
                "signature": "YTE4MGU5YTQtYWJlZC00MDkxLWIxZTEtYTQ4M2I5YzM3ZTM3",
                "files": {
                    "data": [
                        {
                            "type": "image",
                            "key": "dlRsZmplQVZGdnNoU0FlVA"
                        }
                    ]
                }
            }
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 24,
        "to": 1,
        "total": 1,
        "next": null,
        "prev": null
    }
}
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "The given data was invalid.",
    "errors": {
        "field": [
            "The field must be a string"
        ]
    }
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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

Response Fields

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\": \"ektcvgnxfpapcnuhdwdkegy\",
    \"external_reference\": \"hmtksby\",
    \"custom_field_1\": \"xlsddwsmoyi\",
    \"custom_field_2\": \"vf\",
    \"custom_field_3\": \"hoq\",
    \"custom_field_4\": \"gmv\",
    \"note\": \"Please deliver at the side door.\",
    \"pending_payment_amount\": 100,
    \"external_link\": \"https:\\/\\/example.com\\/\",
    \"delivery_from_date\": \"2002-01-23\",
    \"start_time\": \"08:00\",
    \"end_time\": \"17:00\",
    \"delivery_duration_minutes\": 1,
    \"return_required\": false,
    \"return_task_uuid\": \"59dc65c7-0ea9-3842-b0ce-4bc44c0fd558\",
    \"signature_required\": false,
    \"used_capacity\": 5,
    \"used_capacity_2\": 4,
    \"used_capacity_3\": 24,
    \"notification_template_uuid\": \"c912bdd1-6492-387b-b0e5-f37b19c32631\",
    \"recurring\": {
        \"period\": \"month\",
        \"interval\": 18,
        \"settings\": \"[\\\"string\\\", \\\"third\\\", \\\"monday\\\"]\",
        \"end_date\": \"2062-02-13\"
    },
    \"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-04-09T18:01:20\",
    \"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
}"
Example response:
{
    "uuid": "a180e9a5-fb23-45d8-b040-f3ea992ea8cc",
    "type": "delivery",
    "external_identifier": "RL3FOcNvYApy",
    "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/ABJMexKMkDr5",
    "delivery_from_date": null,
    "delivery_date": "2026-04-09",
    "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-04-09T16:01:18.000000Z",
    "created_at": "2026-04-09T16:01:18.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
    },
    "shipment_steps": null,
    "visit_uuids": [],
    "next_visit": null
}
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "The given data was invalid.",
    "errors": {
        "field": [
            "The field must be a string"
        ]
    }
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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:
e308fa38-e020-3d1d-bb7e-08b55d4575b6

Response Fields

Example request: 
curl --request GET \
    --get "http://localhost/api/v2/tasks/e308fa38-e020-3d1d-bb7e-08b55d4575b6" \
    --header "Authorization: Bearer {YOUR_API_KEY}"
Example response:
{
    "uuid": "a180e9a4-886a-4f1c-b89d-5cf244b528c3",
    "type": "delivery",
    "external_identifier": "eEPWyE",
    "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/k4EqVr1tMUO5",
    "delivery_from_date": null,
    "delivery_date": "2026-04-09",
    "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-04-09T16:01:17.000000Z",
    "created_at": "2026-04-09T16:01:17.000000Z",
    "tags": [],
    "notification_template_uuid": null,
    "return_task_uuid": null,
    "address": {
        "street": "1576 Emerson Ridge Apt. 583",
        "house_number": "517",
        "house_number_extension": null,
        "postal_code": "28838",
        "city": "New Turner",
        "latitude": 5.4321,
        "longitude": 5.4321,
        "address_line": "1576 Emerson Ridge Apt. 583 517",
        "full_address_line": "1576 Emerson Ridge Apt. 583 517, 28838, New Turner",
        "country": {
            "iso_code": "NL",
            "description": "Nederland"
        }
    },
    "customer": {
        "name": "Fabian Skiles",
        "email": "[email protected]",
        "phone_number": null
    },
    "shipment_steps": null,
    "visit_uuids": [
        "a180e9a4-abed-4091-b1e1-a483b9c37e37"
    ],
    "next_visit": {
        "uuid": "a180e9a4-abed-4091-b1e1-a483b9c37e37",
        "type": "task",
        "order_index": 0,
        "delivery_time": "09:00:00",
        "delivered_at": "2026-04-09T07:05:00.000000Z",
        "schedule_date": "2026-04-08T22:00:00.000000Z",
        "address": {
            "street": "1576 Emerson Ridge Apt. 583",
            "house_number": "517",
            "house_number_extension": null,
            "postal_code": "28838",
            "city": "New Turner",
            "latitude": 5.4321,
            "longitude": 5.4321,
            "address_line": "1576 Emerson Ridge Apt. 583 517",
            "full_address_line": "1576 Emerson Ridge Apt. 583 517, 28838, New Turner",
            "country": {
                "iso_code": "NL",
                "description": "Nederland"
            }
        },
        "scanned_codes": {
            "data": [
                {
                    "type": "task_code",
                    "code_uuid": "a180e9a4-a4a4-4ad6-b31e-3729a7610302",
                    "scanned_count": 1
                },
                {
                    "type": "schedule_visit_code",
                    "code_uuid": "a180e9a4-c5cf-4625-aaca-0fcd398fae0c",
                    "scanned_count": 1
                }
            ]
        },
        "returnable_packaging": {
            "data": [
                {
                    "uuid": "a180e9a4-cb55-4398-8047-d3201e507b46",
                    "count": -2,
                    "returnable_packaging_type": {
                        "uuid": "a180e9a4-c9ef-40b8-b068-aee1832a25ea",
                        "type": "pallets"
                    }
                }
            ]
        },
        "status": {
            "status_identifier": "delivered"
        },
        "signature": "YTE4MGU5YTQtYWJlZC00MDkxLWIxZTEtYTQ4M2I5YzM3ZTM3",
        "files": {
            "data": [
                {
                    "type": "image",
                    "key": "dlRsZmplQVZGdnNoU0FlVA"
                }
            ]
        }
    }
}
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "The given data was invalid.",
    "errors": {
        "field": [
            "The field must be a string"
        ]
    }
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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:
58827c08-3623-32de-bc35-33a6da9324fe

Body Parameters

Response Fields

Example request: 
curl --request PUT \
    "http://localhost/api/v2/tasks/58827c08-3623-32de-bc35-33a6da9324fe" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"type\": \"delivery\",
    \"external_identifier\": \"aveuhblnafzqkn\",
    \"external_reference\": \"mfbphlimjjaltsqowrwjpoqid\",
    \"custom_field_1\": \"dsertwyphpfxuwdthmppoosel\",
    \"custom_field_2\": \"iih\",
    \"custom_field_3\": \"tawevluqwybvaohmtfx\",
    \"custom_field_4\": \"pvpglqibtnacris\",
    \"note\": \"Please deliver at the side door.\",
    \"pending_payment_amount\": 100,
    \"external_link\": \"https:\\/\\/example.com\\/\",
    \"delivery_from_date\": \"1999-02-21\",
    \"start_time\": \"08:00\",
    \"end_time\": \"17:00\",
    \"delivery_duration_minutes\": 20,
    \"return_required\": false,
    \"return_task_uuid\": \"2ff404d2-cbac-3d4b-85a9-35c5cbbd3b56\",
    \"signature_required\": true,
    \"used_capacity\": 1,
    \"used_capacity_2\": 2,
    \"used_capacity_3\": 13,
    \"notification_template_uuid\": \"06e60475-0bb0-381e-97e1-a12e62b1f644\",
    \"recurring\": {
        \"period\": \"week\",
        \"interval\": 20,
        \"settings\": \"[\\\"string\\\", \\\"third\\\", \\\"monday\\\"]\",
        \"end_date\": \"2037-10-29\"
    },
    \"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-04-09T18:01:20\",
    \"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
}"
Example response:
{
    "uuid": "a180e9a4-886a-4f1c-b89d-5cf244b528c3",
    "type": "delivery",
    "external_identifier": "RLA0bIXdxEkd",
    "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/k4EqVr1tMUO5",
    "delivery_from_date": null,
    "delivery_date": "2026-04-09",
    "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-04-09T16:01:18.000000Z",
    "created_at": "2026-04-09T16:01:17.000000Z",
    "tags": [],
    "notification_template_uuid": null,
    "return_task_uuid": null,
    "address": {
        "street": "1576 Emerson Ridge Apt. 583",
        "house_number": "517",
        "house_number_extension": null,
        "postal_code": "28838",
        "city": "New Turner",
        "latitude": 5.4321,
        "longitude": 5.4321,
        "address_line": "1576 Emerson Ridge Apt. 583 517",
        "full_address_line": "1576 Emerson Ridge Apt. 583 517, 28838, New Turner",
        "country": {
            "iso_code": "NL",
            "description": "Nederland"
        }
    },
    "customer": {
        "name": "Fabian Skiles",
        "email": "[email protected]",
        "phone_number": null
    },
    "shipment_steps": null,
    "visit_uuids": [
        "a180e9a4-abed-4091-b1e1-a483b9c37e37"
    ],
    "next_visit": {
        "uuid": "a180e9a4-abed-4091-b1e1-a483b9c37e37",
        "type": "task",
        "order_index": 0,
        "delivery_time": "09:00:00",
        "delivered_at": "2026-04-09T07:05:00.000000Z",
        "schedule_date": "2026-04-08T22:00:00.000000Z",
        "address": {
            "street": "1576 Emerson Ridge Apt. 583",
            "house_number": "517",
            "house_number_extension": null,
            "postal_code": "28838",
            "city": "New Turner",
            "latitude": 5.4321,
            "longitude": 5.4321,
            "address_line": "1576 Emerson Ridge Apt. 583 517",
            "full_address_line": "1576 Emerson Ridge Apt. 583 517, 28838, New Turner",
            "country": {
                "iso_code": "NL",
                "description": "Nederland"
            }
        },
        "scanned_codes": {
            "data": [
                {
                    "type": "task_code",
                    "code_uuid": "a180e9a4-a4a4-4ad6-b31e-3729a7610302",
                    "scanned_count": 1
                },
                {
                    "type": "schedule_visit_code",
                    "code_uuid": "a180e9a4-c5cf-4625-aaca-0fcd398fae0c",
                    "scanned_count": 1
                }
            ]
        },
        "returnable_packaging": {
            "data": [
                {
                    "uuid": "a180e9a4-cb55-4398-8047-d3201e507b46",
                    "count": -2,
                    "returnable_packaging_type": {
                        "uuid": "a180e9a4-c9ef-40b8-b068-aee1832a25ea",
                        "type": "pallets"
                    }
                }
            ]
        },
        "status": {
            "status_identifier": "delivered"
        },
        "signature": "YTE4MGU5YTQtYWJlZC00MDkxLWIxZTEtYTQ4M2I5YzM3ZTM3",
        "files": {
            "data": [
                {
                    "type": "image",
                    "key": "dlRsZmplQVZGdnNoU0FlVA"
                }
            ]
        }
    }
}
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "The given data was invalid.",
    "errors": {
        "field": [
            "The field must be a string"
        ]
    }
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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:
b3417405-7567-3889-a156-48e3312e5e16

Query Parameters

forceRemoveFromSchedules
boolean

Optionally force remove task from all schedules.

Example request: 
curl --request DELETE \
    "http://localhost/api/v2/tasks/b3417405-7567-3889-a156-48e3312e5e16?forceRemoveFromSchedules=" \
    --header "Authorization: Bearer {YOUR_API_KEY}"
Example response:
[Empty response]
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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:
5b4ee8d6-3c6a-385e-bdad-c2b8da26605a

Response Fields

Example request: 
curl --request GET \
    --get "http://localhost/api/v2/visits/5b4ee8d6-3c6a-385e-bdad-c2b8da26605a" \
    --header "Authorization: Bearer {YOUR_API_KEY}"
Example response:
{
    "data": {
        "uuid": "a180e9a4-abed-4091-b1e1-a483b9c37e37",
        "type": "task",
        "order_index": 0,
        "delivery_time": "09:00:00",
        "delivered_at": "2026-04-09T07:05:00.000000Z",
        "task_uuid": "a180e9a4-886a-4f1c-b89d-5cf244b528c3",
        "schedule_date": "2026-04-08T22:00:00.000000Z",
        "address": {
            "street": "1576 Emerson Ridge Apt. 583",
            "house_number": "517",
            "house_number_extension": null,
            "postal_code": "28838",
            "city": "New Turner",
            "latitude": 5.4321,
            "longitude": 5.4321,
            "address_line": "1576 Emerson Ridge Apt. 583 517",
            "full_address_line": "1576 Emerson Ridge Apt. 583 517, 28838, New Turner",
            "country": {
                "iso_code": "NL",
                "description": "Nederland"
            }
        },
        "scanned_codes": {
            "data": [
                {
                    "type": "task_code",
                    "code_uuid": "a180e9a4-a4a4-4ad6-b31e-3729a7610302",
                    "scanned_count": 1
                },
                {
                    "type": "schedule_visit_code",
                    "code_uuid": "a180e9a4-c5cf-4625-aaca-0fcd398fae0c",
                    "scanned_count": 1
                }
            ]
        },
        "returnable_packaging": {
            "data": [
                {
                    "uuid": "a180e9a4-cb55-4398-8047-d3201e507b46",
                    "count": -2
                }
            ]
        },
        "status": {
            "status_identifier": "delivered"
        },
        "signature": "YTE4MGU5YTQtYWJlZC00MDkxLWIxZTEtYTQ4M2I5YzM3ZTM3",
        "files": {
            "data": [
                {
                    "type": "image",
                    "key": "dlRsZmplQVZGdnNoU0FlVA"
                }
            ]
        }
    }
}
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "The given data was invalid.",
    "errors": {
        "field": [
            "The field must be a string"
        ]
    }
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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:
3a127510-23bf-3574-9616-4691b47a3a83
Example request: 
curl --request GET \
    --get "http://localhost/api/v2/visits/3a127510-23bf-3574-9616-4691b47a3a83/pod" \
    --header "Authorization: Bearer {YOUR_API_KEY}"
Example response:
[Binary data] -  The PDF file
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "This action is unauthorized."
}
{
    "message": "POD file not found."
}
{
    "message": "Resource not found"
}
{
    "message": "Visit not yet delivered."
}
{
    "message": "POD is not available for pickup tasks."
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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:
31e18991-3be5-309e-90c4-0c60995678c5

Response Fields

Example request: 
curl --request GET \
    --get "http://localhost/api/v2/tasks/31e18991-3be5-309e-90c4-0c60995678c5/products" \
    --header "Authorization: Bearer {YOUR_API_KEY}"
Example response:
{
    "data": [
        {
            "uuid": "a180e9a4-a2b5-49df-9ac2-4790ba68fba4",
            "quantity": "1.00",
            "description": "Test line",
            "unit": "pieces",
            "identifier": "2f7e673aae64ffbe3821016e253b45ed"
        }
    ]
}
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "The given data was invalid.",
    "errors": {
        "field": [
            "The field must be a string"
        ]
    }
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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:
e4eb985a-5c66-343d-989c-2579cb046f99

Body Parameters

Response Fields

Example request: 
curl --request POST \
    "http://localhost/api/v2/tasks/e4eb985a-5c66-343d-989c-2579cb046f99/products" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"data\": [
        {
            \"identifier\": \"xvq\",
            \"quantity\": 6,
            \"unit\": \"placeat\",
            \"description\": \"Table\"
        }
    ]
}"
Example response:
{
    "data": [
        {
            "uuid": "a180e9a6-cf04-42c8-aba4-a19e63650254",
            "quantity": 1,
            "description": "Test line",
            "unit": "pieces",
            "identifier": "2f7e673aae64ffbe3821016e253b45ed"
        },
        {
            "uuid": "a180e9a6-cfe8-458e-a540-0dda09d13526",
            "quantity": 5,
            "description": "Test line 2",
            "unit": "weight",
            "identifier": "838c87eb890a63944ecc8e83ffb0e4bb"
        }
    ]
}
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "The given data was invalid.",
    "errors": {
        "field": [
            "The field must be a string"
        ]
    }
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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:
347fc22c-c288-3efe-99b8-94a02d0daa43
product_uuid
string

uuid of the corresponding product

Example:
3e6e6ac4-0140-3e64-aace-0ae96a7797f7

Response Fields

Example request: 
curl --request GET \
    --get "http://localhost/api/v2/tasks/347fc22c-c288-3efe-99b8-94a02d0daa43/products/3e6e6ac4-0140-3e64-aace-0ae96a7797f7" \
    --header "Authorization: Bearer {YOUR_API_KEY}"
Example response:
{
    "data": {
        "uuid": "a180e9a4-a2b5-49df-9ac2-4790ba68fba4",
        "quantity": "1.00",
        "description": "Test line",
        "unit": "pieces",
        "identifier": "2f7e673aae64ffbe3821016e253b45ed"
    }
}
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "The given data was invalid.",
    "errors": {
        "field": [
            "The field must be a string"
        ]
    }
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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:
8b2fcefc-a25f-3ac7-a50a-b6688d0d2083
product_uuid
string

uuid of the corresponding product

Example:
91df45f3-74e2-3046-a347-c996a70fac32

Body Parameters

Response Fields

Example request: 
curl --request PUT \
    "http://localhost/api/v2/tasks/8b2fcefc-a25f-3ac7-a50a-b6688d0d2083/products/91df45f3-74e2-3046-a347-c996a70fac32" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"identifier\": \"rhax\",
    \"quantity\": 22,
    \"unit\": \"molestias\",
    \"description\": \"Table\"
}"
Example response:
{
    "data": {
        "uuid": "a180e9a4-a2b5-49df-9ac2-4790ba68fba4",
        "quantity": "1.00",
        "description": "Test line",
        "unit": "pieces",
        "identifier": "2f7e673aae64ffbe3821016e253b45ed"
    }
}
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "The given data was invalid.",
    "errors": {
        "field": [
            "The field must be a string"
        ]
    }
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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:
6ec375e1-061c-3571-9430-a0c836f0c5ae
product_uuid
string

uuid of the corresponding product

Example:
016f4923-3b3e-350b-bff9-f81c3667ba60
Example request: 
curl --request DELETE \
    "http://localhost/api/v2/tasks/6ec375e1-061c-3571-9430-a0c836f0c5ae/products/016f4923-3b3e-350b-bff9-f81c3667ba60" \
    --header "Authorization: Bearer {YOUR_API_KEY}"
Example response:
[Empty response]
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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:
d44dbbf6-5dcd-3162-954e-ef8de2ca09c8
Example request: 
curl --request DELETE \
    "http://localhost/api/v2/tasks/d44dbbf6-5dcd-3162-954e-ef8de2ca09c8/products" \
    --header "Authorization: Bearer {YOUR_API_KEY}"
Example response:
[Empty response]
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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:
52a15d78-5925-3d23-9617-94d5e02e5795

Response Fields

Example request: 
curl --request GET \
    --get "http://localhost/api/v2/tasks/52a15d78-5925-3d23-9617-94d5e02e5795/codes" \
    --header "Authorization: Bearer {YOUR_API_KEY}"
Example response:
{
    "data": [
        {
            "uuid": "a180e9a4-a4a4-4ad6-b31e-3729a7610302",
            "amount": 1,
            "code": "YHRw0OoWcejY1Qpz",
            "description": "chair"
        }
    ]
}
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "The given data was invalid.",
    "errors": {
        "field": [
            "The field must be a string"
        ]
    }
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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:
da1cec78-122b-3d79-9b54-dc6262f6dea5

Body Parameters

Response Fields

Example request: 
curl --request POST \
    "http://localhost/api/v2/tasks/da1cec78-122b-3d79-9b54-dc6262f6dea5/codes" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"data\": [
        {
            \"amount\": 2,
            \"code\": \"aqqnjwbghla\",
            \"description\": \"Table\"
        }
    ]
}"
Example response:
{
    "data": [
        {
            "uuid": "a180e9a7-0516-4f9c-86e0-f1e50f0f9d13",
            "amount": 1,
            "code": "1234567890",
            "description": "Box"
        },
        {
            "uuid": "a180e9a7-060b-44ce-9864-db6948d19ccc",
            "amount": 2,
            "code": "ABCDEFGHIJ",
            "description": "Table"
        }
    ]
}
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "The given data was invalid.",
    "errors": {
        "field": [
            "The field must be a string"
        ]
    }
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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:
f8329721-723c-3615-b576-12d8aa814c8f
taskCode_uuid
string

uuid of the corresponding task code

Example:
b08319a2-1feb-3845-a1e6-255d46aac25c

Response Fields

Example request: 
curl --request GET \
    --get "http://localhost/api/v2/tasks/f8329721-723c-3615-b576-12d8aa814c8f/codes/b08319a2-1feb-3845-a1e6-255d46aac25c" \
    --header "Authorization: Bearer {YOUR_API_KEY}"
Example response:
{
    "data": {
        "uuid": "a180e9a4-a4a4-4ad6-b31e-3729a7610302",
        "amount": 1,
        "code": "YHRw0OoWcejY1Qpz",
        "description": "chair"
    }
}
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "The given data was invalid.",
    "errors": {
        "field": [
            "The field must be a string"
        ]
    }
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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:
f8c9d5bc-1fd7-37e5-bd0e-0c8a79d626fd
taskCode_uuid
string

uuid of the corresponding task code

Example:
86c25b83-cb41-3b86-af6a-49e2f6f9c514

Body Parameters

Response Fields

Example request: 
curl --request PUT \
    "http://localhost/api/v2/tasks/f8c9d5bc-1fd7-37e5-bd0e-0c8a79d626fd/codes/86c25b83-cb41-3b86-af6a-49e2f6f9c514" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"amount\": 18,
    \"code\": \"mxlg\",
    \"description\": \"Table\"
}"
Example response:
{
    "data": {
        "uuid": "a180e9a4-a4a4-4ad6-b31e-3729a7610302",
        "amount": 1,
        "code": "YHRw0OoWcejY1Qpz",
        "description": "chair"
    }
}
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "The given data was invalid.",
    "errors": {
        "field": [
            "The field must be a string"
        ]
    }
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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:
f9a9b0b1-e493-365f-9b91-dfd029201be3
taskCode_uuid
string

uuid of the corresponding task code

Example:
a8318595-3c3a-362d-a3bc-f38ae7686c18
Example request: 
curl --request DELETE \
    "http://localhost/api/v2/tasks/f9a9b0b1-e493-365f-9b91-dfd029201be3/codes/a8318595-3c3a-362d-a3bc-f38ae7686c18" \
    --header "Authorization: Bearer {YOUR_API_KEY}"
Example response:
[Empty response]
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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:
56d7849e-edbb-3827-b8a7-0e3672f96202

Response Fields

Example request: 
curl --request GET \
    --get "http://localhost/api/v2/visits/56d7849e-edbb-3827-b8a7-0e3672f96202/codes" \
    --header "Authorization: Bearer {YOUR_API_KEY}"
Example response:
{
    "data": [
        {
            "uuid": "a180e9a4-c5cf-4625-aaca-0fcd398fae0c",
            "amount": 1,
            "code": "QnswQqi4iiO7QqDn",
            "description": "box"
        }
    ]
}
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "The given data was invalid.",
    "errors": {
        "field": [
            "The field must be a string"
        ]
    }
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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:
8923b60b-4af9-39fc-a69e-7f379d351e70

Body Parameters

Response Fields

Example request: 
curl --request POST \
    "http://localhost/api/v2/visits/8923b60b-4af9-39fc-a69e-7f379d351e70/codes" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"data\": [
        {
            \"amount\": 20,
            \"code\": \"op\",
            \"description\": \"Table\"
        }
    ]
}"
Example response:
{
    "data": [
        {
            "uuid": "a180e9a8-0d60-4704-b462-be7e4884365d",
            "amount": 1,
            "code": "1234567890",
            "description": "Box"
        },
        {
            "uuid": "a180e9a8-0e56-40b3-8d09-fbcefcc56434",
            "amount": 2,
            "code": "ABCDEFGHIJ",
            "description": "Table"
        }
    ]
}
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "The given data was invalid.",
    "errors": {
        "field": [
            "The field must be a string"
        ]
    }
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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:
b6131d21-961c-3c7c-b006-078bb55353a6
scheduleVisitCode_uuid
string

uuid of the corresponding scheduled visit code

Example:
0e98ba09-8cac-3e09-85b7-2d72941a60c1

Response Fields

Example request: 
curl --request GET \
    --get "http://localhost/api/v2/visits/b6131d21-961c-3c7c-b006-078bb55353a6/codes/0e98ba09-8cac-3e09-85b7-2d72941a60c1" \
    --header "Authorization: Bearer {YOUR_API_KEY}"
Example response:
{
    "data": {
        "uuid": "a180e9a4-c5cf-4625-aaca-0fcd398fae0c",
        "amount": 1,
        "code": "QnswQqi4iiO7QqDn",
        "description": "box"
    }
}
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "The given data was invalid.",
    "errors": {
        "field": [
            "The field must be a string"
        ]
    }
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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:
edf3399c-4fea-3416-ae6c-0fd74dd7f3ad
scheduleVisitCode_uuid
string

uuid of the corresponding scheduled visit code

Example:
21710375-8a37-3dfc-b83c-4d78369f6d4b

Body Parameters

Response Fields

Example request: 
curl --request PUT \
    "http://localhost/api/v2/visits/edf3399c-4fea-3416-ae6c-0fd74dd7f3ad/codes/21710375-8a37-3dfc-b83c-4d78369f6d4b" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"amount\": 13,
    \"code\": \"mcdujdyaxzdbgkfoxrlv\",
    \"description\": \"Table\"
}"
Example response:
{
    "data": {
        "uuid": "a180e9a4-c5cf-4625-aaca-0fcd398fae0c",
        "amount": 1,
        "code": "QnswQqi4iiO7QqDn",
        "description": "box"
    }
}
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "The given data was invalid.",
    "errors": {
        "field": [
            "The field must be a string"
        ]
    }
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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:
83cb2b06-0a65-3279-85ea-c61815f627fb
scheduleVisitCode_uuid
string

uuid of the corresponding scheduled visit code

Example:
1eb71591-3749-3c2d-8f79-ff5b699f92f6
Example request: 
curl --request DELETE \
    "http://localhost/api/v2/visits/83cb2b06-0a65-3279-85ea-c61815f627fb/codes/1eb71591-3749-3c2d-8f79-ff5b699f92f6" \
    --header "Authorization: Bearer {YOUR_API_KEY}"
Example response:
[Empty response]
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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:
535a1057-81d2-398f-827a-4826732d5d26

Response Fields

Example request: 
curl --request GET \
    --get "http://localhost/api/v2/tasks/535a1057-81d2-398f-827a-4826732d5d26/returnablePackaging" \
    --header "Authorization: Bearer {YOUR_API_KEY}"
Example response:
{
    "data": [
        {
            "uuid": "a180e9a4-a775-40e4-bd9d-82a3a48d609d",
            "count": 1,
            "returnable_packaging_type": {
                "uuid": "a180e9a4-a62e-4495-89e3-eb4b071eeda9",
                "type": "box"
            }
        }
    ]
}
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "The given data was invalid.",
    "errors": {
        "field": [
            "The field must be a string"
        ]
    }
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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:
29159cc7-509c-3c9f-8242-7ff8f3a032d5

Body Parameters

Response Fields

Example request: 
curl --request POST \
    "http://localhost/api/v2/tasks/29159cc7-509c-3c9f-8242-7ff8f3a032d5/returnablePackaging" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"data\": [
        {
            \"count\": 3,
            \"returnable_packaging_type_uuid\": \"1b6d4324-8bba-323c-9946-e3e90ea7b113\"
        }
    ]
}"
Example response:
{
    "data": [
        {
            "uuid": "a180e9a7-3bc4-4e2b-a563-2112d89a8825",
            "count": 1,
            "returnable_packaging_type": {
                "uuid": "a180e9a4-a62e-4495-89e3-eb4b071eeda9",
                "type": "box"
            }
        },
        {
            "uuid": "a180e9a7-3d51-49e7-a2e3-5cb17b347c02",
            "count": -2,
            "returnable_packaging_type": {
                "uuid": "a180e9a4-a62e-4495-89e3-eb4b071eeda9",
                "type": "box"
            }
        }
    ]
}
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "The given data was invalid.",
    "errors": {
        "field": [
            "The field must be a string"
        ]
    }
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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:
441f8b68-590f-3652-a378-3b0815364afa
taskReturnablePackaging_uuid
string

uuid of the corresponding task returnable packaging

Example:
7c1d696a-44c0-3e89-b699-8c5d000d632c

Response Fields

Example request: 
curl --request GET \
    --get "http://localhost/api/v2/tasks/441f8b68-590f-3652-a378-3b0815364afa/returnablePackaging/7c1d696a-44c0-3e89-b699-8c5d000d632c" \
    --header "Authorization: Bearer {YOUR_API_KEY}"
Example response:
{
    "data": {
        "uuid": "a180e9a4-a775-40e4-bd9d-82a3a48d609d",
        "count": 1,
        "returnable_packaging_type": {
            "uuid": "a180e9a4-a62e-4495-89e3-eb4b071eeda9",
            "type": "box"
        }
    }
}
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "The given data was invalid.",
    "errors": {
        "field": [
            "The field must be a string"
        ]
    }
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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:
3d43c3ad-99da-336b-958f-5b94a61d7608
taskReturnablePackaging_uuid
string

uuid of the corresponding task returnable packaging

Example:
525ef5f4-4962-346f-9d15-fa8d08ef9858

Body Parameters

Response Fields

Example request: 
curl --request PUT \
    "http://localhost/api/v2/tasks/3d43c3ad-99da-336b-958f-5b94a61d7608/returnablePackaging/525ef5f4-4962-346f-9d15-fa8d08ef9858" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"count\": 24
}"
Example response:
{
    "data": {
        "uuid": "a180e9a4-a775-40e4-bd9d-82a3a48d609d",
        "count": 1,
        "returnable_packaging_type": {
            "uuid": "a180e9a4-a62e-4495-89e3-eb4b071eeda9",
            "type": "box"
        }
    }
}
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "The given data was invalid.",
    "errors": {
        "field": [
            "The field must be a string"
        ]
    }
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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:
843b656e-745a-34c6-b468-e14258becde6
taskReturnablePackaging_uuid
string

uuid of the corresponding task returnable packaging

Example:
1af151c7-fcc9-37bf-9d64-360a73a39e4b
Example request: 
curl --request DELETE \
    "http://localhost/api/v2/tasks/843b656e-745a-34c6-b468-e14258becde6/returnablePackaging/1af151c7-fcc9-37bf-9d64-360a73a39e4b" \
    --header "Authorization: Bearer {YOUR_API_KEY}"
Example response:
[Empty response]
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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:
60
filters.page
integer

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

Example:
24

Response Fields

Example request: 
curl --request GET \
    --get "http://localhost/api/v2/webhookGroups?filters[limit]=60&filters[page]=24" \
    --header "Authorization: Bearer {YOUR_API_KEY}"
Example response:
{
    "data": [
        {
            "uuid": "a180e9a4-bc06-493d-87d7-1bcfa6608ce9",
            "name": "Webhook group 1",
            "description": "Task webhook group 1",
            "webhook_url": "https://test.com/webhook/",
            "events": []
        },
        {
            "uuid": "a180e9a4-f27d-405e-9878-1eb17add2064",
            "name": "Webhook group 2",
            "description": "task webhook group 2",
            "webhook_url": "https://test.com/webhook/",
            "events": [
                "task_created"
            ]
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 24,
        "to": 2,
        "total": 2,
        "next": null,
        "prev": null
    }
}
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "The given data was invalid.",
    "errors": {
        "field": [
            "The field must be a string"
        ]
    }
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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

Response Fields

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\": [
        \"sending_notifications\"
    ]
}"
Example response:
{
    "data": {
        "uuid": "a180e9a7-8120-43de-97ba-0e1fddf8c1b4",
        "name": "Demo webhook group",
        "description": "send to my api",
        "webhook_url": "https://routelogic.io",
        "events": [
            "task_created",
            "task_updated"
        ]
    }
}
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "The given data was invalid.",
    "errors": {
        "field": [
            "The field must be a string"
        ]
    }
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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:
57cec99a-18b3-39ca-a605-cc343975e92f

Response Fields

Example request: 
curl --request GET \
    --get "http://localhost/api/v2/webhookGroups/57cec99a-18b3-39ca-a605-cc343975e92f" \
    --header "Authorization: Bearer {YOUR_API_KEY}"
Example response:
{
    "data": {
        "uuid": "a180e9a4-f27d-405e-9878-1eb17add2064",
        "name": "Webhook group 2",
        "description": "task webhook group 2",
        "webhook_url": "https://test.com/webhook/",
        "events": [
            "task_created"
        ]
    }
}
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "The given data was invalid.",
    "errors": {
        "field": [
            "The field must be a string"
        ]
    }
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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:
23ed154c-819d-3abe-a645-99f2da74eadf

Body Parameters

Response Fields

Example request: 
curl --request PUT \
    "http://localhost/api/v2/webhookGroups/23ed154c-819d-3abe-a645-99f2da74eadf" \
    --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\": [
        \"visit_status_updated\"
    ]
}"
Example response:
{
    "data": {
        "uuid": "a180e9a4-f27d-405e-9878-1eb17add2064",
        "name": "Webhook group 2",
        "description": "task webhook group 2",
        "webhook_url": "https://test.com/webhook/",
        "events": [
            "task_created"
        ]
    }
}
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "The given data was invalid.",
    "errors": {
        "field": [
            "The field must be a string"
        ]
    }
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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:
d087edd2-d021-34cb-ab6d-8e34ba418494
Example request: 
curl --request DELETE \
    "http://localhost/api/v2/webhookGroups/d087edd2-d021-34cb-ab6d-8e34ba418494" \
    --header "Authorization: Bearer {YOUR_API_KEY}"
Example response:
[Empty response]
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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:
1
filters.page
integer

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

Example:
51

Response Fields

Example request: 
curl --request GET \
    --get "http://localhost/api/v2/webhookEvents?filters[status_failed]=&filters[limit]=1&filters[page]=51" \
    --header "Authorization: Bearer {YOUR_API_KEY}"
Example response:
{
    "data": [
        {
            "uuid": "9d9f9acb-eaf9-46a2-9c88-a3f6fd90fd35",
            "webhook_url": "https://test.com/webhook/",
            "event_data": {
                "data": {
                    "note": null,
                    "tags": [],
                    "type": "delivery",
                    "uuid": "a180e9a4-886a-4f1c-b89d-5cf244b528c3",
                    "end_time": "17:00:00",
                    "recurring": null,
                    "created_at": "2026-04-09T16:01:17.000000Z",
                    "start_time": "08:00:00",
                    "updated_at": "2026-04-09T16:01:17.000000Z",
                    "delivery_date": "2026-04-09",
                    "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,
                    "delivery_from_date": null,
                    "external_reference": null,
                    "signature_required": null,
                    "external_identifier": "eEPWyE",
                    "track_and_trace_link": "http://localhost/tr/k4EqVr1tMUO5",
                    "pending_payment_amount": 0,
                    "delivery_duration_minutes": 0,
                    "notification_template_uuid": null
                },
                "type": "task_created",
                "timestamp": "2026-04-09T18:01:17+02:00"
            },
            "response_status": 200,
            "created_at": "2026-04-09T16:01:17.000000Z",
            "updated_at": "2026-04-09T16:01:17.000000Z"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 24,
        "to": 1,
        "total": 1,
        "next": null,
        "prev": null
    }
}
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "The given data was invalid.",
    "errors": {
        "field": [
            "The field must be a string"
        ]
    }
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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:
5a8ec4b7-d10b-3c92-bd02-c4ee35020a78

Response Fields

Example request: 
curl --request GET \
    --get "http://localhost/api/v2/webhookEvents/5a8ec4b7-d10b-3c92-bd02-c4ee35020a78" \
    --header "Authorization: Bearer {YOUR_API_KEY}"
Example response:
{
    "data": {
        "uuid": "9d9f9acb-eaf9-46a2-9c88-a3f6fd90fd35",
        "webhook_url": "https://test.com/webhook/",
        "event_data": {
            "data": {
                "note": null,
                "tags": [],
                "type": "delivery",
                "uuid": "a180e9a4-886a-4f1c-b89d-5cf244b528c3",
                "end_time": "17:00:00",
                "recurring": null,
                "created_at": "2026-04-09T16:01:17.000000Z",
                "start_time": "08:00:00",
                "updated_at": "2026-04-09T16:01:17.000000Z",
                "delivery_date": "2026-04-09",
                "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,
                "delivery_from_date": null,
                "external_reference": null,
                "signature_required": null,
                "external_identifier": "eEPWyE",
                "track_and_trace_link": "http://localhost/tr/k4EqVr1tMUO5",
                "pending_payment_amount": 0,
                "delivery_duration_minutes": 0,
                "notification_template_uuid": null
            },
            "type": "task_created",
            "timestamp": "2026-04-09T18:01:17+02:00"
        },
        "response_status": 200,
        "created_at": "2026-04-09T16:01:17.000000Z",
        "updated_at": "2026-04-09T16:01:17.000000Z"
    }
}
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "The given data was invalid.",
    "errors": {
        "field": [
            "The field must be a string"
        ]
    }
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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:
2e8bfc4d-c870-3f3c-ac4e-50ecd63579f9
Example request: 
curl --request POST \
    "http://localhost/api/v2/webhookEvents/2e8bfc4d-c870-3f3c-ac4e-50ecd63579f9/resend" \
    --header "Authorization: Bearer {YOUR_API_KEY}"
Example response:
[Empty response]
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "The given data was invalid.",
    "errors": {
        "field": [
            "The field must be a string"
        ]
    }
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

POST Resend All Failed Webhooks

POST
http://localhost
/api/v2/webhookEvents/resend-all-failed
requires authentication

Headers

Authorization
Example:
Bearer {YOUR_API_KEY}
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
    }
}
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "The given data was invalid.",
    "errors": {
        "field": [
            "The field must be a string"
        ]
    }
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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

Example request: 
curl --request GET \
    --get "http://localhost/api/v2/templates" \
    --header "Authorization: Bearer {YOUR_API_KEY}"
Example response:
{
    "data": [
        {
            "uuid": "a180e9a4-5796-41a4-af86-f04b16b40537",
            "identifier": "YExEbdYFPEKPFLkK",
            "title": "Standaard e-mail en SMS notificatie voor bezorgen",
            "default": true,
            "default_pickup": false
        },
        {
            "uuid": "a180e9a4-5bf7-4e52-8240-8bf0cfe903b0",
            "identifier": "ecOjqENo8B34Odt8",
            "title": "Standaard e-mail en SMS notificatie voor ophalen",
            "default": false,
            "default_pickup": true
        }
    ]
}
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "The given data was invalid.",
    "errors": {
        "field": [
            "The field must be a string"
        ]
    }
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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

Example request: 
curl --request GET \
    --get "http://localhost/api/v2/returnablePackagingTypes" \
    --header "Authorization: Bearer {YOUR_API_KEY}"
Example response:
{
    "data": [
        {
            "uuid": "a180e9a4-727d-4521-8429-9b8d0f237f93",
            "type": "Pallet"
        },
        {
            "uuid": "a180e9a4-73a9-41bd-a866-56fa8edb464d",
            "type": "Container"
        },
        {
            "uuid": "a180e9a4-7496-497b-b526-9c3a90792acb",
            "type": "Crate"
        },
        {
            "uuid": "a180e9a4-a62e-4495-89e3-eb4b071eeda9",
            "type": "box"
        },
        {
            "uuid": "a180e9a4-c9ef-40b8-b068-aee1832a25ea",
            "type": "pallets"
        }
    ]
}
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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-04-09
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-04-09
filters.limit
integer

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

Example:
21
filters.page
integer

Must be at least 1.

Example:
29

Response Fields

Example request: 
curl --request GET \
    --get "http://localhost/api/v2/schedules?filters[from_date]=2026-04-09&filters[to_date]=2026-04-09&filters[limit]=21&filters[page]=29" \
    --header "Authorization: Bearer {YOUR_API_KEY}"
Example response:
{
    "data": [
        {
            "uuid": "59d8a9e7-7cc1-457f-8e54-5d5fe3b1186c",
            "date": "2026-04-09",
            "description": "Example Schedule 1",
            "total_travel_time": 0,
            "total_distance": 0,
            "notifications_send": false,
            "schedule_vehicles": {
                "data": [
                    {
                        "uuid": "a180e9a4-aa5b-4ac5-a8f6-d5ca42884c1b",
                        "start_time": "08:00:00",
                        "end_time": "10:00:00",
                        "started_at": "2026-04-09 08:03:00",
                        "finished_at": "2026-04-09 10:02:00",
                        "total_travel_time": 0,
                        "total_distance": 1850,
                        "vehicle": {
                            "uuid": "a180e9a4-7af3-4a1c-a5ed-0772a5df2fdc",
                            "licence_plate": "RWEy7hkLg",
                            "description": "Van 1"
                        },
                        "user": {
                            "uuid": "a180e9a4-82d6-45fb-bc4d-be39148820d6",
                            "name": "Carrie Lindgren",
                            "public_name": "Carrie Lindgren"
                        },
                        "visits": {
                            "data": [
                                {
                                    "uuid": "a180e9a4-abed-4091-b1e1-a483b9c37e37",
                                    "type": "task",
                                    "order_index": 0,
                                    "delivery_time": "09:00:00",
                                    "eta_start": "08:25",
                                    "eta_end": "09:25",
                                    "delivered_at": "2026-04-09T07:05:00.000000Z",
                                    "task": {
                                        "uuid": "a180e9a4-886a-4f1c-b89d-5cf244b528c3",
                                        "type": "delivery",
                                        "external_identifier": "RLA0bIXdxEkd",
                                        "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/k4EqVr1tMUO5",
                                        "delivery_from_date": null,
                                        "delivery_date": "2026-04-09",
                                        "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-04-09T16:01:18.000000Z",
                                        "created_at": "2026-04-09T16:01:17.000000Z",
                                        "tags": [],
                                        "notification_template_uuid": null,
                                        "return_task_uuid": null,
                                        "address": {
                                            "street": "1576 Emerson Ridge Apt. 583",
                                            "house_number": "517",
                                            "house_number_extension": null,
                                            "postal_code": "28838",
                                            "city": "New Turner",
                                            "latitude": 5.4321,
                                            "longitude": 5.4321,
                                            "address_line": "1576 Emerson Ridge Apt. 583 517",
                                            "full_address_line": "1576 Emerson Ridge Apt. 583 517, 28838, New Turner",
                                            "country": {
                                                "iso_code": "NL",
                                                "description": "Nederland"
                                            }
                                        },
                                        "customer": {
                                            "name": "Fabian Skiles",
                                            "email": "[email protected]",
                                            "phone_number": null
                                        },
                                        "shipment_steps": null
                                    },
                                    "schedule_date": "2026-04-08T22:00:00.000000Z",
                                    "address": {
                                        "street": "1576 Emerson Ridge Apt. 583",
                                        "house_number": "517",
                                        "house_number_extension": null,
                                        "postal_code": "28838",
                                        "city": "New Turner",
                                        "latitude": 5.4321,
                                        "longitude": 5.4321,
                                        "address_line": "1576 Emerson Ridge Apt. 583 517",
                                        "full_address_line": "1576 Emerson Ridge Apt. 583 517, 28838, New Turner",
                                        "country": {
                                            "iso_code": "NL",
                                            "description": "Nederland"
                                        }
                                    },
                                    "scanned_codes": {
                                        "data": [
                                            {
                                                "type": "task_code",
                                                "code_uuid": "a180e9a4-a4a4-4ad6-b31e-3729a7610302",
                                                "scanned_count": 1
                                            },
                                            {
                                                "type": "schedule_visit_code",
                                                "code_uuid": "a180e9a4-c5cf-4625-aaca-0fcd398fae0c",
                                                "scanned_count": 1
                                            }
                                        ]
                                    },
                                    "returnable_packaging": {
                                        "data": [
                                            {
                                                "uuid": "a180e9a4-cb55-4398-8047-d3201e507b46",
                                                "count": -2,
                                                "returnable_packaging_type": {
                                                    "uuid": "a180e9a4-c9ef-40b8-b068-aee1832a25ea",
                                                    "type": "pallets"
                                                }
                                            }
                                        ]
                                    },
                                    "status": {
                                        "status_identifier": "delivered"
                                    },
                                    "signature": "YTE4MGU5YTQtYWJlZC00MDkxLWIxZTEtYTQ4M2I5YzM3ZTM3",
                                    "files": {
                                        "data": [
                                            {
                                                "type": "image",
                                                "key": "dlRsZmplQVZGdnNoU0FlVA"
                                            }
                                        ]
                                    }
                                }
                            ]
                        }
                    }
                ]
            }
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 12,
        "to": 1,
        "total": 1,
        "next": null,
        "prev": null
    }
}
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "The given data was invalid.",
    "errors": {
        "field": [
            "The field must be a string"
        ]
    }
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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:
27047297-c148-3ff8-a587-45f6e47ed7c0

Response Fields

Example request: 
curl --request GET \
    --get "http://localhost/api/v2/schedules/27047297-c148-3ff8-a587-45f6e47ed7c0" \
    --header "Authorization: Bearer {YOUR_API_KEY}"
Example response:
{
    "data": {
        "uuid": "59d8a9e7-7cc1-457f-8e54-5d5fe3b1186c",
        "date": "2026-04-09",
        "description": "Example Schedule 1",
        "total_travel_time": 0,
        "total_distance": 0,
        "notifications_send": false,
        "schedule_vehicles": {
            "data": [
                {
                    "uuid": "a180e9a4-aa5b-4ac5-a8f6-d5ca42884c1b",
                    "start_time": "08:00:00",
                    "end_time": "10:00:00",
                    "started_at": "2026-04-09 08:03:00",
                    "finished_at": "2026-04-09 10:02:00",
                    "total_travel_time": 0,
                    "total_distance": 1850,
                    "vehicle": {
                        "uuid": "a180e9a4-7af3-4a1c-a5ed-0772a5df2fdc",
                        "licence_plate": "RWEy7hkLg",
                        "description": "Van 1"
                    },
                    "user": {
                        "uuid": "a180e9a4-82d6-45fb-bc4d-be39148820d6",
                        "name": "Carrie Lindgren",
                        "public_name": "Carrie Lindgren"
                    },
                    "visits": {
                        "data": [
                            {
                                "uuid": "a180e9a4-abed-4091-b1e1-a483b9c37e37",
                                "type": "task",
                                "order_index": 0,
                                "delivery_time": "09:00:00",
                                "eta_start": "08:25",
                                "eta_end": "09:25",
                                "delivered_at": "2026-04-09T07:05:00.000000Z",
                                "task": {
                                    "uuid": "a180e9a4-886a-4f1c-b89d-5cf244b528c3",
                                    "type": "delivery",
                                    "external_identifier": "RLA0bIXdxEkd",
                                    "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/k4EqVr1tMUO5",
                                    "delivery_from_date": null,
                                    "delivery_date": "2026-04-09",
                                    "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-04-09T16:01:18.000000Z",
                                    "created_at": "2026-04-09T16:01:17.000000Z",
                                    "tags": [],
                                    "notification_template_uuid": null,
                                    "return_task_uuid": null,
                                    "address": {
                                        "street": "1576 Emerson Ridge Apt. 583",
                                        "house_number": "517",
                                        "house_number_extension": null,
                                        "postal_code": "28838",
                                        "city": "New Turner",
                                        "latitude": 5.4321,
                                        "longitude": 5.4321,
                                        "address_line": "1576 Emerson Ridge Apt. 583 517",
                                        "full_address_line": "1576 Emerson Ridge Apt. 583 517, 28838, New Turner",
                                        "country": {
                                            "iso_code": "NL",
                                            "description": "Nederland"
                                        }
                                    },
                                    "customer": {
                                        "name": "Fabian Skiles",
                                        "email": "[email protected]",
                                        "phone_number": null
                                    },
                                    "shipment_steps": null
                                },
                                "schedule_date": "2026-04-08T22:00:00.000000Z",
                                "address": {
                                    "street": "1576 Emerson Ridge Apt. 583",
                                    "house_number": "517",
                                    "house_number_extension": null,
                                    "postal_code": "28838",
                                    "city": "New Turner",
                                    "latitude": 5.4321,
                                    "longitude": 5.4321,
                                    "address_line": "1576 Emerson Ridge Apt. 583 517",
                                    "full_address_line": "1576 Emerson Ridge Apt. 583 517, 28838, New Turner",
                                    "country": {
                                        "iso_code": "NL",
                                        "description": "Nederland"
                                    }
                                },
                                "scanned_codes": {
                                    "data": [
                                        {
                                            "type": "task_code",
                                            "code_uuid": "a180e9a4-a4a4-4ad6-b31e-3729a7610302",
                                            "scanned_count": 1
                                        },
                                        {
                                            "type": "schedule_visit_code",
                                            "code_uuid": "a180e9a4-c5cf-4625-aaca-0fcd398fae0c",
                                            "scanned_count": 1
                                        }
                                    ]
                                },
                                "returnable_packaging": {
                                    "data": [
                                        {
                                            "uuid": "a180e9a4-cb55-4398-8047-d3201e507b46",
                                            "count": -2,
                                            "returnable_packaging_type": {
                                                "uuid": "a180e9a4-c9ef-40b8-b068-aee1832a25ea",
                                                "type": "pallets"
                                            }
                                        }
                                    ]
                                },
                                "status": {
                                    "status_identifier": "delivered"
                                },
                                "signature": "YTE4MGU5YTQtYWJlZC00MDkxLWIxZTEtYTQ4M2I5YzM3ZTM3",
                                "files": {
                                    "data": [
                                        {
                                            "type": "image",
                                            "key": "dlRsZmplQVZGdnNoU0FlVA"
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                }
            ]
        }
    }
}
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "The given data was invalid.",
    "errors": {
        "field": [
            "The field must be a string"
        ]
    }
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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:
59d8a9e7-7cc1-457f-8e54-5d5fe3b1186c

Body Parameters

Example request: 
curl --request POST \
    "http://localhost/api/v2/schedules/59d8a9e7-7cc1-457f-8e54-5d5fe3b1186c/send-notifications" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"types\": [
        \"sms\"
    ]
}"
Example response:
[Empty response]
{
    "message": "Insufficient sms credits."
}
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "The given data was invalid.",
    "errors": {
        "field": [
            "The field must be a string"
        ]
    }
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

Appointments


POST api/v2/appointments/availability

POST
http://localhost
/api/v2/appointments/availability

Headers

Content-Type
Example:
application/json

Body Parameters

Example request: 
curl --request POST \
    "http://localhost/api/v2/appointments/availability" \
    --header "Content-Type: application/json" \
    --data "{
    \"data\": {
        \"latitude\": 26174.672606,
        \"longitude\": 8592618.507,
        \"tags\": [
            \"gcllbq\"
        ],
        \"delivery_duration_minutes\": 5,
        \"start_date\": \"2040-01-02\",
        \"end_date\": \"2117-04-16\",
        \"used_capacity\": 2,
        \"used_capacity_2\": 5,
        \"used_capacity_3\": 22,
        \"type\": \"delivery\"
    }
}"
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

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\": \"dolorum\",
    \"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
Example request: 
curl --request GET \
    --get "http://localhost/api/v2/file/Y2DAi383qkBcm" \
    --header "Authorization: Bearer {YOUR_API_KEY}"
Example response:
[Binary data] -  The image
{
    "message": "Access token invalid"
}
{
    "message": "Access token missing"
}
{
    "message": "Required subscription is not active"
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Resource not found"
}
{
    "message": "Too Many Attempts."
}
{
    "message": "Server Error"
}

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:

  1. Enable Self-Managed Notifications Go to Notifications > Manage notifications yourself and make sure this setting is turned on.
  2. Set Up the sending_notifications Webhook Configure the sending_notifications webhook. When this webhook is triggered, handle the messages in your application as needed.
  3. 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-04-09T18:01:19+02:00",
    "data": {
        "uuid": "a180e9a4-886a-4f1c-b89d-5cf244b528c3",
        "type": "delivery",
        "external_identifier": "eEPWyE",
        "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\/k4EqVr1tMUO5",
        "delivery_from_date": null,
        "delivery_date": "2026-04-09",
        "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-04-09T16:01:17.000000Z",
        "created_at": "2026-04-09T16:01:17.000000Z",
        "tags": [],
        "notification_template_uuid": null,
        "return_task_uuid": null,
        "shipment_steps": null
    }
}

task_updated

This event is sent when a task has been updated

{
    "type": "task_updated",
    "timestamp": "2026-04-09T18:01:19+02:00",
    "data": {
        "uuid": "a180e9a4-886a-4f1c-b89d-5cf244b528c3",
        "type": "delivery",
        "external_identifier": "eEPWyE",
        "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\/k4EqVr1tMUO5",
        "delivery_from_date": null,
        "delivery_date": "2026-04-09",
        "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-04-09T16:01:17.000000Z",
        "created_at": "2026-04-09T16:01:17.000000Z",
        "tags": [],
        "notification_template_uuid": null,
        "return_task_uuid": null,
        "shipment_steps": null
    }
}

task_deleted

This event is sent when a task has been deleted

{
    "type": "task_deleted",
    "timestamp": "2026-04-09T18:01:19+02:00",
    "data": {
        "uuid": "a180e9a4-886a-4f1c-b89d-5cf244b528c3",
        "type": "delivery",
        "external_identifier": "eEPWyE",
        "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\/k4EqVr1tMUO5",
        "delivery_from_date": null,
        "delivery_date": "2026-04-09",
        "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-04-09T16:01:17.000000Z",
        "created_at": "2026-04-09T16:01:17.000000Z",
        "tags": [],
        "notification_template_uuid": null,
        "return_task_uuid": null,
        "shipment_steps": null
    }
}

visit_status_updated

This event is sent when a visit status has been updated

{
    "type": "visit_status_updated",
    "timestamp": "2026-04-09T18:01:19+02:00",
    "data": {
        "uuid": "a180e9a4-abed-4091-b1e1-a483b9c37e37",
        "type": "task",
        "order_index": 0,
        "delivery_time": "09:00:00",
        "eta_start": "08:25",
        "eta_end": "09:25",
        "delivered_at": "2026-04-09T07:05:00.000000Z",
        "task": {
            "uuid": "a180e9a4-886a-4f1c-b89d-5cf244b528c3",
            "type": "delivery",
            "external_identifier": "eEPWyE",
            "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\/k4EqVr1tMUO5",
            "delivery_from_date": null,
            "delivery_date": "2026-04-09",
            "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-04-09T16:01:17.000000Z",
            "created_at": "2026-04-09T16:01:17.000000Z",
            "tags": [],
            "notification_template_uuid": null,
            "return_task_uuid": null,
            "address": {
                "street": "1576 Emerson Ridge Apt. 583",
                "house_number": "517",
                "house_number_extension": null,
                "postal_code": "28838",
                "city": "New Turner",
                "latitude": 5.4321,
                "longitude": 5.4321,
                "address_line": "1576 Emerson Ridge Apt. 583 517",
                "full_address_line": "1576 Emerson Ridge Apt. 583 517, 28838, New Turner",
                "country": {
                    "iso_code": "NL",
                    "description": "Nederland"
                }
            },
            "customer": {
                "name": "Fabian Skiles",
                "email": "[email protected]",
                "phone_number": null
            },
            "shipment_steps": null
        },
        "schedule_date": "2026-04-08T22:00:00.000000Z",
        "status": {
            "status_identifier": "delivered"
        },
        "signature": "YTE4MGU5YTQtYWJlZC00MDkxLWIxZTEtYTQ4M2I5YzM3ZTM3",
        "files": {
            "data": [
                {
                    "type": "image",
                    "key": "dlRsZmplQVZGdnNoU0FlVA"
                }
            ]
        },
        "schedule_uuid": "59d8a9e7-7cc1-457f-8e54-5d5fe3b1186c"
    }
}

internal_note_created

This event is send when an internal note has been created

{
    "type": "internal_note_created",
    "timestamp": "2026-04-09T18:01:20+02:00",
    "data": {
        "message": "This is an example message. Drivers use this to communicate with their managers",
        "visit": {
            "uuid": "a180e9a4-abed-4091-b1e1-a483b9c37e37",
            "type": "task",
            "order_index": 0,
            "delivery_time": "09:00:00",
            "eta_start": "08:25",
            "eta_end": "09:25",
            "delivered_at": "2026-04-09T07:05:00.000000Z",
            "task": {
                "uuid": "a180e9a4-886a-4f1c-b89d-5cf244b528c3",
                "type": "delivery",
                "external_identifier": "RLA0bIXdxEkd",
                "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\/k4EqVr1tMUO5",
                "delivery_from_date": null,
                "delivery_date": "2026-04-09",
                "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-04-09T16:01:18.000000Z",
                "created_at": "2026-04-09T16:01:17.000000Z",
                "tags": [],
                "notification_template_uuid": null,
                "return_task_uuid": null,
                "address": {
                    "street": "1576 Emerson Ridge Apt. 583",
                    "house_number": "517",
                    "house_number_extension": null,
                    "postal_code": "28838",
                    "city": "New Turner",
                    "latitude": 5.4321,
                    "longitude": 5.4321,
                    "address_line": "1576 Emerson Ridge Apt. 583 517",
                    "full_address_line": "1576 Emerson Ridge Apt. 583 517, 28838, New Turner",
                    "country": {
                        "iso_code": "NL",
                        "description": "Nederland"
                    }
                },
                "customer": {
                    "name": "Fabian Skiles",
                    "email": "[email protected]",
                    "phone_number": null
                },
                "shipment_steps": null
            },
            "schedule_date": "2026-04-08T22:00:00.000000Z",
            "status": {
                "status_identifier": "delivered"
            },
            "signature": "YTE4MGU5YTQtYWJlZC00MDkxLWIxZTEtYTQ4M2I5YzM3ZTM3",
            "files": {
                "data": [
                    {
                        "type": "image",
                        "key": "dlRsZmplQVZGdnNoU0FlVA"
                    }
                ]
            }
        }
    }
}

schedule_calculated

This event is sent everytime a schedule has been calculated

{
    "type": "schedule_calculated",
    "timestamp": "2026-04-09T18:01:20+02:00",
    "data": {
        "uuid": "59d8a9e7-7cc1-457f-8e54-5d5fe3b1186c",
        "date": "2026-04-09",
        "description": "Example Schedule 1",
        "total_travel_time": 0,
        "total_distance": 0,
        "notifications_send": false,
        "schedule_vehicles": {
            "data": [
                {
                    "uuid": "a180e9a4-aa5b-4ac5-a8f6-d5ca42884c1b",
                    "start_time": "08:00:00",
                    "end_time": "10:00:00",
                    "started_at": "2026-04-09 08:03:00",
                    "finished_at": "2026-04-09 10:02:00",
                    "total_travel_time": 0,
                    "total_distance": 1850,
                    "vehicle": {
                        "uuid": "a180e9a4-7af3-4a1c-a5ed-0772a5df2fdc",
                        "licence_plate": "RWEy7hkLg",
                        "description": "Van 1"
                    },
                    "visits": {
                        "data": [
                            {
                                "uuid": "a180e9a4-abed-4091-b1e1-a483b9c37e37",
                                "type": "task",
                                "order_index": 0,
                                "delivery_time": "09:00:00",
                                "delivered_at": "2026-04-09T07:05:00.000000Z",
                                "task": {
                                    "uuid": "a180e9a4-886a-4f1c-b89d-5cf244b528c3",
                                    "external_identifier": "RLA0bIXdxEkd"
                                },
                                "task_uuid": "a180e9a4-886a-4f1c-b89d-5cf244b528c3",
                                "schedule_date": "2026-04-08T22:00:00.000000Z",
                                "status": {
                                    "status_identifier": "delivered"
                                },
                                "signature": "YTE4MGU5YTQtYWJlZC00MDkxLWIxZTEtYTQ4M2I5YzM3ZTM3",
                                "files": {
                                    "data": [
                                        {
                                            "type": "image",
                                            "key": "dlRsZmplQVZGdnNoU0FlVA"
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                }
            ]
        }
    }
}

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-04-09T18:01:20+02:00",
    "data": {
        "uuid": "59d8a9e7-7cc1-457f-8e54-5d5fe3b1186c",
        "date": "2026-04-09",
        "description": "Example Schedule 1",
        "total_travel_time": 0,
        "total_distance": 0,
        "notifications_send": false,
        "first_notification": true,
        "schedule_vehicles": {
            "data": [
                {
                    "uuid": "a180e9a4-aa5b-4ac5-a8f6-d5ca42884c1b",
                    "start_time": "08:00:00",
                    "end_time": "10:00:00",
                    "started_at": "2026-04-09 08:03:00",
                    "finished_at": "2026-04-09 10:02:00",
                    "total_travel_time": 0,
                    "total_distance": 1850,
                    "vehicle": {
                        "uuid": "a180e9a4-7af3-4a1c-a5ed-0772a5df2fdc",
                        "licence_plate": "RWEy7hkLg",
                        "description": "Van 1"
                    },
                    "user": {
                        "uuid": "a180e9a4-82d6-45fb-bc4d-be39148820d6",
                        "name": "Carrie Lindgren",
                        "public_name": "Carrie Lindgren"
                    },
                    "visits": {
                        "data": [
                            {
                                "uuid": "a180e9a4-abed-4091-b1e1-a483b9c37e37",
                                "type": "task",
                                "order_index": 0,
                                "delivery_time": "09:00:00",
                                "eta_start": "08:25",
                                "eta_end": "09:25",
                                "delivered_at": "2026-04-09T07:05:00.000000Z",
                                "task": {
                                    "uuid": "a180e9a4-886a-4f1c-b89d-5cf244b528c3",
                                    "type": "delivery",
                                    "external_identifier": "RLA0bIXdxEkd",
                                    "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\/k4EqVr1tMUO5",
                                    "delivery_from_date": null,
                                    "delivery_date": "2026-04-09",
                                    "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-04-09T16:01:18.000000Z",
                                    "created_at": "2026-04-09T16:01:17.000000Z",
                                    "tags": [],
                                    "notification_template_uuid": null,
                                    "return_task_uuid": null,
                                    "address": {
                                        "street": "1576 Emerson Ridge Apt. 583",
                                        "house_number": "517",
                                        "house_number_extension": null,
                                        "postal_code": "28838",
                                        "city": "New Turner",
                                        "latitude": 5.4321,
                                        "longitude": 5.4321,
                                        "address_line": "1576 Emerson Ridge Apt. 583 517",
                                        "full_address_line": "1576 Emerson Ridge Apt. 583 517, 28838, New Turner",
                                        "country": {
                                            "iso_code": "NL",
                                            "description": "Nederland"
                                        }
                                    },
                                    "customer": {
                                        "name": "Fabian Skiles",
                                        "email": "[email protected]",
                                        "phone_number": null
                                    },
                                    "shipment_steps": null
                                },
                                "schedule_date": "2026-04-08T22:00:00.000000Z",
                                "status": {
                                    "status_identifier": "delivered"
                                },
                                "signature": "YTE4MGU5YTQtYWJlZC00MDkxLWIxZTEtYTQ4M2I5YzM3ZTM3"
                            }
                        ]
                    }
                }
            ]
        }
    }
}