iRetail PRO hub 1.0.0-m5: brand
3 operations
← All documentation · Source: contracts openapi/hub-v1.yaml at 8000474.
Stores' banners over the organization's brand (spec/BRANDS.md); the brand itself is the store API's.
Operations
GET
/v1/stores/{id}/banner
A store's banner over the brand, served whether or not the key holds white_label; 404 when the store has none (spec/BRANDS.md).
operationId
getStoreBanner · Permission brand.manage
Parameters
| Name | In | Type | Description |
|---|---|---|---|
IRetail-App
|
header | string |
Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking). |
id required
|
path | string (uuid) |
Responses
PUT
/v1/stores/{id}/banner
Set a store's banner, checked as a brand is (422 invalid_brand, 422 brand_contrast); 403 module_disabled without white_label.
operationId
putStoreBanner · Permission brand.manage
Parameters
| Name | In | Type | Description |
|---|---|---|---|
IRetail-App
|
header | string |
Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking). |
id required
|
path | string (uuid) |
|
If-Match
|
header | string |
The version the change is based on. |
Request body required
application/jsonBannerPut
Responses
DELETE
/v1/stores/{id}/banner
Remove a store's banner, bringing the brand back to it; 403 module_disabled without white_label.
operationId
deleteStoreBanner · Permission brand.manage
Parameters
| Name | In | Type | Description |
|---|---|---|---|
IRetail-App
|
header | string |
Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking). |
id required
|
path | string (uuid) |
|
If-Match
|
header | string |
The version the change is based on. |
Responses
Schemas
BannerPut object
A store's banner over the brand (spec/BRANDS.md, The records); a null field keeps the brand's.
name required
|
LocalizedText | null |
|
logo required
|
BrandImageId | null |
|
dark_logo required
|
BrandImageId | null |
|
receipt_logo required
|
BrandImageId | null |
|
colors required
|
BrandColors | null |
|
receipt_header required
|
BrandLines | null |
|
receipt_footer required
|
BrandLines | null |
Banner @BannerPut & object
A store's banner as kept.