Operation Definitions

Endpoints

POST /price

Use the Price Order operation to request subtotal, tax, and total prices for an order defined in an array of items.

In	Field Name	Type	Required	Description
header	`AUTHORIZATION`	string	Yes	The integrator token created previously
body	`body`	PriceOrderRequestBody	Yes	The Price Order request information

Responses

Code	Description	Schema
200	Success Response	PriceOrderResponseBody
306	Error Response. Price Order returns error responses to the callback URL. The code and message provide details about why the operation failed. See Error Codes for a complete list of codes and messages.

Code

Description

Schema

200

Success Response

PriceOrderResponseBody

306

Error Response.

Price Order returns error responses to the callback URL. The code and message provide details about why the operation failed. See Error Codes for a complete list of codes and messages.

Sample Error Response Body

{
  "partnerRequestId": "99999999-9999-9999-9999-999999999999",
  "partnerOrderId": "99999999-9999-9999-9999-999999999999",
  "errors": [
    {
      "code": 306,
      "message": "INVALID ORDER PAYMENT - VALUE IS LESS THAN TOTAL"
    }
  ]
}

POST /place

Use the Place Order operation to submit an order to Omni for processing. The subTotal, totalTaxes, and total amounts must be included in the request. These are obtained by using the Price Order operation. The taxes array and the items array that are returned by the Price Order operation in the Place Order request must also be included.

Place Order sets the order status based on the value of pickupLocation that was set in the request. If pickupLocation is set to "EatIn", "TakeOut", or "Delivery", the order status will be set to "Finalize" in the POS. If the pickupLocation is set to anything else, the order status will be set to "Hold". Use the Confirm Order operation to move the order to "Finalize" status.

In	Field Name	Type	Required	Description
header	`AUTHORIZATION`	string	Yes	An authorization token linked to the integrator's account
body	`body`	PlaceOrderRequestBody	Yes	The Place Order request information

Responses

Code	Description	Schema
200	Success Response	PlaceOrderResponseBody
306	Error Response. Place Order returns error responses to the callback URL. The code and message provide details about why the operation failed. See Error Codes for a complete list of codes and messages.

Code

Description

Schema

200

Success Response

PlaceOrderResponseBody

306

Error Response.

Place Order returns error responses to the callback URL. The code and message provide details about why the operation failed. See Error Codes for a complete list of codes and messages.

Sample Error Response Body

{
  "partnerRequestId": "99999999-9999-9999-9999-999999999999",
  "partnerOrderId": "99999999-9999-9999-9999-999999999999",
  "errors": [
    {
      "code": 306,
      "message": "INVALID ORDER PAYMENT - VALUE IS LESS THAN TOTAL"
    }
  ]
}

POST /stores/heartbeat

The Store Status operation returns information about whether the store is available to accept orders.

In	Field Name	Type	Required	Description
header	`AUTHORIZATION`	string	Yes	An authorization token linked to the integrator account
body	`body`	StoreStatusRequestBody	Yes	The Store Status request information

Responses

Code	Description	Schema
200	Success Response	StoreStatusResponseBody
306	Error Response. Store Status returns error responses to the callback URL. The code and message provide details about why the operation failed. See Error Codes for a complete list of codes and messages.

Code

Description

Schema

200

Success Response

StoreStatusResponseBody

306

Error Response.

Store Status returns error responses to the callback URL. The code and message provide details about why the operation failed. See Error Codes for a complete list of codes and messages.

Sample Error Response Body

{
  "partnerRequestId": "99999999-9999-9999-9999-999999999999",
  "partnerOrderId": "99999999-9999-9999-9999-999999999999",
  "errors": [
    {
      "code": 306,
      "message": "INVALID ORDER PAYMENT - VALUE IS LESS THAN TOTAL"
    }
  ]
}

POST /delivery/insert

Use the Insert Order operation to insert an order into the point of sale (POS) order queue with the status set to Hold. Orders on hold can be filled by the restaurant. Use the Confirm Order operation to move an order from hold status to finalize status and to set a pickup time if needed.

In	Field Name	Type	Required	Description
header	`AUTHORIZATION`	string	Yes	An authorization token linked to the integrator's account
body	`body`	InsertOrderRequestBody	Yes	The Insert Order request information

