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
https://api.routelogic.io
/api/v2/tasks
requires authentication

Get paginated collection of tasks from your company

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

Headers

Authorization
Example:
Bearer {YOUR_API_KEY}
Content-Type
Example:
application/json
Accept
Example:
application/json

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:
2025-08-26
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:
2025-08-26
filters.types
string[]

Filter on specific task types.

Must be one of:
  • delivery
  • pickup
  • recurring
Example:
["delivery"]
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:
include
filters.limit
integer

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

Example:
46
filters.page
integer

Must be at least 1.

Example:
21

Response Fields

Example request:
curl --request GET \
    --get "https://api.routelogic.io/api/v2/tasks?filters[search]=Amsterdam&filters[from_date]=2025-08-26&filters[to_date]=2025-08-26&filters[types][]=delivery&filters[statuses][]=planned&filters[deleted]=include&filters[limit]=46&filters[page]=21" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "uuid": "9fba29e6-e5a9-45c6-8c0b-d691cee408b3",
            "type": "delivery",
            "external_identifier": "Eol6I4",
            "external_reference": null,
            "note": null,
            "pending_payment_amount": 0,
            "external_link": null,
            "track_and_trace_link": "http://localhost/tr/j0COhCryec7I",
            "delivery_from_date": null,
            "delivery_date": "2025-08-26",
            "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": "2025-08-26T14:39:17.000000Z",
            "created_at": "2025-08-26T14:39:17.000000Z",
            "tags": [],
            "notification_template_uuid": null,
            "return_task_uuid": null,
            "address": {
                "street": "7740 Adrain Track",
                "house_number": "6669",
                "house_number_extension": null,
                "postal_code": "56650",
                "city": "Mikelmouth",
                "latitude": 5.4321,
                "longitude": 5.4321,
                "address_line": "7740 Adrain Track 6669",
                "full_address_line": "7740 Adrain Track 6669, 56650, Mikelmouth",
                "country": {
                    "iso_code": "NL",
                    "description": "Nederland"
                }
            },
            "customer": {
                "name": "Kirk Stiedemann",
                "email": null,
                "phone_number": null
            },
            "shipment_steps": null,
            "next_visit": {
                "uuid": "9fba29e6-fbb6-4bf7-8305-2b68d1300e84",
                "type": "task",
                "order_index": 0,
                "delivery_time": "09:00:00",
                "schedule_date": "2025-08-25T22:00:00.000000Z",
                "address": {
                    "street": "7740 Adrain Track",
                    "house_number": "6669",
                    "house_number_extension": null,
                    "postal_code": "56650",
                    "city": "Mikelmouth",
                    "latitude": 5.4321,
                    "longitude": 5.4321,
                    "address_line": "7740 Adrain Track 6669",
                    "full_address_line": "7740 Adrain Track 6669, 56650, Mikelmouth",
                    "country": {
                        "iso_code": "NL",
                        "description": "Nederland"
                    }
                },
                "scanned_codes": {
                    "data": [
                        {
                            "type": "task_code",
                            "code_uuid": "9fba29e6-f775-4020-b7be-dbb706810ed7",
                            "scanned_count": 1
                        },
                        {
                            "type": "schedule_visit_code",
                            "code_uuid": "9fba29e7-06fb-4b7b-b3b3-977ed0ab149f",
                            "scanned_count": 1
                        }
                    ]
                },
                "returnable_packaging": {
                    "data": [
                        {
                            "uuid": "9fba29e7-0b1d-4671-b234-2ce33bf581fc",
                            "count": -2,
                            "returnable_packaging_type": {
                                "uuid": "9fba29e7-0a21-423c-85c4-b56d35e585b8",
                                "type": "pallets"
                            }
                        }
                    ]
                },
                "status": {
                    "status_identifier": "delivered"
                },
                "signature": "OWZiYTI5ZTYtZmJiNi00YmY3LTgzMDUtMmI2OGQxMzAwZTg0",
                "files": {
                    "data": [
                        {
                            "type": "image",
                            "key": "RGk1aUZPeVJ2bUUzcGR6dg"
                        }
                    ]
                }
            }
        }
    ],
    "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
https://api.routelogic.io
/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
Accept
Example:
application/json

Body Parameters

Response Fields

Example request:
curl --request POST \
    "https://api.routelogic.io/api/v2/tasks" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"delivery\",
    \"external_identifier\": \"vvgkxuqscilbkys\",
    \"external_reference\": \"zcfc\",
    \"note\": \"Please deliver at the side door.\",
    \"pending_payment_amount\": 100,
    \"external_link\": \"https:\\/\\/example.com\\/\",
    \"delivery_from_date\": \"2021-10-02\",
    \"start_time\": \"08:00\",
    \"end_time\": \"17:00\",
    \"delivery_duration_minutes\": 9,
    \"return_required\": false,
    \"return_task_uuid\": \"ab0ac504-2a7c-361a-ae34-9f548d5d1b39\",
    \"signature_required\": true,
    \"used_capacity\": 7,
    \"used_capacity_2\": 5,
    \"used_capacity_3\": 1,
    \"notification_template_uuid\": \"089bd1ed-6564-3902-8668-52beb2b30acd\",
    \"recurring\": {
        \"period\": \"month\",
        \"interval\": 6,
        \"settings\": \"[\\\"string\\\", \\\"third\\\", \\\"monday\\\"]\",
        \"end_date\": \"2075-08-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\": \"2025-08-26T16:39:19\",
    \"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": "9fba29e8-58b8-4354-9fa4-49614078840d",
    "type": "delivery",
    "external_identifier": "RLqNEeJ7sLFQ",
    "external_reference": null,
    "note": null,
    "pending_payment_amount": 0,
    "external_link": null,
    "track_and_trace_link": "http://localhost/tr/jMO5zWvPjrDD",
    "delivery_from_date": null,
    "delivery_date": "2025-08-26",
    "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": "2025-08-26T14:39:18.000000Z",
    "created_at": "2025-08-26T14:39: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,
    "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
https://api.routelogic.io
/api/v2/tasks/{task_uuid}
requires authentication

Get a task from your company

RateLimit (60/min)

Headers

Authorization
Example:
Bearer {YOUR_API_KEY}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

task_uuid
string

uuid of the corresponding task

Example:
61754b6e-cab0-38db-b2f0-a424c5b1c06d

Response Fields

