iotoms Docs

Get quick pick layout for a register

GET
/api/v1/quickpick/resolve

Returns the quick pick button layout that applies to a register, store or venue, falling back from register to store to venue to the merchant default. Pass sinceVersion to get 304 Not Modified when the layout has not changed.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

registerId?integer

Register to resolve the layout for; checked first.

Formatint64
storeId?integer

Store to fall back to when the register has no layout assigned.

Formatint64
venueId?integer

Venue to fall back to when neither register nor store has a layout assigned.

Formatint64
sinceVersion?integer

Layout version the device already has; returns 304 Not Modified when it is still current.

Formatint32

Response Body

OK

*/*
  1. response
configurationId*string

ID of the quick pick layout that applies.

Formatuuid
version*integer

Layout version. Send it as sinceVersion next time to get 304 Not Modified if unchanged.

Formatint32
checksum*string

Fingerprint of the layout; it changes whenever the layout content changes.

updatedAt*string

When the layout was last changed (ISO 8601 date-time).

Formatdate-time
pages*array<>

Pages of buttons, in page order; buttons are ordered by row then column.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/quickpick/resolve'
Example Response
{  "configurationId": "254ffdcc-3725-465c-b0a0-22afb2bec267",  "version": 0,  "checksum": "string",  "updatedAt": "2019-08-24T14:15:22Z",  "pages": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "pageIndex": 0,      "title": "string",      "backgroundColor": "string",      "buttons": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "itemId": "string",          "buttonLabel": "string",          "buttonColor": "string",          "positionRow": 0,          "positionCol": 0,          "uiPayload": {            "property1": {},            "property2": {}          }        }      ]    }  ]}