Responses

Code	Description	Schema
200	Success Response	InsertOrderResponseBody
306	Error Response. Error responses are returned to the callback URL. The code and message provide details about why the operation failed. See Error Codes for a complete list of codes and messages.

Code

Description

Schema

200

Success Response

InsertOrderResponseBody

306

Error Response.

Error responses are returned to the callback URL. The code and message provide details about why the operation failed. See Error Codes for a complete list of codes and messages.

Sample Error Response Body

{
  "partnerRequestId": "99999999-9999-9999-9999-999999999999",
  "partnerOrderId": "99999999-9999-9999-9999-999999999999",
  "errors": [
    {
      "code": 306,
      "message": "INVALID ORDER PAYMENT - VALUE IS LESS THAN TOTAL"
    }
  ]
}

POST /delivery/confirm

Use the Confirm Order operation to enter a new order with its status set to Finalize, or to move an order from Hold to Finalize.

Fulfillment of the order can be delayed by setting a value for the pickupTime attribute. The pickupTime value can be used to trigger the order being sent to the kitchen. If a value for pickupTime is not sent, the order will be available immediately, with the status set to Finalize.

In	Field Name	Type	Required	Description
header	`AUTHORIZATION`	string	Yes	An authorization token linked to the integrator's account
body	`body`	ConfirmOrderRequestBody	Yes	The Confirm Order request information

Responses

Code	Description	Schema
200	Success Response	ConfirmOrderResponseBody
306	Error Response. Error responses are returned to the callback URL. The code and message provide details about why the operation failed. See Error Codes for a complete list of codes and messages.

Code

Description

Schema

200

Success Response

ConfirmOrderResponseBody

306

Error Response.

Error responses are returned to the callback URL. The code and message provide details about why the operation failed. See Error Codes for a complete list of codes and messages.

Sample Error Response Body

{
  "partnerRequestId": "99999999-9999-9999-9999-999999999999",
  "partnerOrderId": "99999999-9999-9999-9999-999999999999",
  "errors": [
    {
      "code": 306,
      "message": "INVALID ORDER PAYMENT - VALUE IS LESS THAN TOTAL"
    }
  ]
}

POST /delivery/cancel

The Cancel Order operation removes the order from the point of sale (POS) order queue. An order cannot be canceled once its status is Finalize.

In	Field Name	Type	Required	Description
header	`AUTHORIZATION`	string	Yes	An authorization token linked to the integrator's account
body	`body`	CancelOrderRequestBody	Yes	The Cancel Order request information

Responses

Code	Description	Schema
200	Success Response	CancelOrderResponseBody
306	Error Response. Error responses are returned to the callback URL. The code and message provide details about why the operation failed. See Error Codes for a complete list of codes and messages.

Code

Description

Schema

200

Success Response

CancelOrderResponseBody

306

Error Response.

Error responses are returned to the callback URL. The code and message provide details about why the operation failed. See Error Codes for a complete list of codes and messages.

Sample Error Response Body

{
  "partnerRequestId": "99999999-9999-9999-9999-999999999999",
  "partnerOrderId": "99999999-9999-9999-9999-999999999999",
  "errors": [
    {
      "code": 306,
      "message": "INVALID ORDER PAYMENT - VALUE IS LESS THAN TOTAL"
    }
  ]
}

Data Models

PriceOrderRequestBody

Field Name	Type	Description
`partnerRequestId`	string	A unique identifier (UID) for the request and used to keep track of the request. The request ID is echoed in the response sent to the callback URL after the request has been processed.
`storeID`	string	The identifier for the store that fulfills the order
`brand`	string	The name of the store that fulfills the order. This is a unique brand identifier that must correspond to the name used by Genius for the customer's integration. Genius will provide this value.
`callbackUrl`	string	A unique URL generated for each request, which Omni uses to return the final response after the order has been processed
`order`	order Object	An object that contains the partner, pickup, item, customer, and payment information. The items list includes objects that define prices, descriptions, and additional information about the items placed with the order. See Destination Codes for an example of valid pickup location values.

order Object

