API Reference
API Reference

/orders/{{orderId}}

A PUT request to the /ordersendpoint allows you to update the order details for the orderIdspecified in the request url.

[
    {
        "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"
    }
]

Here are a set of fields that can be part of the request body when making a call to the update endpoint.

📘

PUT v PATCH

Please note that this is a PUT request, rather than a PATCH, which means any user mutable field that's not part of the request will be assigned a null value.

FieldsTypeUser Mutable
nameStringYes
locationsLocation objectYes
phoneStringYes
emailStringYes
durationNumberYes
loadNumberYes
instructionsStringYes
timeWindowsTimeWindow objectYes
customerOrderNumberStringYes
Language
Authorization
Header
Click Try It! to start a request and see the response here!