API Reference
API Reference

A POST request to the /orders endpoint allows you to upload an array of orders into Routific under a specific workspace.

[
    {
        "name": "Metro",
        "locations": [
            {
                "address": "510 W 8th Ave, Vancouver, BC V5Z 1C5",
                "latitude":  49.26413,
                "longitude": -123.11499
            }
        ],
        "phone": "+16043215582",
        "email": "[email protected]",
        "duration": 600,
        "load": 1,
        "instructions": "Deliver at loading bay at the back of the building.",
        "timeWindows": [
            {
                "startTime": "9:00",
                "endTime": "10:00"
            }
        ],
        "customerOrderNumber": "external-1"
    }
]

The body of the payload accepts an array of order entities, where each order consists of following properties and attributes.

FieldsTypeRequired
nameStringNo
locationsLocation objectYes
phoneStringNo
emailStringNo
durationNumberNo
loadNumberNo
instructionsStringNo
timeWindowsTimeWindow objectNo
customerOrderNumberStringNo

📘

Finding your workspaceId

We currently do not have an endpoint to query workspaces under your account. So, instead you can find the workspaceId under which you'd like to upload your order through the url of our dispatcher app.

For example, in this url https://beta.routific.com/workspace/615862/routes?date=2024-09-27&view=scheduled-list the workspaceId is 615862

Language
Authorization
Header
Click Try It! to start a request and see the response here!