Submit Order

post

https://virtserver.swaggerhub.com/GrubTech/grubtech-grocery-integration-apis/1.0.0/{applicationId}/orders

The /{applicationId}/orders endpoint is designed to enable external systems, such as third-party ordering platforms, to send order information to the Grubtech platform. This integration ensures that orders placed on external systems are seamlessly pushed to Grubtech, allowing for centralized order management, processing, and fulfillment.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

applicationId

string

required

Application ID provided by GrubTech to identify the integration

Body Params

string

required

Unique ID for the order from the aggregator platform.

storeId

string

required

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

displayId

string

required

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

type

string

enum

required

Type of an order

Allowed:

currencyCode

string

required

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

instructions

string

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

delivery

object

Delivery details of the order. If the requested party is planning to do the delivery by the Grubtech end, delivery information is mandatory.

customer

object

The details of the person who is placing the order.If the order type equals to DELIVERY_BY_MERCHANT or PICK_UP, then this object is required.

items

array of objects

required

items*

archivedItems

array of objects

archivedItems

payment

object

required

payment information related to an order

scheduledOrder

object

Scheduled order details. This object should be included only if the order is expected to be prepared at a future time.

status

string

enum

required

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

Allowed:

placedAt

string

required

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

Responses

204Successful response OK

400Bad request

500Internal server error