Field Name	Type	Description
`partnerOrderId`	string	The partner order identifier
`pickupLocation`	string	The order pick up location such as "DriveThru"
`orderId`	string	The Genius `orderID` that was sent as part of the response when the order was created
`pickupTime`	string	Sending a `pickupTime` value defines the time at which the order status will be set to `Finalize`. This controls when the kitchen will first be able to fulfill the order. If a `pickupTime` value is not sent, the order will be available immediately.
`items`	items Array	The list of items for the items array
`fees`	fees Array	An array of fees that will be applied to the order
`customerName`	string	The customer identifier
`payment`	payment Object	The payment object information.

items Array

Field Name	Type	Description
`quantity`	number	The quantity of items in the order
`lineID`	string	The line identifier for the order item
`description`	string	The order item description
`plunum`	number	The reference number of the item
`isValueMeal`	boolean	The flag that indicates if an order is a value meal
`modifiers`	array	A list of modifiers for the order, if applicable

fees Array

Field Name	Type	Description
`name`	string	The name of the fee. This name must match the name associated with the fee's price look up (PLU).
`amount`	number	The amount of the fee to be applied
`quantity`	number	This should always be 1
`plunum`	number	The reference number of the fee

payment Object

Field Name	Type	Description
`plunum`	number	The reference number for the payment

Price Order Request Sample Code

Sample Request Body

{
    "partnerRequestId": "99999999-9999-9999-9999-999999999999",
    "storeId": "9999",
    "brand": "my-brand-name",
    "callbackUrl": "https://9999999.9999/8b865822-6183-4980-bc55-ce6eb7fb4b33",
    "order": {
        "partnerOrderId": "99999999-9999-9999-9999-999999999999",
        "pickupLocation": "DriveThru",
        "items": [
            {
                "quantity": 1,
                "lineId": "99999999999999999999999999999999",
                "description": "Reg Coke",
                "plunum": "999999",
                "isValueMeal": false,
                "modifiers": []
            }
        ],
        "fees": [
            {
                "name": "fee",
                "amount": 9.99,
                "quantity": 1,
                "plunum": "999999"
            }
        ],
        "customerName": "999999",
        "payment": {
            "plunum": "999999"
        }
    }
}

PriceOrderResponseBody

Field Name	Type	Description
`partnerRequestId`	string	The unique identifier (UID) for the request that was provided in the original request
`partnerOrderId`	string	The UID for the order that was provided in the original request
`requestType`	string	The request type
`posInfo`	posInfo Object	An object containing information about the type and version of the point of sale (POS) system that generated the request
`subTotal`	number	The total dollar amount of all of the items included with the order
`taxes`	taxes Array	An array of objects that contain a description, ID, and amount for each tax that is charged on the order. This array may list multiple taxes if more than one tax is applied with the order.
`totalTaxes`	number	The total amount of tax to be charged on the order. This value is based on the sum of taxes returned in the taxes array.
`total`	number	The total dollar amount to be charged for the order. This is the sum of the `subTotal` and the `totalTaxes` values.
`items`	items Array	An array of objects that define the items that are included on the order. The item objects include the item ID and price information. The line ID is the same value sent with the request. If a line ID is not sent with the request, Genius generates and returns a line ID that can be used to track the line items on the order. The modifiers array is an array of items that may be added to items included with the order.

posInfo Object

Field Name	Type	Description
`type`	string	The point of sale (POS) type
`version`	string	The POS version

taxes Array

Field Name	Type	Description
`description`	string	The tax description
`id`	string	The tax identifier
`amount`	number	The tax amount

Price Order Response Sample Code

Sample Response Body

{
  "partnerRequestId": "99999999-9999-9999-9999-999999999999",
  "partnerOrderId": "99999999-9999-9999-9999-999999999999",
  "requestType": "CALCULATETAX",
  "posInfo": {
    "type": "999999999",
    "version": "9.99.9"
  },
  "subTotal": 999,
  "taxes": [
    {
      "description": "10% TAX",
      "id": "99999999",
      "amount": 99
    }
  ],
  "totalTaxes": 99,
  "total": 999,
  "items": [
    {
      "lineId": "99999999999999999999999999999999",
      "plunum": "999999",
      "isValueMeal": false,
      "description": "Reg Coke",
      "quantity": 1,
      "price": 999,
      "modifiers": []
    }
  ]
}

