Skip to content
Developers
Pilot. The API is open to a small number of organisations and may change — every change is in the changelog.

Reference · Menus

Set an online menu tab's pictures

PUT/v1/sites/{siteId}/menus/{code}/tabs/{part}/image

Copies a tab's picture, and the one shown under the cursor, from public URLs into Dnero. Errors with 503 images_unavailable where pictures cannot be stored.

Needs Catalogue: writeChanges live data

Path

  • siteIdrequired

    The site, from GET /v1/sites.

    string

  • coderequired

    The menu's code.

    string

  • partrequired

    The tab's or section's code, within the menu.

    string

Headers

  • Authorizationrequired

    An API key from Automation > Access in the Dnero portal, sent as Authorization: Bearer <key>.

    string

Body

  • crop

    square takes a centred square; original keeps the proportions.

    string · one of "square", "original" · default "square"

  • hoverUrl

    A public https URL for the picture under the cursor. An empty string removes it.

    string · at most 2000 characters

  • url

    A public https URL for the tab's picture. An empty string removes it; leave it out to keep it.

    string · at most 2000 characters

Responses

200 OK

  • activerequired

    False for a retired menu.

    boolean

  • coderequired

    The menu's code.

    string

  • namerequired

    The menu's name, as customers see it.

    string

  • orderrequired

    Where it sits among the site's menus, lowest first.

    integer

  • orderTypesrequired

    The order types it serves, by code: a menu serving none appears nowhere.

    array of string

  • tabsrequired

    Its tabs, in order.

    array of objects

    5 fields in each
    • coderequired

      The tab's code, within its menu.

      string

    • namerequired

      The tab's name.

      string

    • productsrequired

      The products on the tab, by code, in order.

      array of string

    • hoverImageUrl

      The picture shown under the cursor.

      string · uri

    • imageUrl

      The tab's picture.

      string · uri

  • updatedAt

    When it last changed.

    string · date-time