Delivery info
Delivery states for courier apps, carrying the task being delivered, the tracker carrying it, and the driver.
Delivery info is what a delivery or courier application needs to follow a job in progress: the task or checkpoint being delivered, the tracker carrying it, and the driver. Only tasks and checkpoints whose start date has already passed and whose status is assigned or arrived are searched.
Both operations return three composite objects. task is a task object, tracker is a tracker object, and restrictions is the tariff restrictions object that user/get_tariff_restrictions returns.
Besides the standard user session, both operations accept the special DELIVERY session type.
API actions
API base path: /delivery.
Return enough to track one delivery: the task or checkpoint, the tracker carrying it, and who is driving.
Only tasks and checkpoints whose start date has already passed and whose status is assigned or arrived are searched.
Besides an ordinary user session, this call accepts the special delivery session type, which is what a recipient-facing delivery tracking page uses.
Several records can share an external_id. This call returns only one: a task in preference to a checkpoint, and the earliest by start date. Use delivery/list to get them all.
Also accepts GET with the same parameters as query-string values.
Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.
External ID of the task. 1 to 100 characters, trimmed of surrounding whitespace.
The delivery
true if request finished successfully.
trueMaster account ID the task belongs to.
First name of the employee assigned to the task, or null.
Middle name of the employee assigned to the task, or null.
Last name of the employee assigned to the task, or null.
Label of the vehicle assigned to the task, or null.
Estimated time of arrival in seconds, or null when it could not be calculated. Derived by routing from the tracker's last known location to the task location.
Bad request. The response body carries the API-level error code in status.code. Validation failures also include an errors array naming each offending parameter.
Error 236: the tracker's plan does not include the delivery tracking feature.
Error 208: the tracker exists but is blocked, normally because its tariff ended.
Error response object
POST /v2/delivery/read HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 22
{
"external_id": "text"
}{
"success": true,
"task": {
"id": 1,
"user_id": 1,
"tracker_id": null,
"location": {
"lat": 1,
"lng": 1,
"address": "text",
"radius": 1
},
"label": "text",
"description": "text",
"creation_date": "text",
"from": "2026-08-24 09:00:00",
"to": "2026-08-24 09:00:00",
"external_id": null,
"status": "unassigned",
"status_change_date": "text",
"max_delay": 1,
"min_stay_duration": 1,
"min_arrival_duration": 1,
"arrival_date": null,
"stay_duration": 1,
"origin": "manual",
"tags": [
1
],
"type": "task",
"form": {
"id": 1,
"label": "text",
"description": "text",
"fields": [
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"created": "text",
"submit_in_zone": true,
"task_id": null,
"checkin_id": null,
"tracker_id": null,
"template_id": null,
"template_version": null,
"values": null,
"submitted": null,
"submit_location": {
"lat": 1,
"lng": 1,
"address": "text"
}
},
"form_template_id": 1,
"fields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"files": [
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}
]
},
"tracker": {
"id": 123456,
"label": "tracker label",
"clone": true,
"group_id": 167,
"avatar_file_name": "text",
"source": {
"id": 234567,
"device_id": "9999999988888",
"model": "telfmb920",
"blocked": true,
"tariff_id": 345678,
"status_listing_id": null,
"creation_date": "2011-09-21",
"tariff_end_date": null,
"phone": null
}
},
"restrictions": {
"allowed_maps": [
"text"
]
},
"user_id": 1,
"first_name": null,
"middle_name": null,
"last_name": null,
"vehicle_label": null,
"estimated_time": null
}Errors
These errors come in addition to the general error codes:
201 - Not found in the database, when no task or checkpoint matches the given conditions.
Return every task and checkpoint matching an external ID, rather than the single best match delivery/read returns.
Only tasks and checkpoints whose start date has already passed and whose status is assigned or arrived are searched.
Besides an ordinary user session, this call accepts the special delivery session type, which is what a recipient-facing delivery tracking page uses.
Returns error 201 when nothing matches, rather than an empty list.
Also accepts GET with the same parameters as query-string values.
Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.
External ID of the task. 1 to 100 characters, trimmed of surrounding whitespace.
The deliveries
true if request finished successfully.
trueMaster account ID the tasks belong to.
Bad request. The response body carries the API-level error code in status.code. Validation failures also include an errors array naming each offending parameter.
Error 236: the tracker's plan does not include the delivery tracking feature.
Error 208: the tracker exists but is blocked, normally because its tariff ended.
Error response object
POST /v2/delivery/list HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 22
{
"external_id": "text"
}{
"success": true,
"list": [
{
"task": {
"id": 1,
"user_id": 1,
"tracker_id": null,
"location": {
"lat": 1,
"lng": 1,
"address": "text",
"radius": 1
},
"label": "text",
"description": "text",
"creation_date": "text",
"from": "2026-08-24 09:00:00",
"to": "2026-08-24 09:00:00",
"external_id": null,
"status": "unassigned",
"status_change_date": "text",
"max_delay": 1,
"min_stay_duration": 1,
"min_arrival_duration": 1,
"arrival_date": null,
"stay_duration": 1,
"origin": "manual",
"tags": [
1
],
"type": "task",
"form": {
"id": 1,
"label": "text",
"description": "text",
"fields": [
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"created": "text",
"submit_in_zone": true,
"task_id": null,
"checkin_id": null,
"tracker_id": null,
"template_id": null,
"template_version": null,
"values": null,
"submitted": null,
"submit_location": {
"lat": 1,
"lng": 1,
"address": "text"
}
},
"form_template_id": 1,
"fields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"files": [
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}
]
},
"tracker": {
"id": 123456,
"label": "tracker label",
"clone": true,
"group_id": 167,
"avatar_file_name": "text",
"source": {
"id": 234567,
"device_id": "9999999988888",
"model": "telfmb920",
"blocked": true,
"tariff_id": 345678,
"status_listing_id": null,
"creation_date": "2011-09-21",
"tariff_end_date": null,
"phone": null
}
},
"first_name": null,
"middle_name": null,
"last_name": null,
"vehicle_label": null,
"estimated_time": null
}
],
"user_id": 1,
"restrictions": {
"allowed_maps": [
"text"
]
}
}Errors
These errors come in addition to the general error codes:
201 - Not found in the database, when no task or checkpoint matches the given conditions.
Last updated
Was this helpful?