Example request:
curl --request GET \
    --get "https://api.routelogic.io/api/v2/tasks/61754b6e-cab0-38db-b2f0-a424c5b1c06d" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "uuid": "9fba29e6-e5a9-45c6-8c0b-d691cee408b3",
    "type": "delivery",
    "external_identifier": "Eol6I4",
    "external_reference": null,
    "note": null,
    "pending_payment_amount": 0,
    "external_link": null,
    "track_and_trace_link": "http://localhost/tr/j0COhCryec7I",
    "delivery_from_date": null,
    "delivery_date": "2025-08-26",
    "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": "2025-08-26T14:39:17.000000Z",
    "created_at": "2025-08-26T14:39:17.000000Z",
    "tags": [],
    "notification_template_uuid": null,
    "return_task_uuid": null,
    "address": {
        "street": "7740 Adrain Track",
        "house_number": "6669",
        "house_number_extension": null,
        "postal_code": "56650",
        "city": "Mikelmouth",
        "latitude": 5.4321,
        "longitude": 5.4321,
        "address_line": "7740 Adrain Track 6669",
        "full_address_line": "7740 Adrain Track 6669, 56650, Mikelmouth",
        "country": {
            "iso_code": "NL",
            "description": "Nederland"
        }
    },
    "customer": {
        "name": "Kirk Stiedemann",
        "email": null,
        "phone_number": null
    },
    "shipment_steps": null,
    "next_visit": {
        "uuid": "9fba29e6-fbb6-4bf7-8305-2b68d1300e84",
        "type": "task",
        "order_index": 0,
        "delivery_time": "09:00:00",
        "schedule_date": "2025-08-25T22:00:00.000000Z",
        "address": {
            "street": "7740 Adrain Track",
            "house_number": "6669",
            "house_number_extension": null,
            "postal_code": "56650",
            "city": "Mikelmouth",
            "latitude": 5.4321,
            "longitude": 5.4321,
            "address_line": "7740 Adrain Track 6669",
            "full_address_line": "7740 Adrain Track 6669, 56650, Mikelmouth",
            "country": {
                "iso_code": "NL",
                "description": "Nederland"
            }
        },
        "scanned_codes": {
            "data": [
                {
                    "type": "task_code",
                    "code_uuid": "9fba29e6-f775-4020-b7be-dbb706810ed7",
                    "scanned_count": 1
                },
                {
                    "type": "schedule_visit_code",
                    "code_uuid": "9fba29e7-06fb-4b7b-b3b3-977ed0ab149f",
                    "scanned_count": 1
                }
            ]
        },
        "returnable_packaging": {
            "data": [
                {
                    "uuid": "9fba29e7-0b1d-4671-b234-2ce33bf581fc",
                    "count": -2,
                    "returnable_packaging_type": {
                        "uuid": "9fba29e7-0a21-423c-85c4-b56d35e585b8",
                        "type": "pallets"
                    }
                }
            ]
        },
        "status": {
            "status_identifier": "delivered"
        },
        "signature": "OWZiYTI5ZTYtZmJiNi00YmY3LTgzMDUtMmI2OGQxMzAwZTg0",
        "files": {
            "data": [
                {
                    "type": "image",
                    "key": "RGk1aUZPeVJ2bUUzcGR6dg"
                }
            ]
        }
    }
}
{
    "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
https://api.routelogic.io
/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
Accept
Example:
application/json

URL Parameters

task_uuid
string

uuid of the corresponding task

Example:
418fbade-0c5a-3dec-b1e2-5c2916b1cb6d

Body Parameters

Response Fields

Example request:
curl --request PUT \
    "https://api.routelogic.io/api/v2/tasks/418fbade-0c5a-3dec-b1e2-5c2916b1cb6d" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"delivery\",
    \"external_identifier\": \"toys\",
    \"external_reference\": \"ydurhtbxlsdjescbmqcnlfgj\",
    \"note\": \"Please deliver at the side door.\",
    \"pending_payment_amount\": 100,
    \"external_link\": \"https:\\/\\/example.com\\/\",
    \"delivery_from_date\": \"2007-11-19\",
    \"start_time\": \"08:00\",
    \"end_time\": \"17:00\",
    \"delivery_duration_minutes\": 5,
    \"return_required\": false,
    \"return_task_uuid\": \"73da6a68-c47e-3f32-8e51-30a8809ffa10\",
    \"signature_required\": false,
    \"used_capacity\": 9,
    \"used_capacity_2\": 3,
    \"used_capacity_3\": 23,
    \"notification_template_uuid\": \"bd299be8-dc33-3cb5-a219-89f22901fa17\",
    \"recurring\": {
        \"period\": \"week\",
        \"interval\": 6,
        \"settings\": \"[\\\"string\\\", \\\"third\\\", \\\"monday\\\"]\",
        \"end_date\": \"2082-03-08\"
    },
    \"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\": \"2025-08-26T16:39:19\",
    \"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": "9fba29e6-e5a9-45c6-8c0b-d691cee408b3",
    "type": "delivery",
    "external_identifier": "RLW7p9RHYsqi",
    "external_reference": null,
    "note": null,
    "pending_payment_amount": 0,
    "external_link": null,
    "track_and_trace_link": "http://localhost/tr/j0COhCryec7I",
    "delivery_from_date": null,
    "delivery_date": "2025-08-26",
    "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": "2025-08-26T14:39:18.000000Z",
    "created_at": "2025-08-26T14:39:17.000000Z",
    "tags": [],
    "notification_template_uuid": null,
    "return_task_uuid": null,
    "address": {
        "street": "7740 Adrain Track",
        "house_number": "6669",
        "house_number_extension": null,
        "postal_code": "56650",
        "city": "Mikelmouth",
        "latitude": 5.4321,
        "longitude": 5.4321,
        "address_line": "7740 Adrain Track 6669",
        "full_address_line": "7740 Adrain Track 6669, 56650, Mikelmouth",
        "country": {
            "iso_code": "NL",
            "description": "Nederland"
        }
    },
    "customer": {
        "name": "Kirk Stiedemann",
        "email": null,
        "phone_number": null
    },
    "shipment_steps": null,
    "next_visit": {
        "uuid": "9fba29e6-fbb6-4bf7-8305-2b68d1300e84",
        "type": "task",
        "order_index": 0,
        "delivery_time": "09:00:00",
        "schedule_date": "2025-08-25T22:00:00.000000Z",
        "address": {
            "street": "7740 Adrain Track",
            "house_number": "6669",
            "house_number_extension": null,
            "postal_code": "56650",
            "city": "Mikelmouth",
            "latitude": 5.4321,
            "longitude": 5.4321,
            "address_line": "7740 Adrain Track 6669",
            "full_address_line": "7740 Adrain Track 6669, 56650, Mikelmouth",
            "country": {
                "iso_code": "NL",
                "description": "Nederland"
            }
        },
        "scanned_codes": {
            "data": [
                {
                    "type": "task_code",
                    "code_uuid": "9fba29e6-f775-4020-b7be-dbb706810ed7",
                    "scanned_count": 1
                },
                {
                    "type": "schedule_visit_code",
                    "code_uuid": "9fba29e7-06fb-4b7b-b3b3-977ed0ab149f",
                    "scanned_count": 1
                }
            ]
        },
        "returnable_packaging": {
            "data": [
                {
                    "uuid": "9fba29e7-0b1d-4671-b234-2ce33bf581fc",
                    "count": -2,
                    "returnable_packaging_type": {
                        "uuid": "9fba29e7-0a21-423c-85c4-b56d35e585b8",
                        "type": "pallets"
                    }
                }
            ]
        },
        "status": {
            "status_identifier": "delivered"
        },
        "signature": "OWZiYTI5ZTYtZmJiNi00YmY3LTgzMDUtMmI2OGQxMzAwZTg0",
        "files": {
            "data": [
                {
                    "type": "image",
                    "key": "RGk1aUZPeVJ2bUUzcGR6dg"
                }
            ]
        }
    }
}
{
    "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
https://api.routelogic.io
/api/v2/tasks/{task_uuid}
requires authentication

Delete a task from your company

RateLimit (60/min)

Headers

Authorization
Example:
Bearer {YOUR_API_KEY}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

task_uuid
string

uuid of the corresponding task

Example:
bcf186bb-52ee-3735-95c2-5aa3cf9f606d

Query Parameters

forceRemoveFromSchedules
boolean

Optionally force remove task from all schedules.

Example request:
curl --request DELETE \
    "https://api.routelogic.io/api/v2/tasks/bcf186bb-52ee-3735-95c2-5aa3cf9f606d?forceRemoveFromSchedules=" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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 Products

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


GET Products

GET
https://api.routelogic.io
/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}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

task_uuid
string

uuid of the corresponding task

Example:
0c5b0a94-1ed5-3a21-a1b2-7d20afab3178

Response Fields

Example request:
curl --request GET \
    --get "https://api.routelogic.io/api/v2/tasks/0c5b0a94-1ed5-3a21-a1b2-7d20afab3178/products" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "uuid": "9fba29e6-f5ed-423a-8e8f-333ed41d32f9",
            "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
https://api.routelogic.io
/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
Accept
Example:
application/json

URL Parameters

task_uuid
string

uuid of the corresponding task

Example:
0580baad-3628-3325-a477-d837808abf13

Body Parameters

Response Fields

