API Reference

Update order

Update the details of an existing order in your Routific workspace

A PUT request to the /ordersendpoint allows you to update the order details for the orderIdspecified in the request url. It uses the same format as the Create orders endpoint, so you can reference that page for accepted fields.

📘

Updating Orders

At the moment, we only allow orders with a status of not_scheduledto be updated. Attempting to update orders with any other status will result in a 400 update error response.


Request URL

put https://planning-service.beta.routific.com/v1/orders/

❗️

This is a PUT request

Make sure to include everything in the body because if you don't any previous values assigned to a field will be reset to NULL.
For example, if you've previous assigned a phone number to the order upon creation, and during this update request if you haven't included the phone number field with its original value, then the original value for the field will be cleared.


Sample Request Payload

{
  "name": "Metro",
  "locations": [
    {
      "address": "510 W 8th Ave, Vancouver, BC V5Z 1C5",
      "latitude": 49.26413,
      "longitude": -123.11499
    }
  ],
  "duration": 600, //in seconds
  "load": 1,
  "instructions": "Deliver at loading bay at the back of the building.",
  "customerOrderNumber": "external-2"
}

Sample Response Payload

{
  "uuid": "6a8e071a-4ee0-470b-982e-b24ed1d1b90c",
  "name": "Metro",
  "load": 1,
  "duration": 600, //in seconds
  "instructions": "Deliver at loading bay at the back of the building.",
  "createdOn": "2025-03-12T16:07:07.135Z",
  "routificOrderNumber": "ORD-12356",
  "customerOrderNumber": "external-2",
  "timeWindows": [],
  "locations": [
    {
      "address": "510 W 8th Ave, Vancouver, BC V5Z 1C5",
      "latitude": 49.26413,
      "longitude": -123.11499,
      "timezone": "America/Vancouver",
      "status": "Validated"
    }
  ],
  "workspaceId": 693240,
  "status": "not_scheduled"
}