POST
/
dispatch
/
orders
cURL
curl --request POST \
  --url https://api.gorodeo.app/api/v1/dispatch/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "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"
}'
{
  "id": "00000000-0000-0000-0000-000000000000"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Create a new order for a site, to deliver to customer

​
customer
object
required

Details about who to deliver the order to.

​
deliverBy
string<timestamp>
required

(RFC 3339) Max. time by which the order must be delivered to the customer.

Example:

"2024-12-12T16:00:00.000Z"

​
deliverTo
object
required

Details about where to deliver the order.

​
externalId
string
required

An ID identifying the order. Utilize this to link an order with relevant data in your system. This detail will be visible within the driver app.

Example:

"1234567890"

​
siteId
string
required

Unique identifier used by our Partners to reference a site or location.

Example:

"00000000-0000-0000-0000-000000000000"

​
ageVerification
object

Flag to indicate this delivery requires ID check (minimum age).

Response

Order response

​
id
string

Unique identifier for the order within Rodeo.

Example:

"00000000-0000-0000-0000-000000000000"