iotoms Docs

Assign a quick pick configuration to a scope

POST
/api/v1/quickpick/configurations/{id}/scopes

Adds a scope assignment so the configuration applies to a register, store, venue or all locations. scopeRefId is required unless scopeType is ALL. Returns all assignments for the configuration.

How to use it

  1. Take the configuration id from List quick pick configurations.
  2. Choose scopeType and, unless it is ALL, the matching id from List registers, List stores or List venues.
  3. Optionally set effectiveFrom/effectiveTo and active. The response lists all assignments; a till uses the most specific active one (register, store, venue, then all).

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

id*string

ID of the record (UUID).

Formatuuid

Request Body

application/json
  1. body
scopeType*string

Required. REGISTER, STORE, VENUE or ALL (every location). The most specific matching assignment wins on a till.

Value in"REGISTER""STORE""VENUE""ALL"
scopeRefId?|

Id of the register, store or venue (from List registers, List stores or List venues). Required unless scopeType is ALL, where it must be left out.

Formatint64
effectiveFrom?|

Optional start date and time (ISO 8601). Defaults to now.

Formatdate-time
effectiveTo?|

Optional end date and time. Leave out for no end date.

Formatdate-time
active*boolean

Whether the assignment is switched on. Defaults to true.

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when the request was handled, ERROR otherwise.

message*string

Short human-readable message describing the outcome, e.g. which record was fetched or saved.

data?array<>|

All scope assignments of the configuration.

Example Request
curl -X POST 'https://beta.iotoms.com/api/v1/quickpick/configurations/497f6eca-6276-4993-bfeb-53cbbbba6f08/scopes' \  -H 'Content-Type: application/json' \  -d '{  "scopeType": "REGISTER",  "active": true}'
Example Response
{  "status": "string",  "message": "string",  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "scopeType": "REGISTER",      "scopeRefId": 0,      "effectiveFrom": "2019-08-24T14:15:22Z",      "effectiveTo": "2019-08-24T14:15:22Z",      "active": true    }  ]}