Example request:
curl --request POST \
    "https://api.routelogic.io/api/v2/tasks/0580baad-3628-3325-a477-d837808abf13/products" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": [
        {
            \"identifier\": \"zrrj\",
            \"quantity\": 14,
            \"unit\": \"pieces\",
            \"description\": \"Table\"
        }
    ]
}"
Example response:
{
    "data": [
        {
            "uuid": "9fba29e8-f26c-4cf4-866f-b4f32c7c9741",
            "quantity": 1,
            "description": "Test line",
            "unit": "pieces",
            "identifier": "2f7e673aae64ffbe3821016e253b45ed"
        },
        {
            "uuid": "9fba29e8-f341-450f-8bd1-a041825135dc",
            "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
https://api.routelogic.io
/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}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

task_uuid
string

uuid of the corresponding task

Example:
b713f4cc-156c-3267-bc11-ee8cb1ae6a14
product_uuid
string

uuid of the corresponding product

Example:
f73b253f-7180-3c1f-a438-c5c43bb2b299

Response Fields

Example request:
curl --request GET \
    --get "https://api.routelogic.io/api/v2/tasks/b713f4cc-156c-3267-bc11-ee8cb1ae6a14/products/f73b253f-7180-3c1f-a438-c5c43bb2b299" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "uuid": "9fba29e6-f5ed-423a-8e8f-333ed41d32f9",
        "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
https://api.routelogic.io
/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
Accept
Example:
application/json

URL Parameters

task_uuid
string

uuid of the corresponding task

Example:
01d29dce-9caf-339d-8202-acd5365c267b
product_uuid
string

uuid of the corresponding product

Example:
5da1ac7a-b6ce-3251-8146-b51e564d59d7

Body Parameters

Response Fields

Example request:
curl --request PUT \
    "https://api.routelogic.io/api/v2/tasks/01d29dce-9caf-339d-8202-acd5365c267b/products/5da1ac7a-b6ce-3251-8146-b51e564d59d7" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"identifier\": \"ungqasxythkhsklhhxeku\",
    \"quantity\": 13,
    \"unit\": \"weight\",
    \"description\": \"Table\"
}"
Example response:
{
    "data": {
        "uuid": "9fba29e6-f5ed-423a-8e8f-333ed41d32f9",
        "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
https://api.routelogic.io
/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}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

task_uuid
string

uuid of the corresponding task

Example:
9c96cf10-5e0a-30c4-8ba7-90e37e8f0b38
product_uuid
string

uuid of the corresponding product

Example:
02d0127d-ab92-3fac-a2b6-2737de170f71
Example request:
curl --request DELETE \
    "https://api.routelogic.io/api/v2/tasks/9c96cf10-5e0a-30c4-8ba7-90e37e8f0b38/products/02d0127d-ab92-3fac-a2b6-2737de170f71" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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
https://api.routelogic.io
/api/v2/tasks/{task_uuid}/products
requires authentication

RateLimit (60/min)

Headers

Authorization
Example:
Bearer {YOUR_API_KEY}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

task_uuid
string

uuid of the corresponding task

Example:
73548406-1144-3c8c-ae64-f2917fc51db5
Example request:
curl --request DELETE \
    "https://api.routelogic.io/api/v2/tasks/73548406-1144-3c8c-ae64-f2917fc51db5/products" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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
https://api.routelogic.io
/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}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

task_uuid
string

uuid of the corresponding task

Example:
fca44fc3-b183-3b50-84ad-e27be9b19910

Response Fields

Example request:
curl --request GET \
    --get "https://api.routelogic.io/api/v2/tasks/fca44fc3-b183-3b50-84ad-e27be9b19910/codes" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "uuid": "9fba29e6-f775-4020-b7be-dbb706810ed7",
            "amount": 1,
            "code": "8cX0oMZyozRyFmgA",
            "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
https://api.routelogic.io
/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
Accept
Example:
application/json

URL Parameters

task_uuid
string

uuid of the corresponding task

Example:
a0aeac83-d895-3dca-9b62-8c646331f0b8

Body Parameters

Response Fields

Example request:
curl --request POST \
    "https://api.routelogic.io/api/v2/tasks/a0aeac83-d895-3dca-9b62-8c646331f0b8/codes" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": [
        {
            \"amount\": 12,
            \"code\": \"o\",
            \"description\": \"Table\"
        }
    ]
}"
Example response:
{
    "data": [
        {
            "uuid": "9fba29e9-1f3a-43c1-8f28-116df250e995",
            "amount": 1,
            "code": "1234567890",
            "description": "Box"
        },
        {
            "uuid": "9fba29e9-1ff3-449f-b43d-72f4e6ebca52",
            "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
https://api.routelogic.io
/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}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

task_uuid
string

uuid of the corresponding task

Example:
73b07010-89cb-3c8f-a4ba-163e1d30e346
taskCode_uuid
string

uuid of the corresponding task code

Example:
477caaeb-d1c3-3d14-a82b-e597ac5514ae

Response Fields

Example request:
curl --request GET \
    --get "https://api.routelogic.io/api/v2/tasks/73b07010-89cb-3c8f-a4ba-163e1d30e346/codes/477caaeb-d1c3-3d14-a82b-e597ac5514ae" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "uuid": "9fba29e6-f775-4020-b7be-dbb706810ed7",
        "amount": 1,
        "code": "8cX0oMZyozRyFmgA",
        "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
https://api.routelogic.io
/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
Accept
Example:
application/json

URL Parameters

task_uuid
string

uuid of the corresponding task

Example:
cb752730-09fd-3710-93f1-71ab56ae0ee0
taskCode_uuid
string

uuid of the corresponding task code

Example:
ffcc8b5a-6e27-3728-8a06-696b2523f594

Body Parameters

Response Fields

Example request:
curl --request PUT \
    "https://api.routelogic.io/api/v2/tasks/cb752730-09fd-3710-93f1-71ab56ae0ee0/codes/ffcc8b5a-6e27-3728-8a06-696b2523f594" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"amount\": 1,
    \"code\": \"dkjao\",
    \"description\": \"Table\"
}"
Example response:
{
    "data": {
        "uuid": "9fba29e6-f775-4020-b7be-dbb706810ed7",
        "amount": 1,
        "code": "8cX0oMZyozRyFmgA",
        "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
https://api.routelogic.io
/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}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

task_uuid
string

uuid of the corresponding task

Example:
d2ac3e03-f7ba-3806-874f-ba9c2b0273b6
taskCode_uuid
string

uuid of the corresponding task code

Example:
e5aca0c3-dc91-3cf6-8452-39730d3d3a6c
Example request:
curl --request DELETE \
    "https://api.routelogic.io/api/v2/tasks/d2ac3e03-f7ba-3806-874f-ba9c2b0273b6/codes/e5aca0c3-dc91-3cf6-8452-39730d3d3a6c" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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
https://api.routelogic.io
/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}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

scheduleVisit_uuid
string

uuid of the corresponding scheduled visit

Example:
0da1dce2-5319-3527-9793-48e433acdfd1

Response Fields

Example request:
curl --request GET \
    --get "https://api.routelogic.io/api/v2/visits/0da1dce2-5319-3527-9793-48e433acdfd1/codes" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "uuid": "9fba29e7-06fb-4b7b-b3b3-977ed0ab149f",
            "amount": 1,
            "code": "bdtNZLethB1LRqIv",
            "description": "lamp"
        }
    ]
}
{
    "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
https://api.routelogic.io
/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
Accept
Example:
application/json

URL Parameters

scheduleVisit_uuid
string

uuid of the corresponding scheduled visit

Example:
6e8d5a0d-5bd1-36e9-a396-cd59875166a7

Body Parameters

Response Fields

Example request:
curl --request POST \
    "https://api.routelogic.io/api/v2/visits/6e8d5a0d-5bd1-36e9-a396-cd59875166a7/codes" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": [
        {
            \"amount\": 4,
            \"code\": \"fhlzpmyraduscw\",
            \"description\": \"Table\"
        }
    ]
}"
Example response:
{
    "data": [
        {
            "uuid": "9fba29e9-f79e-49ad-ae9c-bb8d214b3498",
            "amount": 1,
            "code": "1234567890",
            "description": "Box"
        },
        {
            "uuid": "9fba29e9-f863-4bbc-a17c-03c1d38409f5",
            "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
https://api.routelogic.io
/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}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

scheduleVisit_uuid
string

uuid of the corresponding scheduled visit

Example:
0dd2f49a-95ee-3699-b7f5-2dd3d775276b
scheduleVisitCode_uuid
string

uuid of the corresponding scheduled visit code

Example:
ed3772df-c90f-3fc9-9062-dd2a5135307a

Response Fields

Example request:
curl --request GET \
    --get "https://api.routelogic.io/api/v2/visits/0dd2f49a-95ee-3699-b7f5-2dd3d775276b/codes/ed3772df-c90f-3fc9-9062-dd2a5135307a" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "uuid": "9fba29e7-06fb-4b7b-b3b3-977ed0ab149f",
        "amount": 1,
        "code": "bdtNZLethB1LRqIv",
        "description": "lamp"
    }
}
{
    "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
https://api.routelogic.io
/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
Accept
Example:
application/json

URL Parameters

scheduleVisit_uuid
string

uuid of the corresponding scheduled visit

Example:
77ffd400-366f-3df4-8a07-bfa65d4b8a00
scheduleVisitCode_uuid
string

uuid of the corresponding scheduled visit code

Example:
2339d7e8-5a99-3191-bef6-168d5c2404dd

Body Parameters

Response Fields

Example request:
curl --request PUT \
    "https://api.routelogic.io/api/v2/visits/77ffd400-366f-3df4-8a07-bfa65d4b8a00/codes/2339d7e8-5a99-3191-bef6-168d5c2404dd" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"amount\": 21,
    \"code\": \"clahglzixvvnfyduoli\",
    \"description\": \"Table\"
}"
Example response:
{
    "data": {
        "uuid": "9fba29e7-06fb-4b7b-b3b3-977ed0ab149f",
        "amount": 1,
        "code": "bdtNZLethB1LRqIv",
        "description": "lamp"
    }
}
{
    "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
https://api.routelogic.io
/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}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