PlaceOrderRequestBody

Field Name	Type	Description
`partnerRequestId`	string	A unique identifier (UID) for the request and used to keep track of the request. The request ID is echoed in the response sent to the callback URL once the request has been processed.
`storeID`	string	The identifier for the store that fulfills the order
`brand`	string	The name of the store that fulfills the order. This is a unique brand identifier that must correspond to the name used by Genius for the customer's integration. Genius will provide this value.
`callbackUrl`	string	A unique URL generated for each request, which Omni uses to return the final response after the order has been processed
`order`	order Object	An object that contains details about the order, including the partner, pickup, customer, item, payment, and price and tax calculation information. The `items` list includes the quantities, identifiers, descriptions, prices, and modifier details about each item on the order. The `taxes` list defines each of the taxes to be applied to the order.

Place Order Request Sample Code

Sample Request Body

{
    "partnerRequestId": "99999999-9999-9999-9999-999999999999",
    "storeId": "9999",
    "brand": "my-brand-name",
    "callbackUrl": "https://999999.9999/99999999-9999-9999-9999-999999999999",
    "order": {
        "partnerOrderId": "99999999-9999-9999-9999-999999999999",
        "pickupLocation": "DriveThru",
        "subTotal": 999,
        "taxes": [
            {
              "description": "10% TAX",
              "id": "99999999",
              "amount": 99
            }
        ],
        "fees": [
            {
                "name": "fee",
                "amount": 9.99,
                "quantity": 1,
                "plunum": "999999"
            }
        ],
        "totalTaxes": 99,
        "total": 999,
        "items": [
            {
                "quantity": 1,
                "lineId": "99999999999999999999999999999999",
                "description": "Reg Coke",
                "plunum": "999999",
                "price": 999,
                "isValueMeal": false,
                "modifiers": []
            }
        ],
        "customerName": "999999",
        "payment": {
            "plunum": "999999"
        }
    }
}

PlaceOrderResponseBody

Field Name	Type	Description
`partnerRequestId`	string	The unique identifier (UID) for the request that was provided in the original request
`partnerOrderId`	string	The UID for the order provided in the original request
`requestType`	string	The request type
`posInfo`	posInfo Object	An object containing information about the type and version of the point of sale (POS) system that generated the request
`orderId`	string	The Genius-generated identifier for the order
`subTotal`	number	The total dollar amount of all of the items included with the order
`taxes`	taxes Array	An array of objects that contain a description, ID, and amount for each tax that is charged on the order. This array may list multiple taxes if more than one tax is applied with the order.
`totalTaxes`	number	The total amount of tax to be charged on the order. This value is based on the sum of taxes returned in the taxes array.
`total`	number	The total dollar amount to be charged for the order
`items`	items Array	An array of objects that define the items that are included on the order. The item objects include item ID and price information.

Place Order Response Sample Code

Sample Response Body

{
  "partnerRequestId": "99999999-9999-9999-9999-999999999999",
  "partnerOrderId": "99999999-9999-9999-9999-999999999999",
  "requestType": "PlaceOrder",
  "posInfo": {
    "type": "999999999",
    "version": "9.99.9"
  },
  "orderId": "99999999-9999-9999-9999-999999999999999",
  "subTotal": 999,
  "taxes": [
    {
      "description": "10% TAX",
      "id": "99999999",
      "amount": 99
    }
  ],
  "totalTaxes": 99,
  "total": 999,
  "items": [
    {
      "lineId": "99999999999999999999999999999999",
      "plunum": "999999",
      "isValueMeal": false,
      "description": "Reg Coke",
      "quantity": 1,
      "price": 999,
      "modifiers": []
    }
  ]
}

StoreStatusRequestBody

Field Name	Type	Description
`brand`	string	The name of the store that will fulfill the order
`storeId`	string	The identifier for the store that fulfills the order
`callbackUrl`	string	A unique URL generated for each request, which Omni will use to return the final response after the request has been processed

Store Status Request Sample Code

Sample Request Body

