> For the complete documentation index, see [llms.txt](https://docs.flowretail.com/api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flowretail.com/api/poster.md).

# Poster

Poster

## List poster templates

> List poster templates\
> \
> Required permissions: POSTER

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Poster","description":"Poster"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"responses":{"PosterTemplateListResponse":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","required":["items","paging"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PosterTemplateSchema"}},"paging":{"$ref":"#/components/schemas/Paging"}}}}}}},"schemas":{"PosterTemplateSchema":{"allOf":[{"type":"object","required":["posterTemplateUid","name","html","size","orientation","previewImage","thousandSeparator"],"properties":{"posterTemplateUid":{"$ref":"#/components/schemas/UID"},"name":{"type":"string"},"html":{"type":"string","description":"template body"},"size":{"$ref":"#/components/schemas/PaperSizeEnum"},"orientation":{"$ref":"#/components/schemas/PaperOrientationEnum"},"previewImage":{"type":"string","description":"base64 encoded image data"},"thousandSeparator":{"$ref":"#/components/schemas/ThousandSeparatorENUM"}}},{"$ref":"#/components/schemas/CreatedModifiedSchema"}]},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"PaperSizeEnum":{"title":"PaperSizeEnum","type":"string","enum":["A1","A2","A3","A4","A5","A6"]},"PaperOrientationEnum":{"title":"PaperOrientationEnum","type":"string","enum":["Portrait","Landscape"]},"ThousandSeparatorENUM":{"title":"ThousandSeparatorENUM","type":"string","enum":["COMMA","DOT","SPACE","NONE"]},"CreatedModifiedSchema":{"title":"CreatedModifiedSchema","type":"object","required":["createdBy","createdAt","lastModifiedBy","lastModifiedAt"],"properties":{"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"}}},"Paging":{"description":"totalCount The total number of items in the result set.\n\npageSize The number of items per page.\n\npageNumber The current page in the result set.","properties":{"pageNumber":{"type":"integer"},"pageSize":{"type":"integer"},"totalCount":{"type":"integer"}},"required":["totalCount","pageSize","pageNumber"],"title":"Paging","type":"object"},"SortDirectionENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| ASC | Sort in ascending order|\n| DESC | Sort in descending order|\n","enum":["ASC","DESC"],"title":"SortDirectionENUM","type":"string"}},"parameters":{"pageNumberQuery":{"description":"Reference to a specific page in a result set.","in":"query","name":"pageNumber","required":false,"schema":{"type":"integer"}},"pageSizeQuery":{"description":"The number of items per page in a result set.","in":"query","name":"pageSize","required":false,"schema":{"type":"integer"}},"sortByQuery":{"description":"Defines which field the resource list is sorted by.","in":"query","name":"sortBy","required":false,"schema":{"type":"string"}},"sortDirectionQuery":{"description":"Reference to a sort direction","explode":false,"in":"query","name":"sortDirection","schema":{"$ref":"#/components/schemas/SortDirectionENUM"},"style":"form"}}},"paths":{"/tenants/{tenantUid}/poster-templates":{"get":{"summary":"List poster templates","responses":{"200":{"$ref":"#/components/responses/PosterTemplateListResponse"}},"operationId":"get-poster-templates","description":"List poster templates\n\nRequired permissions: POSTER","parameters":[{"$ref":"#/components/parameters/pageNumberQuery"},{"$ref":"#/components/parameters/pageSizeQuery"},{"$ref":"#/components/parameters/sortByQuery"},{"$ref":"#/components/parameters/sortDirectionQuery"}],"tags":["Poster"]}}}}
```

## Create poster template

> Create new poster template\
> \
> Required permissions: SUPERADMIN

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Poster","description":"Poster"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"responses":{"PosterTemplateResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PosterTemplateSchema"}}}}},"schemas":{"PosterTemplateSchema":{"allOf":[{"type":"object","required":["posterTemplateUid","name","html","size","orientation","previewImage","thousandSeparator"],"properties":{"posterTemplateUid":{"$ref":"#/components/schemas/UID"},"name":{"type":"string"},"html":{"type":"string","description":"template body"},"size":{"$ref":"#/components/schemas/PaperSizeEnum"},"orientation":{"$ref":"#/components/schemas/PaperOrientationEnum"},"previewImage":{"type":"string","description":"base64 encoded image data"},"thousandSeparator":{"$ref":"#/components/schemas/ThousandSeparatorENUM"}}},{"$ref":"#/components/schemas/CreatedModifiedSchema"}]},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"PaperSizeEnum":{"title":"PaperSizeEnum","type":"string","enum":["A1","A2","A3","A4","A5","A6"]},"PaperOrientationEnum":{"title":"PaperOrientationEnum","type":"string","enum":["Portrait","Landscape"]},"ThousandSeparatorENUM":{"title":"ThousandSeparatorENUM","type":"string","enum":["COMMA","DOT","SPACE","NONE"]},"CreatedModifiedSchema":{"title":"CreatedModifiedSchema","type":"object","required":["createdBy","createdAt","lastModifiedBy","lastModifiedAt"],"properties":{"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"}}},"OptionalUID":{"title":"OptionalUID","type":"string","pattern":"^[A-Za-z0-9-_]*"}},"requestBodies":{"PosterTemplateCreateRequest":{"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"html":{"type":"string","description":"template body"},"size":{"$ref":"#/components/schemas/PaperSizeEnum"},"orientation":{"$ref":"#/components/schemas/PaperOrientationEnum"},"previewImage":{"type":"string","description":"base64 encoded image data"},"posterTemplateUid":{"$ref":"#/components/schemas/OptionalUID"},"thousandSeparator":{"$ref":"#/components/schemas/ThousandSeparatorENUM"}}}}}}}},"paths":{"/tenants/{tenantUid}/poster-templates":{"post":{"summary":"Create poster template","tags":["Poster"],"responses":{"201":{"$ref":"#/components/responses/PosterTemplateResponse"}},"operationId":"post-poster-templates","description":"Create new poster template\n\nRequired permissions: SUPERADMIN","requestBody":{"$ref":"#/components/requestBodies/PosterTemplateCreateRequest"}}}}}
```

## Get poster template

> Get poster template\
> \
> Required permissions: POSTER

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Poster","description":"Poster"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"responses":{"PosterTemplateResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PosterTemplateSchema"}}}}},"schemas":{"PosterTemplateSchema":{"allOf":[{"type":"object","required":["posterTemplateUid","name","html","size","orientation","previewImage","thousandSeparator"],"properties":{"posterTemplateUid":{"$ref":"#/components/schemas/UID"},"name":{"type":"string"},"html":{"type":"string","description":"template body"},"size":{"$ref":"#/components/schemas/PaperSizeEnum"},"orientation":{"$ref":"#/components/schemas/PaperOrientationEnum"},"previewImage":{"type":"string","description":"base64 encoded image data"},"thousandSeparator":{"$ref":"#/components/schemas/ThousandSeparatorENUM"}}},{"$ref":"#/components/schemas/CreatedModifiedSchema"}]},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"PaperSizeEnum":{"title":"PaperSizeEnum","type":"string","enum":["A1","A2","A3","A4","A5","A6"]},"PaperOrientationEnum":{"title":"PaperOrientationEnum","type":"string","enum":["Portrait","Landscape"]},"ThousandSeparatorENUM":{"title":"ThousandSeparatorENUM","type":"string","enum":["COMMA","DOT","SPACE","NONE"]},"CreatedModifiedSchema":{"title":"CreatedModifiedSchema","type":"object","required":["createdBy","createdAt","lastModifiedBy","lastModifiedAt"],"properties":{"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"}}}}},"paths":{"/tenants/{tenantUid}/poster-templates/{posterTemplateUid}":{"get":{"summary":"Get poster template","tags":["Poster"],"responses":{"200":{"$ref":"#/components/responses/PosterTemplateResponse"}},"operationId":"get-poster-templates-posterTemplateUid","description":"Get poster template\n\nRequired permissions: POSTER"}}}}
```

## Update poster template

> Update poster template\
> \
> Required permissions: SUPERADMIN

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Poster","description":"Poster"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"responses":{"PosterTemplateResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PosterTemplateSchema"}}}}},"schemas":{"PosterTemplateSchema":{"allOf":[{"type":"object","required":["posterTemplateUid","name","html","size","orientation","previewImage","thousandSeparator"],"properties":{"posterTemplateUid":{"$ref":"#/components/schemas/UID"},"name":{"type":"string"},"html":{"type":"string","description":"template body"},"size":{"$ref":"#/components/schemas/PaperSizeEnum"},"orientation":{"$ref":"#/components/schemas/PaperOrientationEnum"},"previewImage":{"type":"string","description":"base64 encoded image data"},"thousandSeparator":{"$ref":"#/components/schemas/ThousandSeparatorENUM"}}},{"$ref":"#/components/schemas/CreatedModifiedSchema"}]},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"PaperSizeEnum":{"title":"PaperSizeEnum","type":"string","enum":["A1","A2","A3","A4","A5","A6"]},"PaperOrientationEnum":{"title":"PaperOrientationEnum","type":"string","enum":["Portrait","Landscape"]},"ThousandSeparatorENUM":{"title":"ThousandSeparatorENUM","type":"string","enum":["COMMA","DOT","SPACE","NONE"]},"CreatedModifiedSchema":{"title":"CreatedModifiedSchema","type":"object","required":["createdBy","createdAt","lastModifiedBy","lastModifiedAt"],"properties":{"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"}}}},"requestBodies":{"PosterTemplateUpdateRequest":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"html":{"type":"string","description":"template body"},"size":{"$ref":"#/components/schemas/PaperSizeEnum"},"orientation":{"$ref":"#/components/schemas/PaperOrientationEnum"},"previewImage":{"type":"string","description":"base64 encoded image data"},"thousandSeparator":{"$ref":"#/components/schemas/ThousandSeparatorENUM"}}}}}}}},"paths":{"/tenants/{tenantUid}/poster-templates/{posterTemplateUid}":{"put":{"summary":"Update poster template","tags":["Poster"],"responses":{"200":{"$ref":"#/components/responses/PosterTemplateResponse"}},"operationId":"put-poster-templates-posterTemplateUid","description":"Update poster template\n\nRequired permissions: SUPERADMIN","requestBody":{"$ref":"#/components/requestBodies/PosterTemplateUpdateRequest"}}}}}
```

## Delete poster template

> Delete poster template\
> \
> Required permissions: SUPERADMIN

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Poster","description":"Poster"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}}},"paths":{"/tenants/{tenantUid}/poster-templates/{posterTemplateUid}":{"delete":{"summary":"Delete poster template","tags":["Poster"],"responses":{"204":{"description":"No Content"}},"operationId":"delete-poster-templates-posterTemplateUid","description":"Delete poster template\n\nRequired permissions: SUPERADMIN"}}}}
```

## Create poster PDF

> Create poster PDF for printing\
> \
> Required permissions: POSTER

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Poster","description":"Poster"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"requestBodies":{"PosterPrintRequest":{"content":{"application/json":{"schema":{"type":"object","required":["products"],"properties":{"products":{"type":"array","items":{"$ref":"#/components/schemas/PosterProductRequest"}}}}}}}},"schemas":{"PosterProductRequest":{"title":"PosterProductRequest","type":"object","properties":{"sku":{"type":"string"},"name":{"type":"string"},"nowPrice":{"type":"integer"},"beforePrice":{"type":"integer"},"discountPercentage":{"type":"integer"},"brandName":{"type":"string"},"description":{"type":"string"},"usps":{"type":"array","description":"Unique Selling Propositions","items":{"type":"string"}},"imageUrl":{"type":"string"},"barcodeValue":{"type":"string"},"properties":{"type":"array","items":{"type":"string"}}}}}},"paths":{"/tenants/{tenantUid}/poster-templates/{posterTemplateUid}/pdf":{"post":{"summary":"Create poster PDF","tags":["Poster"],"responses":{"201":{"description":"Created","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}}},"operationId":"post-poster-templates-pdf","description":"Create poster PDF for printing\n\nRequired permissions: POSTER","requestBody":{"$ref":"#/components/requestBodies/PosterPrintRequest"}}}}}
```

## List poster base templates

> List poster base templates that can be used for adaption to actual poster templates.\
> \
> Required permissions: POSTER

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Poster","description":"Poster"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"responses":{"PosterTemplateBaseListResponse":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PosterTemplateBaseSchema"}}}}}}}},"schemas":{"PosterTemplateBaseSchema":{"title":"PosterTemplateBaseSchema","type":"object","required":["name","size","orientation","html"],"properties":{"name":{"type":"string"},"size":{"$ref":"#/components/schemas/PaperSizeEnum"},"orientation":{"$ref":"#/components/schemas/PaperOrientationEnum"},"html":{"type":"string","description":"template body"}}},"PaperSizeEnum":{"title":"PaperSizeEnum","type":"string","enum":["A1","A2","A3","A4","A5","A6"]},"PaperOrientationEnum":{"title":"PaperOrientationEnum","type":"string","enum":["Portrait","Landscape"]}}},"paths":{"/tenants/{tenantUid}/poster-base-templates":{"get":{"summary":"List poster base templates","tags":["Poster"],"responses":{"200":{"$ref":"#/components/responses/PosterTemplateBaseListResponse"}},"operationId":"get-poster-base-templates","description":"List poster base templates that can be used for adaption to actual poster templates.\n\nRequired permissions: POSTER"}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.flowretail.com/api/poster.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.