Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-2478177179.1 KB

Get Order History By ID

The Get Order History By ID endpoint in the API provides an efficient method for accessing order records, status, and other specific data associated with individual orders.

get/orders/{orderId}

Path parameters

orderIdstring required

Unique identifier representing an order on the order platform.

Response

Successful response with the requested order.

idstring required

Unique ID for the order from the aggregator platform.

storeIdstring required

Store ID is for identifying the relevant store of the order. This ID will be provided by either Grubtech or the aggregator.

displayIdstring required

Displayable friendly five-character ID, used by stores and couriers to identify the order easily

type'DELIVERY_BY_AGGREGATOR' | 'DELIVERY_BY_MERCHANT' | 'PICK_UP' required

Type of an order

currencyCodestring required

Applicable currency code for the menu. According to ISO-4217

instructionsstring

Instructions from the customer pertaining to the preparation of this order.

status'PLACED' | 'APPROVED' required

Order status. This will indicate the current status of the order

placedAtstring required

The time at which the order was placed, represented in ISO 8601 format.

Example response

{
  "id": "703546147070869504",
  "storeId": "a9f3ded6-c10b-4f17-ad42-5788e061b0a6",
  "displayId": "4212331",
  "currencyCode": "AED",
  "instructions": "Please readuce the bag count of the order",
  "delivery": {
    "pickupTime": "2021-01-01T09:23:54.723Z"
  },
  "archivedItems": [
    {
      "price": {
        "unitPrice": 1200,
        "discountAmount": 1200,
        "totalPrice": 1200
      },
      "amendItems": [
        {
          "quantity": 10
        }
      ]
    }
  ],
  "scheduledOrder": {
    "scheduledAt": "2020-08-02T09:23:54.723Z"
  },
  "placedAt": "2020-08-02T09:23:54.723Z"
}