{
    "brand": "99999",
    "storeId": "9999",
    "callbackUrl": "https://999999.9999/99999999-9999-9999-9999-999999999999"
}

StoreStatusResponseBody

Field Name	Type	Description
`partnerRequestId`	string	The unique identifier (UID) for the request that was provided in the original request
`storeStatus`	storeStatus Object	An object that defines the brand, store ID, and status for the location defined by the `storeId` submitted in the request. The `available` value is a boolean which defines whether the store is able to accept orders.

storeStatus Object

Field Name	Type	Description
`brand`	string	The name of the store that fulfills the order
`storeId`	string	The identifier for the store that fulfills the order
`available`	boolean	A boolean which defines whether the store is able to accept orders

Store Status Response Sample Code

Sample Response Body

{
  "partnerRequestId": null,
  "storeStatus": {
    "brand": "my-restaurant-name",
    "storeId": "9999",
    "available": true
  }
}

InsertOrderRequestBody

Field Name	Type	Description
`brand`	string	The name of the store that fulfills the order. This is a unique brand identifier that must correspond to the name used by Genius for the customer integration. Genius will provide this value.
`callbackUrl`	string	A unique URL generated for each request, which Omni uses to return the final response after the request has been processed
`order`	order Object	An object that contains the partner, pickup, item, customer, and payment information. The items list includes objects that define prices, descriptions, and additional information about the items placed with the order. See Destination Codes for an example of valid values for `pickupLocation`.
`partnerRequestId`	string	A unique identifier (UID) for the request and used to keep track of the request. The request ID is echoed in the response sent to the callback URL after the request has been processed.
`storeId`	string	The identifier for the store that fulfills the order

Insert Order Request Sample Code

Sample Request Body

{
    "brand" : "99",
    "callbackUrl" : "https://calbackURL.site/unique-string",
    "order" : {
        "customerName" : "Test",
        "subTotal": 999,
        "taxes": [
            {
                "description": "Tax (7.000%) TAX",
                "id": "99999999",
                "amount": 99
            }
        ],
        "totalTaxes": 99,
        "fees": [
            {
                "name": "fee",
                "amount": 9.99,
                "quantity": 1,
                "plunum": "999999"
            }
        ],
        "total": 99.99,
        "items": [
            {
                "lineId": "99999999999999999999999999999999",
                "plunum": "999999",
                "isValueMeal": true,
                "description": "Burger",
                "quantity": 1,
                "price": 999,
                "modifiers": [
                    {
                        "lineId": "99999999999999999999999999999999",
                        "plunum": "999999",
                        "isValueMeal": false,
                        "description": "Cheeseburger",
                        "quantity": 1,
                        "price": 0,
                        "modifiers": []
                    },
                    {
                        "lineId": "99999999999999999999999999999999",
                        "plunum": "99999",
                        "isValueMeal": false,
                        "description": "Fries",
                        "quantity": 1,
                        "price": 0,
                        "modifiers": []
                    },
                    {
                        "lineId": "99999999999999999999999999999999",
                        "plunum": "999999",
                        "isValueMeal": false,
                        "description": "COKE",
                        "quantity": 1,
                        "price": 0,
                        "modifiers": []
                    }
                ]
            }
        ],
        "partnerOrderId" : "99999999-9999-9999-9999-999999999999",
        "pickupLocation" : "DriveThru"
    },
    "partnerRequestId" : "99999999-9999-9999-9999-999999999999",
    "storeId" : "999999"
}

InsertOrderResponseBody

Field Name	Type	Description
`partnerRequestId`	string	The unique identifier (UID) for the request that was provided in the original request
`partnerOrderId`	string	The UID for the order that was provided in the original request
`requestType`	string
`posInfo`	posInfo Object	An object containing information about the type and version of the point of sale (POS) system that generated the request
`orderId`	string	The Genius-generated identifier for the order
`subTotal`	number	The total dollar amount of all of the items included with the order
`taxes`	taxes Array	An array of objects that contain a description, ID, and amount for each tax that is charged on the order. This array may list multiple taxes if more than one tax is applied with the order.
`totalTaxes`	number	The total amount of tax to be charged on the order. This value is based on the sum of taxes returned in the taxes array.
`total`	number	The total dollar amount to be charged for the order
`items`	items Array	An array of objects that define the items that are included on the order. The item objects include item ID and price information.

