iotoms Docs

Update store fields

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

Partially updates a store: only the fields included in the request body (name, venueId, storeType, promotionalMessage, promotionalImage, status) are changed. Returns the updated store, or 404 if it does not exist.

How to use it

  1. Get the store ID from List stores.
  2. Send only the fields to change, for example {"status": "INACTIVE"}; a venueId must be an existing venue.
  3. Fields you leave out keep their current values. Sending a field as null does not clear it.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

id*integer

ID of the record.

Formatint64

Request Body

application/json
  1. body
[key: string]?

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 PATCH 'https://beta.iotoms.com/api/v1/catalog/business/stores/0' \  -H 'Content-Type: application/json' \  -d '{  "property1": {},  "property2": {}}'
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"}