Rodeo provides a REST API to manage your orders. If you encounter any issues while going through these steps, please reach out to your Rodeo Point of Contact or Account Manager.

​
API credentials

After you have created your account, you will be provided with an “API token” by your Rodeo Point of Contact to use the API.

​
High-level Integration Flow

This guide is intended as a reference for the high-level sample flow.

​
Create Test Orders Using Rodeo API Call

To create an order using the Rodeo API via curl: 
curl -X POST 'https://api.gorodeo.app/api/v1/dispatch/orders' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "ageVerification": {
    "required": true
  },
  "customer": {
    "name": "John Doe",
    "phone": "+441234567890"
  },
  "deliverBy": "2024-12-12T16:00:00.000Z",
  "deliverTo": {
    "address": "22 Park Ln, London W1K 1BE, UK",
    "coordinates": {
      "latitude": 51.5055,
      "longitude": -0.15038
    }
  },
  "externalId": "1234567890",
  "siteId": "00000000-0000-0000-0000-000000000000"
}'
You will get a response like below: 
{
  "id": "f9211b83-9c8c-4b01-a0f8-395389485b07",
}
With this, you have successfully created a test order. Descriptions for all of the fields in the request and response can be found in the Create Order documentation.

​
Track Delivery Using tracking_url

Once you send the Create Order request, you can easily track the progress of the order throughout each stage of the delivery using the provided tracking_url in the response. We strongly encourage you to use the tracking_url value returned in the response of the Create Order request. Please do not manipulate or change this URL, as this URL may be subject to changes. Here’s an example of what you’ll see when you open the tracking URL:

Example of order tracking