Insert Order Response Sample Code

Sample Response Body

{
  "partnerRequestId": "99999999-9999-9999-9999-999999999999",
  "partnerOrderId": "99999999-9999-9999-9999-999999999999",
  "requestType": "PlaceOrder",
  "posInfo": {
    "type": "999999999",
    "version": "9.99.9"
  },
  "orderId": "99999999-9999-9999-9999-999999999999|999",
  "subTotal": 999,
  "taxes": [
    {
      "description": "Tax (7.000%) TAX",
      "id": "99999999",
      "amount": 99
    }
  ],
  "totalTaxes": 99,
  "total": 999,
  "items": [
    {
      "lineId": "99999999999999999999999999999999",
      "plunum": "999999",
      "isValueMeal": true,
      "description": "Burger",
      "quantity": 1,
      "price": 999,
      "modifiers": [
        {
          "lineId": "99999999999999999999999999999999",
          "plunum": "9999999",
          "isValueMeal": false,
          "description": "Cheeseburger",
          "quantity": 1,
          "price": 0,
          "modifiers": []
        },
        {
          "lineId": "99999999999999999999999999999999",
          "plunum": "999999",
          "isValueMeal": false,
          "description": "Fries",
          "quantity": 1,
          "price": 0,
          "modifiers": []
        },
        {
          "lineId": "99999999999999999999999999999999",
          "plunum": "999999",
          "isValueMeal": false,
          "description": "COKE",
          "quantity": 1,
          "price": 0,
          "modifiers": []
        }
      ]
    }
  ]
}

ConfirmOrderRequestBody

Field Name	Type	Description
`brand`	string	The name of the store that fulfills the order. This is a unique brand identifier that must correspond to the name used by Genius for the integration. Genius will provide this value.
`callbackUrl`	string	A unique URL generated for each request, which Omni uses to return the final response after the request has been processed
`order`	order Object	An object that contains the partner, pickup, item, customer, and payment information. The items list includes objects that define prices, descriptions, and additional information about the items placed with the order. See Destination Codes for an example of valid pickup location values.
`partnerRequestId`	string	A unique identifier (UID) for the request and used to keep track of the request. The request ID is echoed in the response sent to the callback URL after the request has been processed.
`storeId`	string	The identifier for the store that fulfills the order

Confirm Order Request Sample Code

Sample Request Body

{
    "brand" : "999999",
    "callbackUrl" : "https://callbackURL.site/unique-string",
    "order" : {
        "customerName" : "Test",
        "subTotal": 999,
        "taxes": [
            {
                "description": "Tax (7.000%) TAX",
                "id": "999999",
                "amount": 54
            }
        ],
        "totalTaxes": 99,
        "total": 999,
        "items": [
            {
                "lineId": "99999999999999999999999999999999",
                "plunum": "999999",
                "isValueMeal": true,
                "description": "Burger",
                "quantity": 1,
                "price": 999,
                "modifiers": [
                    {
                        "lineId": "99999999999999999999999999999999",
                        "plunum": "999999",
                        "isValueMeal": false,
                        "description": "Cheeseburger",
                        "quantity": 1,
                        "price": 0,
                        "modifiers": []
                    },
                    {
                        "lineId": "99999999999999999999999999999999",
                        "plunum": "999999",
                        "isValueMeal": false,
                        "description": "Fries",
                        "quantity": 1,
                        "price": 0,
                        "modifiers": []
                    },
                    {
                        "lineId": "9999999999999999999999999999999",
                        "plunum": "999999",
                        "isValueMeal": false,
                        "description": "Coke",
                        "quantity": 1,
                        "price": 0,
                        "modifiers": []
                    }
                ]
            }
        ],
        "partnerOrderId" : "99999999-9999-9999-9999-999999999999",
        "pickupLocation" : "Delivery",
        "orderId": "99999999-9999-9999-9999-999999999999|999"
    },
    "partnerRequestId" : "99999999-9999-9999-9999-999999999999",
    "storeId" : "999999"
}

ConfirmOrderResponseBody

