Poster

Poster

List poster templates

get

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/poster-templates

List poster templates

Required permissions: POSTER

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

Query parameters

pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional

ENUM	Description
ASC	Sort in ascending order
DESC	Sort in descending order

Possible values:

Responses

200

Example response

application/json

get

/tenants/{tenantUid}/poster-templates

HTTPcURLJavaScriptPython

GET /v2/tenants/{tenantUid}/poster-templates HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "posterTemplateUid": "text",
      "name": "text",
      "html": "text",
      "size": "A1",
      "orientation": "Portrait",
      "previewImage": "text",
      "thousandSeparator": "COMMA",
      "createdBy": "text",
      "createdAt": "2026-01-29T20:24:48.402Z",
      "lastModifiedBy": "text",
      "lastModifiedAt": "2026-01-29T20:24:48.402Z"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create poster template

post

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/poster-templates

Create new poster template

Required permissions: SUPERADMIN

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

Body

application/json

namestringRequired

htmlstringOptional

template body

sizestring · enumOptionalPossible values:

orientationstring · enumOptionalPossible values:

previewImagestringOptional

base64 encoded image data

posterTemplateUidstringOptionalPattern: ^[A-Za-z0-9-_]*

thousandSeparatorstring · enumOptionalPossible values:

Responses

201

Example response

application/json

post

/tenants/{tenantUid}/poster-templates

HTTPcURLJavaScriptPython

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"
}

201

Example response

{
  "posterTemplateUid": "text",
  "name": "text",
  "html": "text",
  "size": "A1",
  "orientation": "Portrait",
  "previewImage": "text",
  "thousandSeparator": "COMMA",
  "createdBy": "text",
  "createdAt": "2026-01-29T20:24:48.402Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2026-01-29T20:24:48.402Z"
}

Get poster template

get

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/poster-templates/{posterTemplateUid}

Get poster template

Required permissions: POSTER

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

posterTemplateUidstringRequired

Reference to a poster template

Pattern: ^[A-Za-z0-9-_]+

Responses

200

Example response

application/json

get

/tenants/{tenantUid}/poster-templates/{posterTemplateUid}

HTTPcURLJavaScriptPython

GET /v2/tenants/{tenantUid}/poster-templates/{posterTemplateUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "posterTemplateUid": "text",
  "name": "text",
  "html": "text",
  "size": "A1",
  "orientation": "Portrait",
  "previewImage": "text",
  "thousandSeparator": "COMMA",
  "createdBy": "text",
  "createdAt": "2026-01-29T20:24:48.402Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2026-01-29T20:24:48.402Z"
}

Update poster template

put

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/poster-templates/{posterTemplateUid}

Update poster template

Required permissions: SUPERADMIN

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

posterTemplateUidstringRequired

Reference to a poster template

Pattern: ^[A-Za-z0-9-_]+

Body

application/json

namestringOptional

htmlstringOptional

template body

sizestring · enumOptionalPossible values:

orientationstring · enumOptionalPossible values:

previewImagestringOptional

base64 encoded image data

thousandSeparatorstring · enumOptionalPossible values:

Responses

200

Example response

application/json

put

/tenants/{tenantUid}/poster-templates/{posterTemplateUid}

HTTPcURLJavaScriptPython

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"
}

200

Example response

{
  "posterTemplateUid": "text",
  "name": "text",
  "html": "text",
  "size": "A1",
  "orientation": "Portrait",
  "previewImage": "text",
  "thousandSeparator": "COMMA",
  "createdBy": "text",
  "createdAt": "2026-01-29T20:24:48.402Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2026-01-29T20:24:48.402Z"
}

Delete poster template

delete

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/poster-templates/{posterTemplateUid}

Delete poster template

Required permissions: SUPERADMIN

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

posterTemplateUidstringRequired

Reference to a poster template

Pattern: ^[A-Za-z0-9-_]+

Responses

204

No Content

delete

/tenants/{tenantUid}/poster-templates/{posterTemplateUid}

HTTPcURLJavaScriptPython

DELETE /v2/tenants/{tenantUid}/poster-templates/{posterTemplateUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

No content

Create poster PDF

post

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/poster-templates/{posterTemplateUid}/pdf

Create poster PDF for printing

Required permissions: POSTER

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

posterTemplateUidstringRequired

Reference to a poster template

Pattern: ^[A-Za-z0-9-_]+

Body

application/json

Responses

201

Created

application/pdf

post

/tenants/{tenantUid}/poster-templates/{posterTemplateUid}/pdf

HTTPcURLJavaScriptPython

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: 191

{
  "products": [
    {
      "sku": "text",
      "name": "text",
      "nowPrice": 1,
      "beforePrice": 1,
      "discountPercentage": 1,
      "brandName": "text",
      "description": "text",
      "usps": [
        "text"
      ],
      "imageUrl": "text",
      "barcodeValue": "text"
    }
  ]
}

201

Created

binary

List poster base templates

get

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/poster-base-templates

List poster base templates that can be used for adaption to actual poster templates.

Required permissions: POSTER

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

Responses

200

Example response

application/json

get

/tenants/{tenantUid}/poster-base-templates

HTTPcURLJavaScriptPython

GET /v2/tenants/{tenantUid}/poster-base-templates HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "name": "text",
      "size": "A1",
      "orientation": "Portrait",
      "html": "text"
    }
  ]
}