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)

Order Definitions

▶ See Order Definitions
{
            "_created": "2023-01-18T20:15:21.929000Z",
            "_updated": "2023-01-18T20:21:25.084265Z",
            "_id": "63c8535**********256e64c",
            "account": "63c8535**********256e64c",
            "channelOrderId": "e61dd270-8f07-4462-b577-a95190d59c55",
            "channelOrderKey": "a95190d59c55",
            "channelOrderDisplayId": "9c55",
            "posId": "",
            "posReceiptId": "",
            "posLocationId": "",
            "location": "63c8873**********892e33c",
            "channelLink": "63c8535**********399e61f",
            "status": 1,
            "statusHistory": [
              {
                "timeStamp": "2023-01-18T20:15:21.948000Z",
                "status": 4,
                "response": "",
                "source": 2
              },
              {
                "timeStamp": "2023-01-18T20:15:21.949000Z",
                "status": 1,
                "response": "",
                "source": 5
              }
            ],
            "packaging": {
              "includeCutlery": false
            },
            "by": "",
            "orderType": 2,
            "channel": 1,
            "pos": 10000,
            "rating": [],
            "pickupTime": "2023-01-18T20:24:22Z",
            "deliveryIsAsap": true,
            "courier": {
              "firstName": "",
              "phoneNumber": "",
              "deliveryBy": "",
              "status": 83
            },
            "courierUpdateHistory": [
              {
                "status": 72,
                "received": "2023-01-18T20:15:21.949000Z",
                "courier": {},
                "arrivalTime": "2023-01-18T20:24:22Z",
                "source": 5
              }
            ],
            "customer": {
              "name": "",
              "phoneNumber": "",
              "email": ""
            },
            "deliveryAddress": {},
            "orderIsAlreadyPaid": true,
            "taxes": [],
            "taxTotal": 181,
            "taxRemitted": 128,
            "payment": {
              "amount": 2281,
              "type": 3,
              "due": 0,
              "rebate": 0
            },
            "note": "",
            "items": [
              {
                "plu": "P112",
                "name": "Ice Tea",
                "sortOrder": 0,
                "price": 600,
                "quantity": 1,
                "productType": 1,
                "remark": "",
                "subItems": []
              },
              {
                "plu": "P105",
                "name": "Noodles ",
                "sortOrder": 0,
                "price": 1500,
                "quantity": 1,
                "productType": 1,
                "remark": "",
                "subItems": [
                  {
                    "plu": "M_P105T",
                    "name": "Tofu",
                    "sortOrder": 0,
                    "price": 0,
                    "quantity": 1,
                    "productType": 2,
                    "subItems": []
                  },
                  {
                    "plu": "M_P105M",
                    "name": "Mild",
                    "sortOrder": 0,
                    "price": 0,
                    "quantity": 1,
                    "productType": 2,
                    "subItems": []
                  }
                ]
              }
            ],
            "decimalDigits": 2,
            "numberOfCustomers": 0,
            "channelOrderRawId": "63c85*********464fa09eb",
            "channelOrderHistoryRawIds": [],
            "serviceCharge": 0,
            "deliveryCost": 0,
            "bagFee": 0,
            "tip": 0,
            "driverTip": 0,
            "discountTotal": 0,
            "discounts": [],
            "capacityUsages": [],
            "recent": true,
            "resolvedBy": "",
            "brandId": "61958**********16cde1980",
            "timezone": "US/Pacific",
            "date": 20230119
          }
{
    "orderId": "6238592552b28ed8717***2",
    "status": 20,
    "timeStamp": "2022-03-21T10:58:53.133931Z",
    "reason": "",
    "channelOrderId": "TEST164786***5",
    "location": "61c881cf**a46a3c23c***",
    "isIgnoredPOSStatus": false
}