Skip to main content
POST
Import menu
write:menu
Each entity includes the ext_id field, which must be populated with its own unique identifier.If an element of the same entity with this ext_id does not already exist, a new one will be created. If the element exists, its content will be updated.The uniqueness scope of this ID is internal to the environment defined by the Client ID (X-Client-Id), meaning the same ext_id imported from different Client IDs will generate distinct elements.The ext_id values for options and option_values can be unique in that environment or only within their respective parent element (category/product for options, option for option_values).

Authorizations

X-Client-Id
string
header
required

Client ID for API Client authentication (must be used together with Client Secret)

X-Client-Secret
string
header
required

Client Secret for API Client authentication (must be used together with Client ID)

Body

application/json
pos_uid
string
required

Point-of-sale identifier

update_mode
enum<string>
required

Update mode:

  • replace = Full replacement
  • merge = Append new items
Available options:
replace,
merge
categories
object[]

Array of categories. Required if update_mode = replace

products
object[]

Array of products. Required if update_mode = replace

Response

Menu import response

success
boolean
required

Operation result: true if successful, false if failed

error
string

Error code if the operation failed. Possible values:

  • IMPORT_ERROR = Error during import (consult message parameter for details)

See Error codes for general error codes that may also occur.

message
string

Error description if the import failed