Push an Order

This endpoint is used to push a new order to the external POS.

FAQ

  • If there is a discount for an item, the discounted amount will be reflected at the item level, and the value is assigned to order.item.price.discountAmount attribute. This value is a total of the discounts for an item, based on the quantity.

  • The Sum of the item level discounts plus order level discounts will be reflected in the order.payment.discounts.amount attribute.

Examples:

Scenario 1: Order with both item level and separate order level discount. The payment.discount value is a total of the item discounts and includes the order discount as well.

Sample payload.

Scenario 2: Order with order level discount. Item level discount values are set to 0.

Sample payload

Scenario 3: Order with order item level discount. Sum of the item level discounts are equal to the value in payment.discount value.

Sample payload

Please note that not all order channels support item-level discount.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Unique identifier for the order, provided by GrubTech.

string

Generated Grubtech invoice number for the order

string
required

Store id for the order. this id will provided by ... to identify the store

string

Grubtech menu ID specific to the order

string
required

displayable friendly five charactor ID, used by stores and couriers to identify the order

brand
object
required
kitchen
object
required
scheduledOrder
object
string
enum
required

Type of an order

Allowed:
string

Instructions from an Eater/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 should be non null

customer
object
required

The details of the person who is placing the order.

items
array of objects
required
items*
payment
object
required

payment information related to an order

source
object
required

Order source information

string
required

Order status

string

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

Responses

204

No Content

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json