Fetch order

A GET request to the /orders endpoint with an orderUuidin the request url allows you to query the current details of an order within Routific.

Note that the orderUuid required to fetch an order is generated by Routific and is originally returned in the response body of creating orders.

Request URL

get https://planning-service.beta.routific.com/v1/orders/{orderUuid}

Request Payload

//none

Sample Response Payload

{
    "name": "Metro",
    "email": "[email protected]",
    "phone": "16043215582",
    "load": 1,
    "duration": 600, //in seconds
    "instructions": "Deliver at loading bay at the back of the building.",
    "createdOn": "2023-06-13T23:50:54.758Z",
    "uuid": "9a3e5d87-a448-4125-a165-2b8a689322ab",
    "customerOrderNumber": "external-1",
    "routificOrderNumber": "ORD-1655",
    "timeWindows": [
        {
            "startTime": "09:00",
            "endTime": "10:00"
        }
    ],
    "locations": [
        {
            "address": "510 W 8th Ave, Vancouver, BC V5Z 1C5, Canada",
            "latitude": 49.26413,
            "longitude": -123.11499,
            "timezone": "America/Vancouver",
            "status": "Validated"
        }
    ],
    "workspaceId": 1,
    "status": "missed",
    "deliveryMissedReason": "nobody home!",
    "deliveryTime": "2023-06-14T23:50:54.758Z",
    "proofOfDelivery": {
        "signature": "iVBORw0KGgoAAAANSUhEUgAAAfYAAABxCAYAAAAnKYFoAAAAAXNSR0IArs4c6QAAAARzQklUCAgICHwIZIgAACAA....",
        "photos": [
            "/v1/orders/a09d0e3b-4a3a-4598-9f8f-5fb5350faae5/photos/57c7387e-5daa-4f17-8924-b53ab41e6"
        ]
    }
}

Here's a description of payload attributes returned in the response:

Fields	Type	Description
name	String	Customer name for the order
locations	Location object	Address and coordinates of the delivery address. If the lat/lng was adjusted on the Routific UI, this will fetch the latest pin location.
phone	String	Phone number of the customer
email	String	Email of the customer
duration	Number	Expected time spend at location in seconds. This is the input, not the actual time spent. For actual durations, you can Fetch route timelines.
load	Number	A number used to account for how much of a route's capacity is utilized by the order
instructions	String	Delivery instructions for the order, such buzzer number, etc.
timeWindows	TimeWindow object	A time range within which the order must of serviced.
createdOn	String	DateTime field of when the order was created in Routific's system
workspaceId	Integer	The ID of the workspace associated with the order.
uuid	String	An internal ID used to identify an order within Routific's system
customerOrderNumber	String	The external ID or customer order number.
routificOrderNumber	String	The internal Routific order number (as displayed in the UI).
status	String	The current status of the order. Possible values: not_scheduled, scheduled, delivered, missed.
deliveryMissedReason	String	The reason why the delivery was missed (if applicable).
deliveryTime	String	The timestamp of the delivery attempt or completion.
proofOfDelivery	ProofOfDelivery object	ProofOfDelivery object contains data related to any signatures or photos captured as delivery proof
signature	String	A base64 encoded string of signature captured for the delivery in PNG format.
photos	Array	All photos captured as delivery proof are returned as an array of urls to download each image using the Fetch photos endpoint.