Reporting Endpoints
Why using Reporting Endpoints?
Partners are using Reporting Endpoint to collect orders data from Deliverect.
- The data (JSON format) is sent to a specified endpoint in real time.
- Based on specific triggers where a status is above e.g. RECEIVED is status 2
Endpoint types:
- ‘New Order’ (full order content)
- ‘Status Update’ (status change info)
Where does the data go and how it can be used?
When a webhook is set to receive data, it can go anywhere and can be used for:
- KDS
- Data warehousing
- Reporting / BI / Custom Dashboards tools
- Delivery manager
- Stock management system
- Where polling isn’t available for data, we can send via webhook
How do you setup the Webhooks?
Please provide your webhook URLs to our Onboarding / Customer Success team so they can add it for you.
The webhook URLs can be added either at:
- Account Level : (receiving order data for the account and for all channels)
- Channel Level : (receiving order data only for a specific channel)
{
"_id": "6238592552b28ed8717bc7***",
"_created": "2022-03-21T10:53:25.835208Z",
"_updated": "2022-03-21T10:53:25.972756Z",
"_etag": "",
"account": "6******d8ca0b1e7c2c3e2c6d",
"channelOrderId": "TEST1647860***",
"channelOrderDisplayId": "T860005",
"posLocationId": "",
"location": "61c881cfc***6a3c23cdbbe5",
"channelLink": "***81d0c2a46a3c23cdbbf1",
"status": 1,
"statusHistory": [{
"timeStamp": "2022-03-21T10:53:25.997335Z",
"status": 4,
"response": "",
"source": 2
}, {
"timeStamp": "2022-03-21T10:53:26.001060Z",
"status": 1,
"response": "",
"source": 5
}, {
"status": 3,
"source": 5,
"timeStamp": "2022-03-21T10:53:26.395145Z",
"response": ""
}],
"packaging": {
"includeCutlery": false
},
"channelStatusHistory": [],
"by": "Deliverect",
"orderType": 2,
"channel": 1,
"pos": 9999,
"rating": [],
"pickupTime": "2022-03-21T10:53:25Z",
"deliveryTime": "2022-03-21T10:53:25Z",
"deliveryIsAsap": true,
"courier": {
"deliveryBy": "restaurant"
},
"customer": {
"name": "",
"companyName": "",
"phoneNumber": "",
"email": "",
"note": ""
},
"deliveryAddress": {
"street": "The Krook",
"streetNumber": "4",
"postalCode": "8888KL",
"city": "Gent",
"source": "4 The Krook 8888KL Gent",
"extraAddressInfo": ""
},
"orderIsAlreadyPaid": true,
"taxes": [{
"name": "taxes",
"taxClassId": 0,
"total": 126
}],
"taxTotal": 126,
"payment": {
"amount": 1526,
"type": 0,
"due": 0,
"rebate": 0
},
"note": "This is a test order",
"items": [{
"_id": "6238592652b28ed8717bc737",
"plu": "MGAD1",
"name": "Vegetarian Combo Deal",
"sortOrder": 0,
"price": 1400,
"quantity": 1,
"productType": 1,
"isInternal": false,
"subItems": [{
"_id": "61af429662573c74524d6d56",
"plu": "VEG-01###",
"name": "Vegetables Sayur Lodeh",
"sortOrder": 0,
"price": 0,
"quantity": 1,
"productType": 1,
"isInternal": false,
"subItems": []
}, {
"_id": "61af429662573c74524d6d57",
"plu": "VEG-02###",
"name": "Vegetables Mix Tumisan",
"sortOrder": 0,
"price": 0,
"quantity": 1,
"productType": 1,
"isInternal": false,
"subItems": []
}, {
"_id": "61af429662573c74524d6d83",
"plu": "SRice-02###",
"name": "Fried Yellow Rice",
"sortOrder": 0,
"price": 0,
"quantity": 1,
"productType": 1,
"isInternal": false,
"subItems": [{
"_id": "61af429662573c74524d6d6b",
"plu": "SC-01",
"name": "Sate Sauce",
"sortOrder": 0,
"price": 0,
"quantity": 1,
"productType": 2,
"isInternal": false,
"subItems": []
}]
}, {
"_id": "61af429662573c74524d6d42",
"plu": "DRN-02###",
"name": "Coca Cola Zero Sugar",
"sortOrder": 0,
"price": 0,
"quantity": 1,
"productType": 1,
"isInternal": false,
"subItems": []
}]
}],
"decimalDigits": 2,
"numberOfCustomers": 1,
"channelOrderRawId": "62385925f5f4db95755e33bd",
"channelOrderHistoryRawIds": [],
"serviceCharge": 0,
"deliveryCost": 0,
"bagFee": 0,
"tip": 0,
"driverTip": 0,
"discountTotal": 0,
"historyDriverUpdates": [],
"capacityUsages": [],
"trackPOSId": false,
"recent": true,
"resolvedBy": "",
"brandId": "614318d8ca0b1e7c2c3e2c6c",
"testOrder": true,
"timezone": "Europe/Amsterdam",
"date": 20220321,
"orderValidations": []
}
{
"orderId": "6238592552b28ed8717***2",
"status": 20,
"timeStamp": "2022-03-21T10:58:53.133931Z",
"reason": "",
"channelOrderId": "TEST164786***5",
"location": "61c881cf**a46a3c23c***",
"isIgnoredPOSStatus": false
}
Updated 2 months ago
Did this page help you?