Field Name	Type	Description
`partnerRequestId`	string	The unique identifier (UID) for the request that was provided in the original request
`partnerOrderId`	string	The UID for the order that was provided in the original request
`requestType`	string	The request type
`posInfo`	posInfo Object	An object containing information about the type and version of the point of sale (POS) system that generated the request
`orderId`	string	The Genius-generated identifier for the order
`subTotal`	number	The total dollar amount of all of the items included with the order
`taxes`	taxes Array	An array of objects that contain a description, ID, and amount for each tax that is charged on the order. This array may list multiple taxes if more than one tax is applied with the order.
`totalTaxes`	number	The total amount of tax to be charged on the order. This value is based on the sum of taxes returned in the taxes array.
`total`	number	The total dollar amount to be charged for the order
`items`	items Array	An array of objects that define the items that are included on the order. The item objects include item ID and price information.

Confirm Order Response Sample Code

Sample Response Body

{
  "partnerRequestId": "99999999-9999-9999-9999-999999999999",
  "partnerOrderId": "99999999-9999-9999-9999-999999999999",
  "requestType": "ORDERUPDATE",
  "posInfo": {
    "type": "999999",
    "version": "9.99.9"
  },
  "orderId": "99999999-9999-9999-9999-999999999999|999",
  "subTotal": 999,
  "taxes": [
    {
      "description": "Tax (7.000%) TAX",
      "id": "999999",
      "amount": 99
    }
  ],
  "totalTaxes": 99,
  "total": 999,
  "items": [
    {
      "lineId": "99999999999999999999999999999999",
      "plunum": "999999",
      "isValueMeal": true,
      "description": "Burger",
      "quantity": 1,
      "price": 999,
      "modifiers": [
        {
          "lineId": "99999999999999999999999999999999",
          "plunum": "999999",
          "isValueMeal": false,
          "description": "Cheeseburger",
          "quantity": 1,
          "price": 0,
          "modifiers": []
        },
        {
          "lineId": "99999999999999999999999999999999",
          "plunum": "999999",
          "isValueMeal": false,
          "description": "Fries",
          "quantity": 1,
          "price": 0,
          "modifiers": []
        },
        {
          "lineId": "99999999999999999999999999999999",
          "plunum": "999999",
          "isValueMeal": false,
          "description": "Coke",
          "quantity": 1,
          "price": 0,
          "modifiers": []
        }
      ]
    }
  ]
}

CancelOrderRequestBody

Field Name	Type	Description
`brand`	string	The name of the store that fulfills the order. This is a unique brand identifier that must correspond to the name used by Genius for the integration. Genius will provide this value.
`callbackUrl`	string	A unique URL generated for each request, which Omni uses to return the final response after the request has been processed
`order`	order Object	An object that contains partner, pickup, item, customer, and payment information. The items list includes objects that define prices, descriptions, and additional information about the items placed with the order. See Destination Codes for an example of valid pickup location values.
`partnerRequestId`	string	A unique identifier (UID) for the request and used to keep track of the request. The request ID is echoed in the response sent to the callback URL after the request has been processed.
`storeId`	string	The identifier for the store that fulfills the order

Cancel Order Request Sample Code

Sample Request Body

{
    "brand" : "999999",
    "callbackUrl" : "https://callbackURL.site/unique-string",
    "order" : {
        "customerName" : "Test",
        "subTotal": 999,
        "taxes": [
            {
                "description": "Tax (7.000%) TAX",
                "id": "99999999",
                "amount": 99
            }
        ],
        "totalTaxes": 99,
        "total": 999,
        "items": [
            {
                "lineId": "99999999999999999999999999999999",
                "plunum": "999999",
                "isValueMeal": true,
                "description": "Burger",
                "quantity": 1,
                "price": 999,
                "modifiers": [
                    {
                        "lineId": "99999999999999999999999999999999",
                        "plunum": "999999",
                        "isValueMeal": false,
                        "description": "Cheeseburger",
                        "quantity": 1,
                        "price": 0,
                        "modifiers": []
                    },
                    {
                        "lineId": "99999999999999999999999999999999",
                        "plunum": "999999",
                        "isValueMeal": false,
                        "description": "Fries",
                        "quantity": 1,
                        "price": 0,
                        "modifiers": []
                    },
                    {
                        "lineId": "99999999999999999999999999999999",
                        "plunum": "999999",
                        "isValueMeal": false,
                        "description": "Coke",
                        "quantity": 1,
                        "price": 0,
                        "modifiers": []
                    }
                ]
            }
        ],
        "partnerOrderId" : "99999999-9999-9999-9999-999999999999",
        "pickupLocation" : "Delivery",
        "orderId": "99999999-9999-9999-9999-999999999999|999"
    },
    "partnerRequestId" : "99999999-9999-9999-9999-999999999999",
    "storeId" : "9999"
}

