Operation Definitions

Endpoints

GET /api/v1/menu/SICOM_MENU_ID

Use the Get Menu operation to obtain a full menu in JSON format.

Field Name

Type

Required

Description

header

AUTHORIZATION

string

Yes

An authorization token linked to the integrator account

URL

SICOM_MENU_ID

string

Yes

The SICOM_MENU_ID identifies the menu that will be returned. It is included in the menu update notification sent by Omni whenever a menu needs to be updated. The format of the SICOM_Menu_ID parameter is the grouping of the following values:

Field Name	Type	Description
`partner_id`	string	The unique identifier (UID) for the partner
`brand_id`	string	The UID for the brand
`brand_store_number`	string	The UID for the location

Responses

Code	Description
200	Success Response. The response body includes a JSON formatted menu object. The menu object format is specific to the partner.
404	Error Response. Invalid URL. The `SICOM_MENU_ID` does not exist.
500	Server Error

Code

Description

200

Success Response.

The response body includes a JSON formatted menu object. The menu object format is specific to the partner.

404

Error Response.

Invalid URL. The SICOM_MENU_ID does not exist.

500

Server Error

POST /api/v1/status/PARTNER_ID

Use the Update Status operation to notify Omni whether the menu update succeeded or failed.

In	Field Name	Type	Required	Description
header	`AUTHORIZATION`	string	Yes	An authorization token linked to the integrator account
URL	`partner_id`	string	Yes	Identifies the partner. The `partner_id` is defined during onboarding.
body	`body`	UpdateStatusRequestBody	Yes	The Update Status request information

Responses

Code	Description
200	Success Response
401	Authentication Error
403	Authentication Error
400	Bad Payload
500	Internal Server Error

Data Models

UpdateStatusRequestBody

Field Name	Type	Description
`reference`	string	The `SICOM_MENU_ID` that identifies the menu that needs to be updated
`status`	string	The result of the menu update: `SUCCESS` or `FAILED`
`reason`	string	The reason that the menu update failed. For successful updates, do not set a value for this field. For failed updates, send predefined reason messages.

The following Sample Request Body examples show generic request bodies for success and failure cases:

Sample Request Body - SUCCESS

{
    "reference": "SICOM_Menu_ID",
    "status": "SUCCESS",
    "reason": null
}

Sample Request Body - FAILED

{
    "reference": "SICOM_Menu_ID",
    "status": "FAILED",
    "reason": "Validation error"
}