Poster
Poster
List poster templates
Required permissions: POSTER
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a specific page in a result set.
The number of items per page in a result set.
Defines which field the resource list is sorted by.
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
Example response
GET /v2/tenants/{tenantUid}/poster-templates HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"items": [
{
"posterTemplateUid": "text",
"name": "text",
"html": "text",
"size": "A1",
"orientation": "Portrait",
"previewImage": "text",
"thousandSeparator": "COMMA",
"createdBy": "text",
"createdAt": "2026-01-01T00:00:00.000Z",
"lastModifiedBy": "text",
"lastModifiedAt": "2026-01-01T00:00:00.000Z"
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}Create new poster template
Required permissions: SUPERADMIN
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+template body
base64 encoded image data
^[A-Za-z0-9-_]*Example response
^[A-Za-z0-9-_]+template body
base64 encoded image data
POST /v2/tenants/{tenantUid}/poster-templates HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 143
{
"name": "text",
"html": "text",
"size": "A1",
"orientation": "Portrait",
"previewImage": "text",
"posterTemplateUid": "text",
"thousandSeparator": "COMMA"
}Example response
{
"posterTemplateUid": "text",
"name": "text",
"html": "text",
"size": "A1",
"orientation": "Portrait",
"previewImage": "text",
"thousandSeparator": "COMMA",
"createdBy": "text",
"createdAt": "2026-01-01T00:00:00.000Z",
"lastModifiedBy": "text",
"lastModifiedAt": "2026-01-01T00:00:00.000Z"
}Get poster template
Required permissions: POSTER
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a poster template
^[A-Za-z0-9-_]+Example response
^[A-Za-z0-9-_]+template body
base64 encoded image data
GET /v2/tenants/{tenantUid}/poster-templates/{posterTemplateUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"posterTemplateUid": "text",
"name": "text",
"html": "text",
"size": "A1",
"orientation": "Portrait",
"previewImage": "text",
"thousandSeparator": "COMMA",
"createdBy": "text",
"createdAt": "2026-01-01T00:00:00.000Z",
"lastModifiedBy": "text",
"lastModifiedAt": "2026-01-01T00:00:00.000Z"
}Update poster template
Required permissions: SUPERADMIN
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a poster template
^[A-Za-z0-9-_]+template body
base64 encoded image data
Example response
^[A-Za-z0-9-_]+template body
base64 encoded image data
PUT /v2/tenants/{tenantUid}/poster-templates/{posterTemplateUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 116
{
"name": "text",
"html": "text",
"size": "A1",
"orientation": "Portrait",
"previewImage": "text",
"thousandSeparator": "COMMA"
}Example response
{
"posterTemplateUid": "text",
"name": "text",
"html": "text",
"size": "A1",
"orientation": "Portrait",
"previewImage": "text",
"thousandSeparator": "COMMA",
"createdBy": "text",
"createdAt": "2026-01-01T00:00:00.000Z",
"lastModifiedBy": "text",
"lastModifiedAt": "2026-01-01T00:00:00.000Z"
}Delete poster template
Required permissions: SUPERADMIN
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a poster template
^[A-Za-z0-9-_]+No Content
No content
DELETE /v2/tenants/{tenantUid}/poster-templates/{posterTemplateUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No Content
No content
Create poster PDF for printing
Required permissions: POSTER
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a poster template
^[A-Za-z0-9-_]+Created
POST /v2/tenants/{tenantUid}/poster-templates/{posterTemplateUid}/pdf HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 213
{
"products": [
{
"sku": "text",
"name": "text",
"nowPrice": 1,
"beforePrice": 1,
"discountPercentage": 1,
"brandName": "text",
"description": "text",
"usps": [
"text"
],
"imageUrl": "text",
"barcodeValue": "text",
"properties": [
"text"
]
}
]
}Created
binaryList poster base templates that can be used for adaption to actual poster templates.
Required permissions: POSTER
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Example response
GET /v2/tenants/{tenantUid}/poster-base-templates HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"items": [
{
"name": "text",
"size": "A1",
"orientation": "Portrait",
"html": "text"
}
]
}Last updated