scheduleVisit_uuid
string

uuid of the corresponding scheduled visit

Example:
0eb8465e-7b2d-33ff-a3c0-d0633eb2fb03
scheduleVisitCode_uuid
string

uuid of the corresponding scheduled visit code

Example:
f1394350-6136-3114-b4a3-03d00a1677ca
Example request:
curl --request DELETE \
    "https://api.routelogic.io/api/v2/visits/0eb8465e-7b2d-33ff-a3c0-d0633eb2fb03/codes/f1394350-6136-3114-b4a3-03d00a1677ca" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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
https://api.routelogic.io
/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}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

task_uuid
string

uuid of the corresponding task

Example:
a08e9a27-16a0-3499-b824-cc91fa929386

Response Fields

Example request:
curl --request GET \
    --get "https://api.routelogic.io/api/v2/tasks/a08e9a27-16a0-3499-b824-cc91fa929386/returnablePackaging" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "uuid": "9fba29e6-f95c-402f-a68d-06684d71d3e6",
            "count": 1,
            "returnable_packaging_type": {
                "uuid": "9fba29e6-f886-4f0a-8b25-1037d6d588da",
                "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
https://api.routelogic.io
/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
Accept
Example:
application/json

URL Parameters

task_uuid
string

uuid of the corresponding task

Example:
51d0c988-e385-36a1-bc37-16fd393724d8

Body Parameters

Response Fields

Example request:
curl --request POST \
    "https://api.routelogic.io/api/v2/tasks/51d0c988-e385-36a1-bc37-16fd393724d8/returnablePackaging" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": [
        {
            \"count\": 11,
            \"returnable_packaging_type_uuid\": \"c16e06ef-9277-3e19-8478-c22c4b9efd05\"
        }
    ]
}"
Example response:
{
    "data": [
        {
            "uuid": "9fba29e9-5250-4bbd-8277-921797029d72",
            "count": 1,
            "returnable_packaging_type": {
                "uuid": "9fba29e6-f886-4f0a-8b25-1037d6d588da",
                "type": "box"
            }
        },
        {
            "uuid": "9fba29e9-5379-4d46-8be3-0a1191ef4d92",
            "count": -2,
            "returnable_packaging_type": {
                "uuid": "9fba29e6-f886-4f0a-8b25-1037d6d588da",
                "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
https://api.routelogic.io
/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}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

task_uuid
string

uuid of the corresponding task

Example:
6e5c7489-b511-38a2-b245-9d6adf9a5c54
taskReturnablePackaging_uuid
string

uuid of the corresponding task returnable packaging

Example:
0bf53043-76cb-39ce-a102-902be3fbd5c7

Response Fields

Example request:
curl --request GET \
    --get "https://api.routelogic.io/api/v2/tasks/6e5c7489-b511-38a2-b245-9d6adf9a5c54/returnablePackaging/0bf53043-76cb-39ce-a102-902be3fbd5c7" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "uuid": "9fba29e6-f95c-402f-a68d-06684d71d3e6",
        "count": 1,
        "returnable_packaging_type": {
            "uuid": "9fba29e6-f886-4f0a-8b25-1037d6d588da",
            "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
https://api.routelogic.io
/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
Accept
Example:
application/json

URL Parameters

task_uuid
string

uuid of the corresponding task

Example:
4b9fdfb3-9044-30b6-b7b0-8235cf8419bb
taskReturnablePackaging_uuid
string

uuid of the corresponding task returnable packaging

Example:
ca4612e5-448f-3a67-9a75-b03e95109558

Body Parameters

Response Fields

Example request:
curl --request PUT \
    "https://api.routelogic.io/api/v2/tasks/4b9fdfb3-9044-30b6-b7b0-8235cf8419bb/returnablePackaging/ca4612e5-448f-3a67-9a75-b03e95109558" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"count\": 14
}"
Example response:
{
    "data": {
        "uuid": "9fba29e6-f95c-402f-a68d-06684d71d3e6",
        "count": 1,
        "returnable_packaging_type": {
            "uuid": "9fba29e6-f886-4f0a-8b25-1037d6d588da",
            "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
https://api.routelogic.io
/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}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

task_uuid
string

uuid of the corresponding task

Example:
05399f29-c916-3003-bb62-a30fa5e27bab
taskReturnablePackaging_uuid
string

uuid of the corresponding task returnable packaging

Example:
639e8a8a-8ded-35ab-a5b3-26bd32447602
Example request:
curl --request DELETE \
    "https://api.routelogic.io/api/v2/tasks/05399f29-c916-3003-bb62-a30fa5e27bab/returnablePackaging/639e8a8a-8ded-35ab-a5b3-26bd32447602" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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
https://api.routelogic.io
/api/v2/webhookGroups
requires authentication

Get paginated collection of webhook groups from your company

RateLimit (60/min)

Headers

Authorization
Example:
Bearer {YOUR_API_KEY}
Content-Type
Example:
application/json
Accept
Example:
application/json

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

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

Example:
68

Response Fields

Example request:
curl --request GET \
    --get "https://api.routelogic.io/api/v2/webhookGroups?filters[limit]=74&filters[page]=68" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "uuid": "9fba29e6-ffa4-483c-a469-bee14f80da30",
            "name": "Webhook group 1",
            "description": "Task webhook group 1",
            "webhook_url": "https://test.com/webhook/",
            "events": []
        },
        {
            "uuid": "9fba29e7-2bf8-4b6d-bfba-66a158d0e478",
            "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
https://api.routelogic.io
/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
Accept
Example:
application/json

Body Parameters

Response Fields

Example request:
curl --request POST \
    "https://api.routelogic.io/api/v2/webhookGroups" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: 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\": [
        \"task_deleted\"
    ]
}"
Example response:
{
    "data": {
        "uuid": "9fba29e9-8a66-4426-a870-6c6e77cc7efd",
        "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
https://api.routelogic.io
/api/v2/webhookGroups/{webhookGroup_uuid}
requires authentication

Get a webhook group from your company

RateLimit (60/min)

Headers

Authorization
Example:
Bearer {YOUR_API_KEY}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

webhookGroup_uuid
string

uuid of the corresponding webhook group

Example:
77488997-ccca-3760-8bf5-0c5932c4b499

Response Fields

Example request:
curl --request GET \
    --get "https://api.routelogic.io/api/v2/webhookGroups/77488997-ccca-3760-8bf5-0c5932c4b499" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "uuid": "9fba29e7-2bf8-4b6d-bfba-66a158d0e478",
        "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
https://api.routelogic.io
/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
Accept
Example:
application/json

URL Parameters

webhookGroup_uuid
string

uuid of the corresponding webhook group

Example:
bcbdc6c1-f6bc-31dd-aca8-873ec0851f2c

Body Parameters

Response Fields

Example request:
curl --request PUT \
    "https://api.routelogic.io/api/v2/webhookGroups/bcbdc6c1-f6bc-31dd-aca8-873ec0851f2c" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: 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": "9fba29e7-2bf8-4b6d-bfba-66a158d0e478",
        "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
https://api.routelogic.io
/api/v2/webhookGroups/{webhookGroup_uuid}
requires authentication

Delete a webhook group from your company

RateLimit (60/min)

Headers

Authorization
Example:
Bearer {YOUR_API_KEY}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

webhookGroup_uuid
string

uuid of the corresponding webhook group

Example:
74eacbcb-dcb1-354c-90e3-74d1463c43cc
Example request:
curl --request DELETE \
    "https://api.routelogic.io/api/v2/webhookGroups/74eacbcb-dcb1-354c-90e3-74d1463c43cc" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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
https://api.routelogic.io
/api/v2/webhookEvents
requires authentication

Headers

Authorization
Example:
Bearer {YOUR_API_KEY}
Content-Type
Example:
application/json
Accept
Example:
application/json

Query Parameters

filters
object
filters.status_failed
boolean

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

Example:
1
filters.limit
integer

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

Example:
69
filters.page
integer

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

Example:
60

Response Fields

Example request:
curl --request GET \
    --get "https://api.routelogic.io/api/v2/webhookEvents?filters[status_failed]=1&filters[limit]=69&filters[page]=60" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "uuid": "c48b3fbc-9b5b-49a2-b83e-8a15f69defb7",
            "webhook_url": "https://test.com/webhook/",
            "event_data": {
                "data": {
                    "note": null,
                    "tags": [],
                    "type": "delivery",
                    "uuid": "9fba29e6-e5a9-45c6-8c0b-d691cee408b3",
                    "end_time": "17:00:00",
                    "recurring": null,
                    "created_at": "2025-08-26T14:39:17.000000Z",
                    "start_time": "08:00:00",
                    "updated_at": "2025-08-26T14:39:17.000000Z",
                    "delivery_date": "2025-08-26",
                    "external_link": null,
                    "used_capacity": 0,
                    "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": "Eol6I4",
                    "track_and_trace_link": "http://localhost/tr/j0COhCryec7I",
                    "pending_payment_amount": 0,
                    "delivery_duration_minutes": 0,
                    "notification_template_uuid": null
                },
                "type": "task_created",
                "timestamp": "2025-08-26T16:39:17+02:00"
            },
            "response_status": 200,
            "created_at": "2025-08-26T14:39:17.000000Z",
            "updated_at": "2025-08-26T14:39: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
https://api.routelogic.io
/api/v2/webhookEvents/{webhookEvent_uuid}
requires authentication

Headers

Authorization
Example:
Bearer {YOUR_API_KEY}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

webhookEvent_uuid
string

uuid of the corresponding webhook event

Example:
2379190d-ee3c-3113-8432-a92a3db64e4b

Response Fields

Example request:
curl --request GET \
    --get "https://api.routelogic.io/api/v2/webhookEvents/2379190d-ee3c-3113-8432-a92a3db64e4b" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "uuid": "c48b3fbc-9b5b-49a2-b83e-8a15f69defb7",
        "webhook_url": "https://test.com/webhook/",
        "event_data": {
            "data": {
                "note": null,
                "tags": [],
                "type": "delivery",
                "uuid": "9fba29e6-e5a9-45c6-8c0b-d691cee408b3",
                "end_time": "17:00:00",
                "recurring": null,
                "created_at": "2025-08-26T14:39:17.000000Z",
                "start_time": "08:00:00",
                "updated_at": "2025-08-26T14:39:17.000000Z",
                "delivery_date": "2025-08-26",
                "external_link": null,
                "used_capacity": 0,
                "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": "Eol6I4",
                "track_and_trace_link": "http://localhost/tr/j0COhCryec7I",
                "pending_payment_amount": 0,
                "delivery_duration_minutes": 0,
                "notification_template_uuid": null
            },
            "type": "task_created",
            "timestamp": "2025-08-26T16:39:17+02:00"
        },
        "response_status": 200,
        "created_at": "2025-08-26T14:39:17.000000Z",
        "updated_at": "2025-08-26T14:39: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
https://api.routelogic.io
/api/v2/webhookEvents/{webhookEvent_uuid}/resend
requires authentication

Headers

Authorization
Example:
Bearer {YOUR_API_KEY}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

webhookEvent_uuid
string

uuid of the corresponding webhook event

Example:
fef5e025-d330-35ba-9e58-3e0f9523d7ef
Example request:
curl --request POST \
    "https://api.routelogic.io/api/v2/webhookEvents/fef5e025-d330-35ba-9e58-3e0f9523d7ef/resend" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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
https://api.routelogic.io
/api/v2/webhookEvents/resend-all-failed
requires authentication

Headers

Authorization
Example:
Bearer {YOUR_API_KEY}
Content-Type
Example:
application/json
Accept
Example:
application/json
Example request:
curl --request POST \
    "https://api.routelogic.io/api/v2/webhookEvents/resend-all-failed" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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
https://api.routelogic.io
/api/v2/templates
requires authentication

Get collection of templates

RateLimit (16/min)

Headers

Authorization
Example:
Bearer {YOUR_API_KEY}
Content-Type
Example:
application/json
Accept
Example:
application/json

Response Fields

Example request:
curl --request GET \
    --get "https://api.routelogic.io/api/v2/templates" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "uuid": "9fba29e6-baf4-4ee3-ab63-749151bad637",
            "identifier": "dJTwMONdRRnG8avw",
            "title": "Standaard e-mail en SMS notificatie voor bezorgen",
            "default": true,
            "default_pickup": false
        },
        {
            "uuid": "9fba29e6-beda-4ba0-b176-0b4311d94a06",
            "identifier": "rHv9aPEr1YnLGlgd",
            "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
https://api.routelogic.io
/api/v2/returnablePackagingTypes
requires authentication

Get collection of returnable packaging types

RateLimit (16/min)

Headers

Authorization
Example:
Bearer {YOUR_API_KEY}
Content-Type
Example:
application/json
Accept
Example:
application/json

Response Fields

Example request:
curl --request GET \
    --get "https://api.routelogic.io/api/v2/returnablePackagingTypes" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "uuid": "9fba29e6-d2e9-4bd5-81fa-97a759cb33f6",
            "type": "Pallet"
        },
        {
            "uuid": "9fba29e6-d3f5-452d-b89f-d93765eb6801",
            "type": "Container"
        },
        {
            "uuid": "9fba29e6-d4bf-47bd-ad9f-7bceba1c71c3",
            "type": "Crate"
        },
        {
            "uuid": "9fba29e6-f886-4f0a-8b25-1037d6d588da",
            "type": "box"
        },
        {
            "uuid": "9fba29e7-0a21-423c-85c4-b56d35e585b8",
            "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
https://api.routelogic.io
/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}
Content-Type
Example:
application/json
Accept
Example:
application/json

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:
2025-08-26
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:
2025-08-26
filters.limit
integer

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

Example:
54
filters.page
integer

Must be at least 1.

Example:
72

Response Fields

Example request:
curl --request GET \
    --get "https://api.routelogic.io/api/v2/schedules?filters[from_date]=2025-08-26&filters[to_date]=2025-08-26&filters[limit]=54&filters[page]=72" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "uuid": "8b2b8790-4ab3-48d2-8271-bcda490e5321",
            "date": "2025-08-26",
            "description": "Example Schedule 1",
            "total_travel_time": 0,
            "total_distance": 0,
            "notifications_send": false,
            "schedule_vehicles": {
                "data": [
                    {
                        "uuid": "9fba29e6-faf1-4f53-aea2-36213b3cde54",
                        "start_time": "08:00:00",
                        "end_time": "10:00:00",
                        "started_at": "2025-08-26 08:03:00",
                        "finished_at": "2025-08-26 10:02:00",
                        "total_travel_time": 0,
                        "total_distance": 1850,
                        "vehicle": {
                            "uuid": "9fba29e6-dac1-47e6-981a-976b02356216",
                            "licence_plate": "LAvIzhpZj",
                            "description": "Van 1"
                        },
                        "user": {
                            "uuid": "9fba29e6-e1bd-498c-a869-a314d4299ed4",
                            "name": "Jaylen Heathcote",
                            "public_name": "Jaylen Heathcote"
                        },
                        "visits": {
                            "data": [
                                {
                                    "uuid": "9fba29e6-fbb6-4bf7-8305-2b68d1300e84",
                                    "type": "task",
                                    "order_index": 0,
                                    "delivery_time": "09:00:00",
                                    "eta_start": "08:25",
                                    "eta_end": "09:25",
                                    "task": {
                                        "uuid": "9fba29e6-e5a9-45c6-8c0b-d691cee408b3",
                                        "type": "delivery",
                                        "external_identifier": "RLW7p9RHYsqi",
                                        "external_reference": null,
                                        "note": null,
                                        "pending_payment_amount": 0,
                                        "external_link": null,
                                        "track_and_trace_link": "http://localhost/tr/j0COhCryec7I",
                                        "delivery_from_date": null,
                                        "delivery_date": "2025-08-26",
                                        "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": "2025-08-26T14:39:18.000000Z",
                                        "created_at": "2025-08-26T14:39:17.000000Z",
                                        "tags": [],
                                        "notification_template_uuid": null,
                                        "return_task_uuid": null,
                                        "address": {
                                            "street": "7740 Adrain Track",
                                            "house_number": "6669",
                                            "house_number_extension": null,
                                            "postal_code": "56650",
                                            "city": "Mikelmouth",
                                            "latitude": 5.4321,
                                            "longitude": 5.4321,
                                            "address_line": "7740 Adrain Track 6669",
                                            "full_address_line": "7740 Adrain Track 6669, 56650, Mikelmouth",
                                            "country": {
                                                "iso_code": "NL",
                                                "description": "Nederland"
                                            }
                                        },
                                        "customer": {
                                            "name": "Kirk Stiedemann",
                                            "email": null,
                                            "phone_number": null
                                        },
                                        "shipment_steps": null
                                    },
                                    "schedule_date": "2025-08-25T22:00:00.000000Z",
                                    "address": {
                                        "street": "7740 Adrain Track",
                                        "house_number": "6669",
                                        "house_number_extension": null,
                                        "postal_code": "56650",
                                        "city": "Mikelmouth",
                                        "latitude": 5.4321,
                                        "longitude": 5.4321,
                                        "address_line": "7740 Adrain Track 6669",
                                        "full_address_line": "7740 Adrain Track 6669, 56650, Mikelmouth",
                                        "country": {
                                            "iso_code": "NL",
                                            "description": "Nederland"
                                        }
                                    },
                                    "scanned_codes": {
                                        "data": [
                                            {
                                                "type": "task_code",
                                                "code_uuid": "9fba29e6-f775-4020-b7be-dbb706810ed7",
                                                "scanned_count": 1
                                            },
                                            {
                                                "type": "schedule_visit_code",
                                                "code_uuid": "9fba29e7-06fb-4b7b-b3b3-977ed0ab149f",
                                                "scanned_count": 1
                                            }
                                        ]
                                    },
                                    "returnable_packaging": {
                                        "data": [
                                            {
                                                "uuid": "9fba29e7-0b1d-4671-b234-2ce33bf581fc",
                                                "count": -2,
                                                "returnable_packaging_type": {
                                                    "uuid": "9fba29e7-0a21-423c-85c4-b56d35e585b8",
                                                    "type": "pallets"
                                                }
                                            }
                                        ]
                                    },
                                    "status": {
                                        "status_identifier": "delivered"
                                    },
                                    "signature": "OWZiYTI5ZTYtZmJiNi00YmY3LTgzMDUtMmI2OGQxMzAwZTg0",
                                    "files": {
                                        "data": [
                                            {
                                                "type": "image",
                                                "key": "RGk1aUZPeVJ2bUUzcGR6dg"
                                            }
                                        ]
                                    }
                                }
                            ]
                        }
                    }
                ]
            }
        }
    ],
    "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
https://api.routelogic.io
/api/v2/schedules/{schedule_uuid}
requires authentication

Get a single schedule by its uuid

RateLimit (60/min)

Headers

Authorization
Example:
Bearer {YOUR_API_KEY}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

schedule_uuid
string
required

string The UUID of the schedule

Example:
bc107a0f-e00d-33c9-85e7-94d978b8b726

Response Fields

Example request:
curl --request GET \
    --get "https://api.routelogic.io/api/v2/schedules/bc107a0f-e00d-33c9-85e7-94d978b8b726" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "uuid": "8b2b8790-4ab3-48d2-8271-bcda490e5321",
        "date": "2025-08-26",
        "description": "Example Schedule 1",
        "total_travel_time": 0,
        "total_distance": 0,
        "notifications_send": false,
        "schedule_vehicles": {
            "data": [
                {
                    "uuid": "9fba29e6-faf1-4f53-aea2-36213b3cde54",
                    "start_time": "08:00:00",
                    "end_time": "10:00:00",
                    "started_at": "2025-08-26 08:03:00",
                    "finished_at": "2025-08-26 10:02:00",
                    "total_travel_time": 0,
                    "total_distance": 1850,
                    "vehicle": {
                        "uuid": "9fba29e6-dac1-47e6-981a-976b02356216",
                        "licence_plate": "LAvIzhpZj",
                        "description": "Van 1"
                    },
                    "user": {
                        "uuid": "9fba29e6-e1bd-498c-a869-a314d4299ed4",
                        "name": "Jaylen Heathcote",
                        "public_name": "Jaylen Heathcote"
                    },
                    "visits": {
                        "data": [
                            {
                                "uuid": "9fba29e6-fbb6-4bf7-8305-2b68d1300e84",
                                "type": "task",
                                "order_index": 0,
                                "delivery_time": "09:00:00",
                                "eta_start": "08:25",
                                "eta_end": "09:25",
                                "task": {
                                    "uuid": "9fba29e6-e5a9-45c6-8c0b-d691cee408b3",
                                    "type": "delivery",
                                    "external_identifier": "RLW7p9RHYsqi",
                                    "external_reference": null,
                                    "note": null,
                                    "pending_payment_amount": 0,
                                    "external_link": null,
                                    "track_and_trace_link": "http://localhost/tr/j0COhCryec7I",
                                    "delivery_from_date": null,
                                    "delivery_date": "2025-08-26",
                                    "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": "2025-08-26T14:39:18.000000Z",
                                    "created_at": "2025-08-26T14:39:17.000000Z",
                                    "tags": [],
                                    "notification_template_uuid": null,
                                    "return_task_uuid": null,
                                    "address": {
                                        "street": "7740 Adrain Track",
                                        "house_number": "6669",
                                        "house_number_extension": null,
                                        "postal_code": "56650",
                                        "city": "Mikelmouth",
                                        "latitude": 5.4321,
                                        "longitude": 5.4321,
                                        "address_line": "7740 Adrain Track 6669",
                                        "full_address_line": "7740 Adrain Track 6669, 56650, Mikelmouth",
                                        "country": {
                                            "iso_code": "NL",
                                            "description": "Nederland"
                                        }
                                    },
                                    "customer": {
                                        "name": "Kirk Stiedemann",
                                        "email": null,
                                        "phone_number": null
                                    },
                                    "shipment_steps": null
                                },
                                "schedule_date": "2025-08-25T22:00:00.000000Z",
                                "address": {
                                    "street": "7740 Adrain Track",
                                    "house_number": "6669",
                                    "house_number_extension": null,
                                    "postal_code": "56650",
                                    "city": "Mikelmouth",
                                    "latitude": 5.4321,
                                    "longitude": 5.4321,
                                    "address_line": "7740 Adrain Track 6669",
                                    "full_address_line": "7740 Adrain Track 6669, 56650, Mikelmouth",
                                    "country": {
                                        "iso_code": "NL",
                                        "description": "Nederland"
                                    }
                                },
                                "scanned_codes": {
                                    "data": [
                                        {
                                            "type": "task_code",
                                            "code_uuid": "9fba29e6-f775-4020-b7be-dbb706810ed7",
                                            "scanned_count": 1
                                        },
                                        {
                                            "type": "schedule_visit_code",
                                            "code_uuid": "9fba29e7-06fb-4b7b-b3b3-977ed0ab149f",
                                            "scanned_count": 1
                                        }
                                    ]
                                },
                                "returnable_packaging": {
                                    "data": [
                                        {
                                            "uuid": "9fba29e7-0b1d-4671-b234-2ce33bf581fc",
                                            "count": -2,
                                            "returnable_packaging_type": {
                                                "uuid": "9fba29e7-0a21-423c-85c4-b56d35e585b8",
                                                "type": "pallets"
                                            }
                                        }
                                    ]
                                },
                                "status": {
                                    "status_identifier": "delivered"
                                },
                                "signature": "OWZiYTI5ZTYtZmJiNi00YmY3LTgzMDUtMmI2OGQxMzAwZTg0",
                                "files": {
                                    "data": [
                                        {
                                            "type": "image",
                                            "key": "RGk1aUZPeVJ2bUUzcGR6dg"
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                }
            ]
        }
    }
}
{
    "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
https://api.routelogic.io
/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
Accept
Example:
application/json

URL Parameters

schedule_uuid
string
required
Example:
8b2b8790-4ab3-48d2-8271-bcda490e5321

Body Parameters

Example request:
curl --request POST \
    "https://api.routelogic.io/api/v2/schedules/8b2b8790-4ab3-48d2-8271-bcda490e5321/send-notifications" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"types\": [
        \"email\"
    ]
}"
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"
}

Beta Appointments


POST api/v2/beta/appointments/availability

POST
https://api.routelogic.io
/api/v2/beta/appointments/availability

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request:
curl --request POST \
    "https://api.routelogic.io/api/v2/beta/appointments/availability" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": {
        \"latitude\": 49277673.281,
        \"longitude\": 25586.99,
        \"tags\": [
            \"ecrnwwiytjqdhbdyzfouwowc\"
        ],
        \"delivery_duration_minutes\": 5,
        \"start_date\": \"2080-08-17\",
        \"end_date\": \"2070-05-29\",
        \"used_capacity\": 25,
        \"used_capacity_2\": 4,
        \"used_capacity_3\": 17,
        \"type\": \"pickup\"
    }
}"

POST api/v2/beta/appointments

POST
https://api.routelogic.io
/api/v2/beta/appointments

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request:
curl --request POST \
    "https://api.routelogic.io/api/v2/beta/appointments" \
    --header "Content-Type: application/json" \
    --header "Accept: 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\": false,
    \"used_capacity\": 10.5,
    \"used_capacity_2\": 5.25,
    \"used_capacity_3\": 2.75,
    \"notification_template_uuid\": \"123e4567-e89b-12d3-a456-426614174000\",
    \"customer\": \"accusantium\",
    \"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
    }
}"

