iotoms Docs

List stores

GET
/api/v1/catalog/business/stores

Returns stores sorted by name, paginated with 0-based page and size (1 to 100, default 20). Filter by venueId, status or storeType, and search by text with query.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

venueId?integer

Optional. Only stores in this venue (from List venues).

Formatint64
status?string

Optional. Only stores with this status: ACTIVE, INACTIVE, ARCHIVED or DELETED. Unknown values are ignored.

storeType?string

Optional. Only stores with exactly this store type.

query?string

Optional. Case-insensitive text search on store name and store type.

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 request: SUCCESS when it worked; errors return an error status with the reason in message.

message*string

Short human-readable message describing the outcome.

data?

One page of stores matching the filters.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/catalog/business/stores'
Example Response
{  "status": "string",  "message": "string",  "data": {    "content": [      {        "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"      }    ],    "page": 0,    "size": 0,    "totalElements": 0,    "totalPages": 0,    "last": true  }}