📘

The Orders API allows you to quickly and easily create, update, and manage orders in bulk.

A Merchant API key is required to access the endpoint. Users with Manager permissions can generate and provide the key.

Group Jobs

Orders API allows you to quickly and easily create orders in bulk.
If you want to use this endpoint you will need Merchant API key. Users with Manager permissions can generate and provide it to you.

Merchant API key looks like: a46dfc0e-4b59-448d-8a41-0745af6458ff.

By using Merchant API key you can:

• create jobs in bulk;
• get job's list created with this API key or get all jobs if key is Master Key;
• get order's details by external_id;
• assign driver to job by ID;
• update job;
• terminate job.

---

We use the following job's status codes, which all directly relate to the Radaro statuses that are visible to manager:

• pending for Pending;
• not_assigned for Not Assigned;
• assigned for Assigned;
• pickup for Pick up;
• picked_up for Picked up;
• in_progress for In Progress;
• delivered for Completed;
• confirmed for Confirmed;
• failed for Failed

---

All dates are in ISO-8601 date format where the time value is the time in Greenwich, England, or UTC time.

🚧

For job's delivery intervals we support either delivery_interval field or deliver_after and deliver_before pair.

The example of jobs creation using deliver_after and deliver_before fields as delivery interval borders can be found below in the corresponding section.

❗️

Important: You can create jobs only with 'pending', 'assigned' or 'not_assigned' statuses.

Notes for jobs with 'pending' status:

• Your administrator must enable using 'pending' status and delivery zones.
• All new jobs must have 'delivery_zone'.
• If you not provide 'delivery_zone', 'deliver_address' must have 'post_code' corresponding one of the existing delivery zone.
• The 'phone' field in 'customer' is required for jobs with 'pending' status.
• Notification will be sent to the customer after creating a job with 'pending' status.
• In order to "confirm" pending job change status from 'pending' to 'not_assigned'.

Cases for 'driver' and 'status' fields:

• If you provide 'driver' for job, then job's status is 'assigned' and you can not provide it.
• If you not provide this both fields, job use status 'not_assigned'
• If you not provide 'driver' for 'assigned' job, or when you provide 'driver' for 'not_assigned' job, you will get an exception.
• For other statuses you must use other methods.

---

Detailed Job Info

📘

This endpoint allows you to get/update all the information about a selected job, also you can delete the job.

🚧

It can be useful to check the status of the job, although we recommend to use webhook events for that purpose.

There is additional query parameter lookup_field that allows you to specify field name for job lookup, possible values are:
external_id (default) and order_id. Parameter is optional.

Parameters