iotoms Docs

Get a store

GET
/api/v1/catalog/business/stores/{id}

Returns one store by its numeric ID, including its venue, type, promotional content and status. Returns 404 if the store does not exist.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

id*integer

ID of the record.

Formatint64

Response Body

OK

*/*
  1. response
id?|

Store ID. Send it as storeId when creating or moving a register.

Formatint64
name*string

Store name, unique across the merchant.

venue?

The venue (site) the store belongs to, if any.

storeType?|

Free-text store type set by the merchant.

promotionalMessage?|

Promotional message configured for the store.

promotionalImage?|

Promotional image reference configured for the store.

status*string

Store status: ACTIVE, INACTIVE, ARCHIVED or DELETED.

Value in"ACTIVE""INACTIVE""ARCHIVED""DELETED"
modifiedTime*string

When the store was last changed.

Formatdate-time
createdViaAi*boolean

True when the store was created through the AI assistant.

aiSessionId?|

ID of the AI assistant session that created the store, when createdViaAi is true.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/catalog/business/stores/0'
Example Response
{  "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"}