CancelOrderResponseBody

Field Name	Type	Description
`partnerRequestId`	string	The unique identifier (UID) for the request provided in the original request
`partnerOrderId`	string	The UID for the order provided in the original request
`requestType`	string	The request type
`posInfo`	posInfo Object	An object containing information about the type and version of the point of sale (POS) system that generated the request
`orderId`	string	The Genius-generated orderID sent with the request
`subTotal`	number	The total dollar amount of all of the items included with the order
`taxes`	taxes Array	An array of objects that contain a description, ID, and amount for each tax that is charged on the order. This array may list multiple taxes if more than one tax is applied with the order.
`totalTaxes`	number	The total amount of tax to be charged on the order. This value is based on the sum of taxes returned in the taxes array.
`total`	number	The total dollar amount to be charged for the order
`items`	items Array	An array of objects that define the items that are included on the order. The item objects include item ID and price information.

Cancel Order Response Sample Code

Sample Response Body

{
  "partnerRequestId": "99999999-9999-9999-9999-999999999999",
  "partnerOrderId": "99999999-9999-9999-9999-999999999999",
  "requestType": "CancelOrder",
  "posInfo": {
    "type": "999999999",
    "version": "9.99.9"
  },
  "orderId": "99999999-9999-9999-9999-999999999999|999",
  "subTotal": 999,
  "taxes": [
    {
      "description": "Tax (7.000%) TAX",
      "id": "999999",
      "amount": 99
    }
  ],
  "totalTaxes": 99,
  "total": 999,
  "items": [
    {
      "lineId": "99999999999999999999999999999999",
      "plunum": "999999",
      "isValueMeal": true,
      "description": "Burger",
      "quantity": 1,
      "price": 999,
      "modifiers": [
        {
          "lineId": "99999999999999999999999999999999",
          "plunum": "999999",
          "isValueMeal": false,
          "description": "Cheeseburger",
          "quantity": 1,
          "price": 0,
          "modifiers": []
        },
        {
          "lineId": "99999999999999999999999999999999",
          "plunum": "999999",
          "isValueMeal": false,
          "description": "Fries",
          "quantity": 1,
          "price": 0,
          "modifiers": []
        },
        {
          "lineId": "99999999999999999999999999999999",
          "plunum": "999999",
          "isValueMeal": false,
          "description": "Coke",
          "quantity": 1,
          "price": 0,
          "modifiers": []
        }
      ]
    }
  ]
}

Operation Definitions

Endpoints

POST /price

POST /place

POST /stores/heartbeat

POST /delivery/insert

POST /delivery/confirm

POST /delivery/cancel

Data Models

PriceOrderRequestBody

order Object

items Array

fees Array

payment Object

Price Order Request Sample Code

PriceOrderResponseBody

posInfo Object

taxes Array

Price Order Response Sample Code

PlaceOrderRequestBody

Place Order Request Sample Code

PlaceOrderResponseBody

Place Order Response Sample Code

StoreStatusRequestBody

Store Status Request Sample Code

StoreStatusResponseBody

storeStatus Object

Store Status Response Sample Code

InsertOrderRequestBody

Insert Order Request Sample Code

InsertOrderResponseBody

Insert Order Response Sample Code

ConfirmOrderRequestBody

Confirm Order Request Sample Code

ConfirmOrderResponseBody

Confirm Order Response Sample Code

CancelOrderRequestBody

Cancel Order Request Sample Code

CancelOrderResponseBody

Cancel Order Response Sample Code

Search results