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}

Request

Base URL
https://api.staging.grubtech.io/order-api
URL
https://api.staging.grubtech.io/order-api/orders/{orderId}
Auth
API key in header X-API-KEY

Path parameters

orderIdstring required

Unique identifier representing an order on the order platform.

Response

Successful response with the requested order.

idstring

A unique identifier representing an order on the order platform.

displayIdstring

Human-readable short order ID, to be used by stores and couriers to identify the order.

sequenceNostring

typestring

Type of an order. Indicates how the order will be served to the customer. Possible values are DELIVERY_BY_FOOD_AGGREGATOR, DELIVERY_BY_RESTAURANT, DINE_IN and PICK_UP

instructionsstring

Instructions from a customer regarding the order preparation.

statusstring

Order status which indicates the status of the order.

placedAtstring

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

scheduledOrderboolean

Indicates whether this order is scheduled or not.

Example response

{
  "instructions": "Please use minimal tomato and add extra lemon juice to the tabbouleh. Thank you!",
  "delivery": {
    "location": {
      "address": "E34, Al BarshaAl Barsha South, Dubai"
    }
  },
  "items": [
    {
      "price": {
        "unitPrice": {
          "currencyCode": "AED",
          "formattedAmount": "AED 12.50"
        },
        "discountAmount": {
          "currencyCode": "AED",
          "formattedAmount": "AED 12.50"
        },
        "taxAmount": {
          "currencyCode": "AED",
          "formattedAmount": "AED 12.50"
        },
        "totalPrice": {
          "currencyCode": "AED",
          "formattedAmount": "AED 12.50"
        }
      },
      "modifiers": [
        {
          "price": {
            "unitPrice": {
              "currencyCode": "AED",
              "formattedAmount": "AED 12.50"
            },
            "discountAmount": {
              "currencyCode": "AED",
              "formattedAmount": "AED 12.50"
            },
            "taxAmount": {
              "currencyCode": "AED",
              "formattedAmount": "AED 12.50"
            },
            "totalPrice": {
              "currencyCode": "AED",
              "formattedAmount": "AED 12.50"
            }
          }
        }
      ]
    }
  ],
  "payment": {
    "charges": {
      "subTotal": {
        "currencyCode": "AED",
        "formattedAmount": "AED 12.50"
      },
      "total": {
        "currencyCode": "AED",
        "formattedAmount": "AED 12.50"
      },
      "deliveryFee": {
        "currencyCode": "AED",
        "formattedAmount": "AED 12.50"
      }
    },
    "additionalCharges": [
      {
        "price": {
          "unitPrice": {
            "currencyCode": "AED",
            "formattedAmount": "AED 12.50"
          },
          "discountAmount": {
            "currencyCode": "AED",
            "formattedAmount": "AED 12.50"
          },
          "taxAmount": {
            "currencyCode": "AED",
            "formattedAmount": "AED 12.50"
          },
          "totalPrice": {
            "currencyCode": "AED",
            "formattedAmount": "AED 12.50"
          }
        },
        "tax": [
          {
            "amount": {
              "currencyCode": "AED",
              "formattedAmount": "AED 12.50"
            }
          }
        ]
      }
    ],
    "discounts": [
      {
        "amount": {
          "currencyCode": "AED",
          "formattedAmount": "AED 12.50"
        }
      }
    ],
    "tax": [
      {
        "amount": {
          "currencyCode": "AED",
          "formattedAmount": "AED 12.50"
        }
      }
    ],
    "settlements": [
      {
        "amount": {
          "currencyCode": "AED",
          "formattedAmount": "AED 12.50"
        },
        "notes": "10 AED redeemed using 100 loyalty points"
      }
    ]
  },
  "placedAt": "2020-08-02T09:23:54.723Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.