iRetail PRO store node 1.0.0-m1: brand
5 operations
← All documentation · Source: contracts openapi/store-v1.yaml at 8000474.
← iRetail PRO store node 1.0.0-m1
Operations
GET
/v1/brand
The effective brand of the caller's store: the brand overlaid with the store's banner, or the default (spec/BRANDS.md, What the apps get); 304 for a matching If-None-Match.
operationId
getBrand · Permission store.read
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). |
If-None-Match
|
header | string |
The ETag the caller holds. |
Responses
-
200OKEffectiveBrand -
304Not modified. -
401Error (spec/API.md).Error -
403Error (spec/API.md).Error
PUT
/v1/brand
Set the organization's brand: checked as spec/BRANDS.md says (422 invalid_brand, 422 brand_contrast); 403 module_disabled without white_label; 409 owned_by_hub at a store of a chain.
operationId
putBrand · 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). |
If-Match
|
header | string |
The version the change is based on. |
Request body required
application/jsonBrandPut
Responses
GET
/v1/brand/settings
The organization's brand as kept, served whether or not the key holds white_label; 404 when there is none.
operationId
getBrandSettings · 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). |
Responses
POST
/v1/brand/images
Upload a PNG of at most 128 KiB for a brand or a banner to name; only its header is read (422 invalid_brand, reason not_png). Its id is the SHA-256 of its bytes, so uploading the same bytes again answers the same image.
operationId
uploadBrandImage · 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). |
Idempotency-Key
|
header | string |
spec/API.md, Idempotency. |
Request body required
image/pngstring (binary)
Responses
GET
/v1/brand/images/{id}
An image of the brand or a banner, its bytes never changing; 304 for a matching If-None-Match.
operationId
getBrandImage · Permission store.read
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 |
The lower-case hex SHA-256 of the image's bytes. |
If-None-Match
|
header | string |
The ETag the caller holds. |
Responses
Schemas
Error object
Every error response.
error required
|
string |
Stable code, see spec/API.md. |
message required
|
string |
English text for logs. |
details
|
object |
LocalizedText map of string
Text by language code; the organization's default language must be present.
BrandColor string
An opaque sRGB color.
BrandThemeColors object
One theme's accent tokens (spec/BRANDS.md, Colors).
accent required
|
BrandColor |
|
accent_hover required
|
BrandColor |
|
accent_active required
|
BrandColor |
|
accent_on required
|
BrandColor |
|
accent_text required
|
BrandColor |
|
accent_soft required
|
BrandColor |
BrandColors object
light required
|
BrandThemeColors |
|
dark required
|
BrandThemeColors |
BrandImageId string
The lower-case hex SHA-256 of an uploaded image's bytes.
BrandImage object
An uploaded PNG as the node read its header (spec/BRANDS.md, Images).
id required
|
BrandImageId |
|
width required
|
integer (int64) |
|
height required
|
integer (int64) |
|
bit_depth required
|
integer |
|
color_type required
|
integer |
|
interlace required
|
integer |
|
bytes required
|
integer (int64) |
BrandImageRef object
An image of the effective brand, fetched from GET /v1/brand/images/{id}.
id required
|
BrandImageId |
|
width required
|
integer (int64) |
|
height required
|
integer (int64) |
BrandLines array of @LocalizedText
Lines printed on a receipt, each 1 to 48 characters in every language given.
BrandPut object
The organization's brand as written (spec/BRANDS.md, The records).
name required
|
LocalizedText |
|
logo required
|
BrandImageId | null |
|
dark_logo required
|
BrandImageId | null |
|
receipt_logo required
|
BrandImageId | null |
|
colors required
|
BrandColors | null |
|
receipt_header required
|
BrandLines |
|
receipt_footer required
|
BrandLines |
|
sender_name required
|
string | null |
Brand @BrandPut & object
The organization's brand as kept.
EffectiveBrand object
What the apps show in a store (spec/BRANDS.md, What the apps get): the brand overlaid with the store's banner; source default (every field null, no lines) when there is none or the key lacks white_label.
source required
|
"default" | "brand" | "banner" |
|
version required
|
string |
The brand's and the banner's versions, 0 for one absent. |
name required
|
LocalizedText | null |
|
logo required
|
BrandImageRef | null |
|
dark_logo required
|
BrandImageRef | null |
|
receipt_logo required
|
BrandImageRef | null |
|
colors required
|
BrandColors | null |
|
receipt_header required
|
BrandLines |
|
receipt_footer required
|
BrandLines |
|
sender_name required
|
string | null |