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	Error Response. 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

Error Response.

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 information