iotoms Docs

Update store branding

PUT
/api/v1/catalog/business/stores/branding/{id}

Updates a store branding record with the values you send. Fields you leave out or send as null keep their current value; the store it belongs to cannot be changed.

How to use it

  1. Take the branding id from List store branding (filter by storeId).
  2. Send the logo, header, footer and/or additionalAttributes to change; omitted fields keep their value.
  3. The new branding is saved with an updated modified time.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

id*integer

ID of the record.

Formatint64

Request Body

application/json
  1. body
storeId?|

The store to brand, from List stores. Required when creating; the store cannot be changed afterwards.

Formatint64
logo?|

Logo value for the store, for example an image URL; stored as sent. On update, leave out to keep the current value.

header?|

Header text for the store, for example for receipts your app prints. On update, leave out to keep the current value.

footer?|

Footer text for the store, for example for receipts your app prints. On update, leave out to keep the current value.

additionalAttributes?|

Extra branding settings as text (for example a JSON string). On update, leave out to keep the current value.

Response Body

OK

*/*
  1. response
id?|

Store branding identifier. Set by the server.

Formatint64
store*

The store this branding belongs to.

logo?|

Logo value saved for the store, as sent (for example an image URL). The backend stores it without checking it.

header?|

Header text saved for the store, for example for the top of receipts your app prints. Stored as sent.

footer?|

Footer text saved for the store, for example for the bottom of receipts your app prints. Stored as sent.

additionalAttributes?|

Any extra branding settings, stored as text exactly as sent (for example a JSON string).

modifiedTime*string

When the branding was last changed. Set by the server.

Formatdate-time
Example Request
curl -X PUT 'https://beta.iotoms.com/api/v1/catalog/business/stores/branding/0' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "id": 0,  "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"  },  "logo": "string",  "header": "string",  "footer": "string",  "additionalAttributes": "string",  "modifiedTime": "2019-08-24T14:15:22Z"}