iotoms Docs

Partially update store branding

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

Updates only the fields included in the request body (logo, header, footer, additionalAttributes) for a store branding record. Null values and other keys are ignored.

How to use it

  1. Take the branding id from List store branding.
  2. Send a JSON object with only the fields to change: logo, header, footer or additionalAttributes.
  3. Those fields are saved and the modified time is updated; all other fields stay as they were.

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