Files

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


GET File

GET
https://api.routelogic.io
/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}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

key
string
required

The key of the related image

Example:
Y2DAi383qkBcm
Example request:
curl --request GET \
    --get "https://api.routelogic.io/api/v2/file/Y2DAi383qkBcm" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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": "2025-08-26T16:39:19+02:00",
    "data": {
        "uuid": "9fba29e6-e5a9-45c6-8c0b-d691cee408b3",
        "type": "delivery",
        "external_identifier": "Eol6I4",
        "external_reference": null,
        "note": null,
        "pending_payment_amount": 0,
        "external_link": null,
        "track_and_trace_link": "http:\/\/localhost\/tr\/j0COhCryec7I",
        "delivery_from_date": null,
        "delivery_date": "2025-08-26",
        "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": "2025-08-26T14:39:17.000000Z",
        "created_at": "2025-08-26T14:39: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": "2025-08-26T16:39:19+02:00",
    "data": {
        "uuid": "9fba29e6-e5a9-45c6-8c0b-d691cee408b3",
        "type": "delivery",
        "external_identifier": "Eol6I4",
        "external_reference": null,
        "note": null,
        "pending_payment_amount": 0,
        "external_link": null,
        "track_and_trace_link": "http:\/\/localhost\/tr\/j0COhCryec7I",
        "delivery_from_date": null,
        "delivery_date": "2025-08-26",
        "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": "2025-08-26T14:39:17.000000Z",
        "created_at": "2025-08-26T14:39: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": "2025-08-26T16:39:19+02:00",
    "data": {
        "uuid": "9fba29e6-e5a9-45c6-8c0b-d691cee408b3",
        "type": "delivery",
        "external_identifier": "Eol6I4",
        "external_reference": null,
        "note": null,
        "pending_payment_amount": 0,
        "external_link": null,
        "track_and_trace_link": "http:\/\/localhost\/tr\/j0COhCryec7I",
        "delivery_from_date": null,
        "delivery_date": "2025-08-26",
        "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": "2025-08-26T14:39:17.000000Z",
        "created_at": "2025-08-26T14:39: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": "2025-08-26T16:39:19+02:00",
    "data": {
        "uuid": "9fba29e6-fbb6-4bf7-8305-2b68d1300e84",
        "type": "task",
        "order_index": 0,
        "delivery_time": "09:00:00",
        "eta_start": "08:25",
        "eta_end": "09:25",
        "task": {
            "uuid": "9fba29e6-e5a9-45c6-8c0b-d691cee408b3",
            "type": "delivery",
            "external_identifier": "Eol6I4",
            "external_reference": null,
            "note": null,
            "pending_payment_amount": 0,
            "external_link": null,
            "track_and_trace_link": "http:\/\/localhost\/tr\/j0COhCryec7I",
            "delivery_from_date": null,
            "delivery_date": "2025-08-26",
            "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": "2025-08-26T14:39:17.000000Z",
            "created_at": "2025-08-26T14:39:17.000000Z",
            "tags": [],
            "notification_template_uuid": null,
            "return_task_uuid": null,
            "address": {
                "street": "7740 Adrain Track",
                "house_number": "6669",
                "house_number_extension": null,
                "postal_code": "56650",
                "city": "Mikelmouth",
                "latitude": 5.4321,
                "longitude": 5.4321,
                "address_line": "7740 Adrain Track 6669",
                "full_address_line": "7740 Adrain Track 6669, 56650, Mikelmouth",
                "country": {
                    "iso_code": "NL",
                    "description": "Nederland"
                }
            },
            "customer": {
                "name": "Kirk Stiedemann",
                "email": null,
                "phone_number": null
            },
            "shipment_steps": null
        },
        "schedule_date": "2025-08-25T22:00:00.000000Z",
        "status": {
            "status_identifier": "delivered"
        },
        "signature": "OWZiYTI5ZTYtZmJiNi00YmY3LTgzMDUtMmI2OGQxMzAwZTg0",
        "files": {
            "data": [
                {
                    "type": "image",
                    "key": "RGk1aUZPeVJ2bUUzcGR6dg"
                }
            ]
        },
        "schedule_uuid": "8b2b8790-4ab3-48d2-8271-bcda490e5321"
    }
}

internal_note_created

This event is send when an internal note has been created

{
    "type": "internal_note_created",
    "timestamp": "2025-08-26T16:39:19+02:00",
    "data": {
        "message": "This is an example message. Drivers use this to communicate with their managers",
        "visit": {
            "uuid": "9fba29e6-fbb6-4bf7-8305-2b68d1300e84",
            "type": "task",
            "order_index": 0,
            "delivery_time": "09:00:00",
            "eta_start": "08:25",
            "eta_end": "09:25",
            "task": {
                "uuid": "9fba29e6-e5a9-45c6-8c0b-d691cee408b3",
                "type": "delivery",
                "external_identifier": "RLW7p9RHYsqi",
                "external_reference": null,
                "note": null,
                "pending_payment_amount": 0,
                "external_link": null,
                "track_and_trace_link": "http:\/\/localhost\/tr\/j0COhCryec7I",
                "delivery_from_date": null,
                "delivery_date": "2025-08-26",
                "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": "2025-08-26T14:39:18.000000Z",
                "created_at": "2025-08-26T14:39:17.000000Z",
                "tags": [],
                "notification_template_uuid": null,
                "return_task_uuid": null,
                "address": {
                    "street": "7740 Adrain Track",
                    "house_number": "6669",
                    "house_number_extension": null,
                    "postal_code": "56650",
                    "city": "Mikelmouth",
                    "latitude": 5.4321,
                    "longitude": 5.4321,
                    "address_line": "7740 Adrain Track 6669",
                    "full_address_line": "7740 Adrain Track 6669, 56650, Mikelmouth",
                    "country": {
                        "iso_code": "NL",
                        "description": "Nederland"
                    }
                },
                "customer": {
                    "name": "Kirk Stiedemann",
                    "email": null,
                    "phone_number": null
                },
                "shipment_steps": null
            },
            "schedule_date": "2025-08-25T22:00:00.000000Z",
            "status": {
                "status_identifier": "delivered"
            },
            "signature": "OWZiYTI5ZTYtZmJiNi00YmY3LTgzMDUtMmI2OGQxMzAwZTg0",
            "files": {
                "data": [
                    {
                        "type": "image",
                        "key": "RGk1aUZPeVJ2bUUzcGR6dg"
                    }
                ]
            }
        }
    }
}

schedule_calculated

This event is sent everytime a schedule has been calculated

{
    "type": "schedule_calculated",
    "timestamp": "2025-08-26T16:39:19+02:00",
    "data": {
        "uuid": "8b2b8790-4ab3-48d2-8271-bcda490e5321",
        "date": "2025-08-26",
        "description": "Example Schedule 1",
        "total_travel_time": 0,
        "total_distance": 0,
        "notifications_send": false,
        "schedule_vehicles": {
            "data": [
                {
                    "uuid": "9fba29e6-faf1-4f53-aea2-36213b3cde54",
                    "start_time": "08:00:00",
                    "end_time": "10:00:00",
                    "started_at": "2025-08-26 08:03:00",
                    "finished_at": "2025-08-26 10:02:00",
                    "total_travel_time": 0,
                    "total_distance": 1850,
                    "vehicle": {
                        "uuid": "9fba29e6-dac1-47e6-981a-976b02356216",
                        "licence_plate": "LAvIzhpZj",
                        "description": "Van 1"
                    },
                    "visits": {
                        "data": [
                            {
                                "uuid": "9fba29e6-fbb6-4bf7-8305-2b68d1300e84",
                                "type": "task",
                                "order_index": 0,
                                "delivery_time": "09:00:00",
                                "task": {
                                    "uuid": "9fba29e6-e5a9-45c6-8c0b-d691cee408b3",
                                    "external_identifier": "RLW7p9RHYsqi"
                                },
                                "task_uuid": "9fba29e6-e5a9-45c6-8c0b-d691cee408b3",
                                "schedule_date": "2025-08-25T22:00:00.000000Z",
                                "status": {
                                    "status_identifier": "delivered"
                                },
                                "signature": "OWZiYTI5ZTYtZmJiNi00YmY3LTgzMDUtMmI2OGQxMzAwZTg0",
                                "files": {
                                    "data": [
                                        {
                                            "type": "image",
                                            "key": "RGk1aUZPeVJ2bUUzcGR6dg"
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                }
            ]
        }
    }
}

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": "2025-08-26T16:39:19+02:00",
    "data": {
        "uuid": "8b2b8790-4ab3-48d2-8271-bcda490e5321",
        "date": "2025-08-26",
        "description": "Example Schedule 1",
        "total_travel_time": 0,
        "total_distance": 0,
        "notifications_send": false,
        "first_notification": true,
        "schedule_vehicles": {
            "data": [
                {
                    "uuid": "9fba29e6-faf1-4f53-aea2-36213b3cde54",
                    "start_time": "08:00:00",
                    "end_time": "10:00:00",
                    "started_at": "2025-08-26 08:03:00",
                    "finished_at": "2025-08-26 10:02:00",
                    "total_travel_time": 0,
                    "total_distance": 1850,
                    "vehicle": {
                        "uuid": "9fba29e6-dac1-47e6-981a-976b02356216",
                        "licence_plate": "LAvIzhpZj",
                        "description": "Van 1"
                    },
                    "user": {
                        "uuid": "9fba29e6-e1bd-498c-a869-a314d4299ed4",
                        "name": "Jaylen Heathcote",
                        "public_name": "Jaylen Heathcote"
                    },
                    "visits": {
                        "data": [
                            {
                                "uuid": "9fba29e6-fbb6-4bf7-8305-2b68d1300e84",
                                "type": "task",
                                "order_index": 0,
                                "delivery_time": "09:00:00",
                                "eta_start": "08:25",
                                "eta_end": "09:25",
                                "task": {
                                    "uuid": "9fba29e6-e5a9-45c6-8c0b-d691cee408b3",
                                    "type": "delivery",
                                    "external_identifier": "RLW7p9RHYsqi",
                                    "external_reference": null,
                                    "note": null,
                                    "pending_payment_amount": 0,
                                    "external_link": null,
                                    "track_and_trace_link": "http:\/\/localhost\/tr\/j0COhCryec7I",
                                    "delivery_from_date": null,
                                    "delivery_date": "2025-08-26",
                                    "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": "2025-08-26T14:39:18.000000Z",
                                    "created_at": "2025-08-26T14:39:17.000000Z",
                                    "tags": [],
                                    "notification_template_uuid": null,
                                    "return_task_uuid": null,
                                    "address": {
                                        "street": "7740 Adrain Track",
                                        "house_number": "6669",
                                        "house_number_extension": null,
                                        "postal_code": "56650",
                                        "city": "Mikelmouth",
                                        "latitude": 5.4321,
                                        "longitude": 5.4321,
                                        "address_line": "7740 Adrain Track 6669",
                                        "full_address_line": "7740 Adrain Track 6669, 56650, Mikelmouth",
                                        "country": {
                                            "iso_code": "NL",
                                            "description": "Nederland"
                                        }
                                    },
                                    "customer": {
                                        "name": "Kirk Stiedemann",
                                        "email": null,
                                        "phone_number": null
                                    },
                                    "shipment_steps": null
                                },
                                "schedule_date": "2025-08-25T22:00:00.000000Z",
                                "status": {
                                    "status_identifier": "delivered"
                                },
                                "signature": "OWZiYTI5ZTYtZmJiNi00YmY3LTgzMDUtMmI2OGQxMzAwZTg0"
                            }
                        ]
                    }
                }
            ]
        }
    }
}