iotoms Docs

Create store branding

POST
/api/v1/catalog/business/stores/branding

Creates a branding record (logo, header, footer and extra settings) for a store, for your apps to use on receipts or screens. storeId must refer to an existing store. Returns the saved record directly (201), without the usual status/message/data envelope.

How to use it

  1. Pick the store from List stores.
  2. Send storeId with the logo, header, footer and any additionalAttributes.
  3. The branding record is created and returned with its id; change it later with Update store branding or Partially update store branding.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

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 POST 'https://beta.iotoms.com/api/v1/catalog/business/stores/branding' \  -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"}