Synchronise Menu

This endpoint is used to synchronise a POS menu with Tyro Connect when the POS receives the MENU_SYNC_REQUESTED notification.

Request
Security:
path Parameters
tcLocationId
required
string
header Parameters
Authorization
required
string
Default: Bearer {$$.env.access_token}
Content-Type
required
string
Value: "application/json"
x-ticket-number
string

The ticket number sent by Tyro Connect to identify the sync request. When the menu sync process is initiated from Tyro Connect Portal, the POS system will receive a notification containing the ticket number that needs to be sent back to us.

Request Body schema: application/json
required
Array of objects (item)

A list of objects that describe the different items available within the menu

required
Array of objects (section)

A list of objects that describe the different sections of the menu

required
Array of objects (time-slot)

A list of objects that describe the time periods that different sections of the menu can be made available within

required
Array of objects (modifier-group)

A list of objects that describe the different modifier groups that will be available to the merchant within the portal to apply to different sections

Responses
204

No body content. Menu successfully updated

400

When the provided payload is not valid.

403

When you don't have the right permissions to synchronise a menu

404

When the location provided was not found

409

When a ticket number is provided but is invalid or expired

put/menus/{tcLocationId}/sync
Request samples
application/json
{
  • "items": [
    ],
  • "sections": [
    ],
  • "timeSlots": [
    ],
  • "modifierGroups": [
    ]
}
Response samples
application/json
{
  • "error": "\"ticketNumber\" is required"
}
Copyright © Tyro Payments 2019-2024. All right reserved.