Get Bulk Order History

get https://api.staging.grubtech.io/order-api/orders

The Get Bulk Order History endpoint is designed to retrieve historical order data in bulk. This endpoint is ideal for fetching extensive order records over a specified period, enabling you to access past orders for analysis, reporting, or record-keeping purposes. This is especially useful for tracking customer trends, reviewing operational performance, and ensuring data completeness across external systems.

Query Params

fromDate

string

required

Starting date of the date range. The date should be in ISO 8601 standard, which also has a time and time zone component.

toDate

string

required

End date of the date range. The date should be in ISO 8601 standard, which also has time and time zone component.

status

string

Status of the orders to be retrieved by a partner. If the status is set to 'COMPLETED, CANCELED' or null, the API returns completed and cancelled orders.

page

integer

required

The page the resultset needs to extract. If the resultset has more than one page, the user can set the page number in the URL to fetch only that results page. Note:- user should set the page as '0' since the URL for the next resultset is included in the response body.

size

integer

required

Maximum size of the result for one page. This value can be set up to 10,000.*

locationIds

array of strings

Grubtech location ID to filter the orders.

locationIds

Responses

Response body

object

page

object

Details about the requested result set pagination.

size

integer

Maximum results per page

totalElements

integer

Total number of results

totalPages

integer

Total number of pages

number

integer

Current page number

_links

object

Details about the links that retrieve requested data.

first

object

self

object

prv

object

last

object

_embedded

object

List of orders within the date range.

orders

array of objects

orders

object

string

A unique identifier representing an order on the order platform.

displayId

string

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

sequenceNo

string

brand

object

Brand details of the partner related to a specific order.

kitchen

object

Kitchen details of the partner related to a specific order.

type

string

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

instructions

string

Instructions from a customer regarding the order preparation.

delivery

object

Contains delivery details for the order. If delivery is from GrubTech end, this field should not be null and must include all necessary information related to the delivery.

customer

object

The details of the person who is placing the order.

items

array of objects

items

object

string

Unique identifying string for the item provided by the store.

internalItemId

string

Unique identifier for the item on the Grubtech platform, consistent across all stores.

name

string

Name of the item

quantity

integer

Quantity of the items

price

object

Pricing information of the order which contains the unit price, taxes, discounts, and total price

modifiers

array of objects

modifiers

object

string

Internal reference of the modifier, provided through the menu

internalModifierId

string

Unique identifer for the modifier on Grubtech platform that distinguishes it across all stores.

name

string

Name of the modifier

quantity

integer

number of modifiers

price

object

Pricing information of the order which contains the unit price, taxes, discounts, and total price

payment

object

Payment information related to an order

source

object

Detailed information about the order source

status

string

Order status which indicates the status of the order.

placedAt

string

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

scheduledOrder

boolean

Indicates whether this order is scheduled or not.

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.staging.grubtech.io/order-api/orders \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response with requested order list.

400Error response when the server could not understand the request due to an invalid syntax or structure.

500A generic error response that indicates a problem with the web server.