iotoms Docs

List registers

GET
/api/v1/catalog/business/registers

Returns a paginated list of registers sorted by name (0-based page, size 1 to 100, default 20). Filter by storeId, status, registerType, or query to search by name.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

storeId?integer

Only return registers of this store. Store ID from List stores.

Formatint64
status?string

Only return registers in this status: ACTIVE, INACTIVE, ARCHIVED or DELETED. An unrecognised value is ignored.

registerType?string

Only return registers of this type: VAN or POS. An unrecognised value is ignored.

query?string

Text to search for in the register name, ignoring case.

page?integer

Page number, starting at 0. See Paging.

Formatint32
Default0
size?integer

Number of records per page.

Formatint32
Default20

Header Parameters

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when the request worked, ERROR when it did not.

message*string

Short human-readable message describing the result, for logs or display; do not parse it.

data?

One page of registers, sorted by name, with paging details.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/catalog/business/registers'
Example Response
{  "status": "string",  "message": "string",  "data": {    "content": [      {        "id": 0,        "name": "string",        "store": {          "id": 0,          "name": "string",          "venue": {            "id": 0,            "name": "string",            "status": "ACTIVE",            "modifiedTime": "2019-08-24T14:15:22Z"          },          "storeType": "string",          "promotionalMessage": "string",          "promotionalImage": "string",          "status": "ACTIVE",          "modifiedTime": "2019-08-24T14:15:22Z",          "createdViaAi": true,          "aiSessionId": "string"        },        "fromTime": "2019-08-24T14:15:22Z",        "toTime": "2019-08-24T14:15:22Z",        "terminationReason": "string",        "type": "VAN",        "status": "ACTIVE",        "modifiedTime": "2019-08-24T14:15:22Z",        "inventoryLocationId": "8f43ca4f-50a9-41c3-817f-63e60279ba33"      }    ],    "page": 0,    "size": 0,    "totalElements": 0,    "totalPages": 0,    "last": true  }}