# Import

Import

## List all import templates

> List all import templates

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Import","description":"Import"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"authToken":[]},{"integrationToken":[]},{"accessToken":[]}],"components":{"securitySchemes":{"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"},"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"}},"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"}},"schemas":{"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"},"ImportTemplateResponseSchema":{"title":"ImportTemplateResponseSchema","type":"object","required":["templateUid","name","description","createdBy","createdAt","lastModifiedBy","lastModifiedAt","layouts","entity","importFormat"],"properties":{"templateUid":{"$ref":"#/components/schemas/UID"},"name":{"type":"string"},"description":{"type":"string"},"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"layouts":{"type":"array","items":{"$ref":"#/components/schemas/ImportLayoutResponseSchema"}},"entity":{"$ref":"#/components/schemas/ImportEntityENUM"},"importFormat":{"$ref":"#/components/schemas/ImportFormatENUM"}}},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"ImportLayoutResponseSchema":{"title":"ImportLayoutResponseSchema","allOf":[{"type":"object","properties":{"layoutUid":{"$ref":"#/components/schemas/UID"},"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"conversions":{"type":"array","items":{"$ref":"#/components/schemas/ImportConversionResponseSchema"}}},"required":["layoutUid","conversions","createdBy","createdAt","lastModifiedBy","lastModifiedAt"]},{"$ref":"#/components/schemas/ImportLayoutUpdateRequestSchema"}]},"ImportConversionResponseSchema":{"title":"ImportConversionResponseSchema","allOf":[{"type":"object","properties":{"conversionUid":{"$ref":"#/components/schemas/UID"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"}},"required":["conversionUid","createdAt","createdBy","lastModifiedAt","lastModifiedBy"]},{"$ref":"#/components/schemas/ImportConversionUpdateRequestSchema"}]},"ImportConversionUpdateRequestSchema":{"title":"ImportConversionUpdateRequestSchema","type":"object","properties":{"fromValue":{"type":"string"},"toValue":{"type":"string"}},"required":["fromValue","toValue"]},"ImportLayoutUpdateRequestSchema":{"title":"ImportLayoutUpdateRequestSchema","type":"object","properties":{"fieldName":{"type":"string","description":"Entity field name in FlowRetail"},"value":{"type":"string","description":"Static value, or reference to field in import file.\n\nExample: For EXCEL import use `A` to get the value from column A"}},"required":["fieldName","value"]},"ImportEntityENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| PRODUCTS | Import products |\n| PRICES | Import prices|\n| PRODUCT_GROUPS | Import product groups |\n| BRANDS | Import brands|\n| CUSTOMERS | Import customers|\n| STOCK | Import stock values|\n| SUPPLIER_PRODUCT | Import Product supplier information|\n| SUPPLIERS | Import suppliers|","minLength":1,"title":"ImportEntityENUM","type":"string","enum":["PRODUCTS","PRICES","PRODUCT_GROUPS","BRANDS","CUSTOMERS","STOCK","SUPPLIER_PRODUCT","SUPPLIERS"]},"ImportFormatENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| EXCEL | XLS file |\n","minLength":1,"title":"ImportFormatENUM","type":"string","enum":["EXCEL"]},"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"}},"responses":{"ImportTemplateListResponse":{"content":{"application/json":{"schema":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ImportTemplateResponseSchema"},"type":"array"},"paging":{"$ref":"#/components/schemas/Paging"}},"required":["items","paging"],"type":"object"}}},"description":"Example response"}}},"paths":{"/tenants/{tenantUid}/imports/templates":{"get":{"description":"List all import templates","operationId":"get-tenants-imports-templates","parameters":[{"$ref":"#/components/parameters/pageNumberQuery"},{"$ref":"#/components/parameters/pageSizeQuery"},{"$ref":"#/components/parameters/sortByQuery"},{"$ref":"#/components/parameters/sortDirectionQuery"}],"responses":{"200":{"$ref":"#/components/responses/ImportTemplateListResponse"}},"summary":"List all import templates","tags":["Import"]}}}}
```

## Create import template

> Create import template\
> \
> Required permissions: IMPORT

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Import","description":"Import"}],"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":{"ImportTemplateResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportTemplateResponseSchema"}}}}},"schemas":{"ImportTemplateResponseSchema":{"title":"ImportTemplateResponseSchema","type":"object","required":["templateUid","name","description","createdBy","createdAt","lastModifiedBy","lastModifiedAt","layouts","entity","importFormat"],"properties":{"templateUid":{"$ref":"#/components/schemas/UID"},"name":{"type":"string"},"description":{"type":"string"},"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"layouts":{"type":"array","items":{"$ref":"#/components/schemas/ImportLayoutResponseSchema"}},"entity":{"$ref":"#/components/schemas/ImportEntityENUM"},"importFormat":{"$ref":"#/components/schemas/ImportFormatENUM"}}},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"ImportLayoutResponseSchema":{"title":"ImportLayoutResponseSchema","allOf":[{"type":"object","properties":{"layoutUid":{"$ref":"#/components/schemas/UID"},"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"conversions":{"type":"array","items":{"$ref":"#/components/schemas/ImportConversionResponseSchema"}}},"required":["layoutUid","conversions","createdBy","createdAt","lastModifiedBy","lastModifiedAt"]},{"$ref":"#/components/schemas/ImportLayoutUpdateRequestSchema"}]},"ImportConversionResponseSchema":{"title":"ImportConversionResponseSchema","allOf":[{"type":"object","properties":{"conversionUid":{"$ref":"#/components/schemas/UID"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"}},"required":["conversionUid","createdAt","createdBy","lastModifiedAt","lastModifiedBy"]},{"$ref":"#/components/schemas/ImportConversionUpdateRequestSchema"}]},"ImportConversionUpdateRequestSchema":{"title":"ImportConversionUpdateRequestSchema","type":"object","properties":{"fromValue":{"type":"string"},"toValue":{"type":"string"}},"required":["fromValue","toValue"]},"ImportLayoutUpdateRequestSchema":{"title":"ImportLayoutUpdateRequestSchema","type":"object","properties":{"fieldName":{"type":"string","description":"Entity field name in FlowRetail"},"value":{"type":"string","description":"Static value, or reference to field in import file.\n\nExample: For EXCEL import use `A` to get the value from column A"}},"required":["fieldName","value"]},"ImportEntityENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| PRODUCTS | Import products |\n| PRICES | Import prices|\n| PRODUCT_GROUPS | Import product groups |\n| BRANDS | Import brands|\n| CUSTOMERS | Import customers|\n| STOCK | Import stock values|\n| SUPPLIER_PRODUCT | Import Product supplier information|\n| SUPPLIERS | Import suppliers|","minLength":1,"title":"ImportEntityENUM","type":"string","enum":["PRODUCTS","PRICES","PRODUCT_GROUPS","BRANDS","CUSTOMERS","STOCK","SUPPLIER_PRODUCT","SUPPLIERS"]},"ImportFormatENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| EXCEL | XLS file |\n","minLength":1,"title":"ImportFormatENUM","type":"string","enum":["EXCEL"]},"ImportTemplateCreateRequestSchema":{"title":"ImportTemplateCreateRequestSchema","type":"object","required":["name","entity","importFormat"],"properties":{"name":{"type":"string"},"description":{"type":"string"},"entity":{"$ref":"#/components/schemas/ImportEntityENUM"},"importFormat":{"$ref":"#/components/schemas/ImportFormatENUM"},"templateUid":{"$ref":"#/components/schemas/UID"}}}},"requestBodies":{"ImportTemplateCreateRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportTemplateCreateRequestSchema"}}}}}},"paths":{"/tenants/{tenantUid}/imports/templates":{"post":{"summary":"Create import template","operationId":"post-tenants-imports-templates","responses":{"200":{"$ref":"#/components/responses/ImportTemplateResponse"}},"requestBody":{"$ref":"#/components/requestBodies/ImportTemplateCreateRequest"},"description":"Create import template\n\nRequired permissions: IMPORT","tags":["Import"]}}}}
```

## Get import template details

> Get import template details.\
> When includeLayouts is true, the response contains all layouts for the template.\
> If includeConversions is also true, the response also contains all conversions for every layout.\
> includeConversions is only honored if  includeLayouts is true\
> \
> Required permissions: IMPORT

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Import","description":"Import"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"authToken":[]},{"integrationToken":[]},{"accessToken":[]}],"components":{"securitySchemes":{"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"},"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"}},"parameters":{"includeLayoutsQuery":{"name":"includeLayouts","in":"query","required":false,"schema":{"type":"boolean"},"description":"Include layouts in response"},"includeConversionsQuery":{"name":"includeConversions","in":"query","required":false,"schema":{"type":"boolean"},"description":"Include conversions in response"}},"responses":{"ImportTemplateResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportTemplateResponseSchema"}}}}},"schemas":{"ImportTemplateResponseSchema":{"title":"ImportTemplateResponseSchema","type":"object","required":["templateUid","name","description","createdBy","createdAt","lastModifiedBy","lastModifiedAt","layouts","entity","importFormat"],"properties":{"templateUid":{"$ref":"#/components/schemas/UID"},"name":{"type":"string"},"description":{"type":"string"},"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"layouts":{"type":"array","items":{"$ref":"#/components/schemas/ImportLayoutResponseSchema"}},"entity":{"$ref":"#/components/schemas/ImportEntityENUM"},"importFormat":{"$ref":"#/components/schemas/ImportFormatENUM"}}},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"ImportLayoutResponseSchema":{"title":"ImportLayoutResponseSchema","allOf":[{"type":"object","properties":{"layoutUid":{"$ref":"#/components/schemas/UID"},"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"conversions":{"type":"array","items":{"$ref":"#/components/schemas/ImportConversionResponseSchema"}}},"required":["layoutUid","conversions","createdBy","createdAt","lastModifiedBy","lastModifiedAt"]},{"$ref":"#/components/schemas/ImportLayoutUpdateRequestSchema"}]},"ImportConversionResponseSchema":{"title":"ImportConversionResponseSchema","allOf":[{"type":"object","properties":{"conversionUid":{"$ref":"#/components/schemas/UID"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"}},"required":["conversionUid","createdAt","createdBy","lastModifiedAt","lastModifiedBy"]},{"$ref":"#/components/schemas/ImportConversionUpdateRequestSchema"}]},"ImportConversionUpdateRequestSchema":{"title":"ImportConversionUpdateRequestSchema","type":"object","properties":{"fromValue":{"type":"string"},"toValue":{"type":"string"}},"required":["fromValue","toValue"]},"ImportLayoutUpdateRequestSchema":{"title":"ImportLayoutUpdateRequestSchema","type":"object","properties":{"fieldName":{"type":"string","description":"Entity field name in FlowRetail"},"value":{"type":"string","description":"Static value, or reference to field in import file.\n\nExample: For EXCEL import use `A` to get the value from column A"}},"required":["fieldName","value"]},"ImportEntityENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| PRODUCTS | Import products |\n| PRICES | Import prices|\n| PRODUCT_GROUPS | Import product groups |\n| BRANDS | Import brands|\n| CUSTOMERS | Import customers|\n| STOCK | Import stock values|\n| SUPPLIER_PRODUCT | Import Product supplier information|\n| SUPPLIERS | Import suppliers|","minLength":1,"title":"ImportEntityENUM","type":"string","enum":["PRODUCTS","PRICES","PRODUCT_GROUPS","BRANDS","CUSTOMERS","STOCK","SUPPLIER_PRODUCT","SUPPLIERS"]},"ImportFormatENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| EXCEL | XLS file |\n","minLength":1,"title":"ImportFormatENUM","type":"string","enum":["EXCEL"]}}},"paths":{"/tenants/{tenantUid}/imports/templates/{importTemplateUid}":{"get":{"description":"Get import template details.\nWhen includeLayouts is true, the response contains all layouts for the template.\nIf includeConversions is also true, the response also contains all conversions for every layout.\nincludeConversions is only honored if  includeLayouts is true\n\nRequired permissions: IMPORT","operationId":"get-tenants-imports-templates-details","parameters":[{"$ref":"#/components/parameters/includeLayoutsQuery"},{"$ref":"#/components/parameters/includeConversionsQuery"}],"responses":{"200":{"$ref":"#/components/responses/ImportTemplateResponse"}},"summary":"Get import template details","tags":["Import"]}}}}
```

## Update import template

> Update import template\
> \
> Required permissions: IMPORT

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Import","description":"Import"}],"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":{"ImportTemplateResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportTemplateResponseSchema"}}}}},"schemas":{"ImportTemplateResponseSchema":{"title":"ImportTemplateResponseSchema","type":"object","required":["templateUid","name","description","createdBy","createdAt","lastModifiedBy","lastModifiedAt","layouts","entity","importFormat"],"properties":{"templateUid":{"$ref":"#/components/schemas/UID"},"name":{"type":"string"},"description":{"type":"string"},"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"layouts":{"type":"array","items":{"$ref":"#/components/schemas/ImportLayoutResponseSchema"}},"entity":{"$ref":"#/components/schemas/ImportEntityENUM"},"importFormat":{"$ref":"#/components/schemas/ImportFormatENUM"}}},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"ImportLayoutResponseSchema":{"title":"ImportLayoutResponseSchema","allOf":[{"type":"object","properties":{"layoutUid":{"$ref":"#/components/schemas/UID"},"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"conversions":{"type":"array","items":{"$ref":"#/components/schemas/ImportConversionResponseSchema"}}},"required":["layoutUid","conversions","createdBy","createdAt","lastModifiedBy","lastModifiedAt"]},{"$ref":"#/components/schemas/ImportLayoutUpdateRequestSchema"}]},"ImportConversionResponseSchema":{"title":"ImportConversionResponseSchema","allOf":[{"type":"object","properties":{"conversionUid":{"$ref":"#/components/schemas/UID"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"}},"required":["conversionUid","createdAt","createdBy","lastModifiedAt","lastModifiedBy"]},{"$ref":"#/components/schemas/ImportConversionUpdateRequestSchema"}]},"ImportConversionUpdateRequestSchema":{"title":"ImportConversionUpdateRequestSchema","type":"object","properties":{"fromValue":{"type":"string"},"toValue":{"type":"string"}},"required":["fromValue","toValue"]},"ImportLayoutUpdateRequestSchema":{"title":"ImportLayoutUpdateRequestSchema","type":"object","properties":{"fieldName":{"type":"string","description":"Entity field name in FlowRetail"},"value":{"type":"string","description":"Static value, or reference to field in import file.\n\nExample: For EXCEL import use `A` to get the value from column A"}},"required":["fieldName","value"]},"ImportEntityENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| PRODUCTS | Import products |\n| PRICES | Import prices|\n| PRODUCT_GROUPS | Import product groups |\n| BRANDS | Import brands|\n| CUSTOMERS | Import customers|\n| STOCK | Import stock values|\n| SUPPLIER_PRODUCT | Import Product supplier information|\n| SUPPLIERS | Import suppliers|","minLength":1,"title":"ImportEntityENUM","type":"string","enum":["PRODUCTS","PRICES","PRODUCT_GROUPS","BRANDS","CUSTOMERS","STOCK","SUPPLIER_PRODUCT","SUPPLIERS"]},"ImportFormatENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| EXCEL | XLS file |\n","minLength":1,"title":"ImportFormatENUM","type":"string","enum":["EXCEL"]},"ImportTemplateUpdateRequestSchema":{"title":"ImportTemplateUpdateRequestSchema","type":"object","required":["name"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}}},"requestBodies":{"ImportTemplateUpdateRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportTemplateUpdateRequestSchema"}}}}}},"paths":{"/tenants/{tenantUid}/imports/templates/{importTemplateUid}":{"put":{"summary":"Update import template","operationId":"put-tenants-imports-templates-details","responses":{"200":{"$ref":"#/components/responses/ImportTemplateResponse"}},"requestBody":{"$ref":"#/components/requestBodies/ImportTemplateUpdateRequest"},"description":"Update import template\n\nRequired permissions: IMPORT","tags":["Import"]}}}}
```

## Delete an Import template

> Delete an Import template\
> \
> Required permissions: IMPORT

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Import","description":"Import"}],"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}/imports/templates/{importTemplateUid}":{"delete":{"summary":"Delete an Import template","operationId":"delete-tenants-imports-templates-details","responses":{"204":{"description":"No Content"}},"description":"Delete an Import template\n\nRequired permissions: IMPORT","tags":["Import"]}}}}
```

## List layouts for a  import template

> List layouts for a  import template \
> \
> Required permissions: IMPORT

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Import","description":"Import"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"authToken":[]},{"integrationToken":[]},{"accessToken":[]}],"components":{"securitySchemes":{"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"},"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"}},"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"}},"schemas":{"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"},"ImportLayoutResponseSchema":{"title":"ImportLayoutResponseSchema","allOf":[{"type":"object","properties":{"layoutUid":{"$ref":"#/components/schemas/UID"},"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"conversions":{"type":"array","items":{"$ref":"#/components/schemas/ImportConversionResponseSchema"}}},"required":["layoutUid","conversions","createdBy","createdAt","lastModifiedBy","lastModifiedAt"]},{"$ref":"#/components/schemas/ImportLayoutUpdateRequestSchema"}]},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"ImportConversionResponseSchema":{"title":"ImportConversionResponseSchema","allOf":[{"type":"object","properties":{"conversionUid":{"$ref":"#/components/schemas/UID"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"}},"required":["conversionUid","createdAt","createdBy","lastModifiedAt","lastModifiedBy"]},{"$ref":"#/components/schemas/ImportConversionUpdateRequestSchema"}]},"ImportConversionUpdateRequestSchema":{"title":"ImportConversionUpdateRequestSchema","type":"object","properties":{"fromValue":{"type":"string"},"toValue":{"type":"string"}},"required":["fromValue","toValue"]},"ImportLayoutUpdateRequestSchema":{"title":"ImportLayoutUpdateRequestSchema","type":"object","properties":{"fieldName":{"type":"string","description":"Entity field name in FlowRetail"},"value":{"type":"string","description":"Static value, or reference to field in import file.\n\nExample: For EXCEL import use `A` to get the value from column A"}},"required":["fieldName","value"]},"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"}},"responses":{"ImportLayoutListResponse":{"content":{"application/json":{"schema":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ImportLayoutResponseSchema"},"type":"array"},"paging":{"$ref":"#/components/schemas/Paging"}},"required":["items","paging"],"type":"object"}}},"description":"Example response"}}},"paths":{"/tenants/{tenantUid}/imports/templates/{importTemplateUid}/layouts":{"get":{"description":"List layouts for a  import template \n\nRequired permissions: IMPORT","operationId":"get-tenants-imports-layouts","parameters":[{"$ref":"#/components/parameters/pageNumberQuery"},{"$ref":"#/components/parameters/pageSizeQuery"},{"$ref":"#/components/parameters/sortByQuery"},{"$ref":"#/components/parameters/sortDirectionQuery"}],"responses":{"200":{"$ref":"#/components/responses/ImportLayoutListResponse"}},"summary":"List layouts for a  import template","tags":["Import"]}}}}
```

## Create layout for an import template

> Create layout for an import template\
> \
> Required permissions: IMPORT

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Import","description":"Import"}],"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":{"ImportLayoutResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportLayoutResponseSchema"}}}}},"schemas":{"ImportLayoutResponseSchema":{"title":"ImportLayoutResponseSchema","allOf":[{"type":"object","properties":{"layoutUid":{"$ref":"#/components/schemas/UID"},"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"conversions":{"type":"array","items":{"$ref":"#/components/schemas/ImportConversionResponseSchema"}}},"required":["layoutUid","conversions","createdBy","createdAt","lastModifiedBy","lastModifiedAt"]},{"$ref":"#/components/schemas/ImportLayoutUpdateRequestSchema"}]},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"ImportConversionResponseSchema":{"title":"ImportConversionResponseSchema","allOf":[{"type":"object","properties":{"conversionUid":{"$ref":"#/components/schemas/UID"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"}},"required":["conversionUid","createdAt","createdBy","lastModifiedAt","lastModifiedBy"]},{"$ref":"#/components/schemas/ImportConversionUpdateRequestSchema"}]},"ImportConversionUpdateRequestSchema":{"title":"ImportConversionUpdateRequestSchema","type":"object","properties":{"fromValue":{"type":"string"},"toValue":{"type":"string"}},"required":["fromValue","toValue"]},"ImportLayoutUpdateRequestSchema":{"title":"ImportLayoutUpdateRequestSchema","type":"object","properties":{"fieldName":{"type":"string","description":"Entity field name in FlowRetail"},"value":{"type":"string","description":"Static value, or reference to field in import file.\n\nExample: For EXCEL import use `A` to get the value from column A"}},"required":["fieldName","value"]},"ImportLayoutCreateRequestSchema":{"allOf":[{"$ref":"#/components/schemas/ImportLayoutUpdateRequestSchema"},{"properties":{"layoutUid":{"$ref":"#/components/schemas/UID"}},"type":"object"}],"title":"ImportLayoutCreateRequestSchema"}},"requestBodies":{"ImportLayoutCreateRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportLayoutCreateRequestSchema"}}}}}},"paths":{"/tenants/{tenantUid}/imports/templates/{importTemplateUid}/layouts":{"post":{"summary":"Create layout for an import template","operationId":"post-tenants-imports-layouts","responses":{"200":{"$ref":"#/components/responses/ImportLayoutResponse"}},"requestBody":{"$ref":"#/components/requestBodies/ImportLayoutCreateRequest"},"description":"Create layout for an import template\n\nRequired permissions: IMPORT","tags":["Import"]}}}}
```

## Get layout details for an import template

> Get import layout details\
> \
> Required permissions: IMPORT

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Import","description":"Import"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"authToken":[]},{"integrationToken":[]},{"accessToken":[]}],"components":{"securitySchemes":{"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"},"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"}},"parameters":{"includeConversionsQuery":{"name":"includeConversions","in":"query","required":false,"schema":{"type":"boolean"},"description":"Include conversions in response"}},"responses":{"ImportLayoutResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportLayoutResponseSchema"}}}}},"schemas":{"ImportLayoutResponseSchema":{"title":"ImportLayoutResponseSchema","allOf":[{"type":"object","properties":{"layoutUid":{"$ref":"#/components/schemas/UID"},"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"conversions":{"type":"array","items":{"$ref":"#/components/schemas/ImportConversionResponseSchema"}}},"required":["layoutUid","conversions","createdBy","createdAt","lastModifiedBy","lastModifiedAt"]},{"$ref":"#/components/schemas/ImportLayoutUpdateRequestSchema"}]},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"ImportConversionResponseSchema":{"title":"ImportConversionResponseSchema","allOf":[{"type":"object","properties":{"conversionUid":{"$ref":"#/components/schemas/UID"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"}},"required":["conversionUid","createdAt","createdBy","lastModifiedAt","lastModifiedBy"]},{"$ref":"#/components/schemas/ImportConversionUpdateRequestSchema"}]},"ImportConversionUpdateRequestSchema":{"title":"ImportConversionUpdateRequestSchema","type":"object","properties":{"fromValue":{"type":"string"},"toValue":{"type":"string"}},"required":["fromValue","toValue"]},"ImportLayoutUpdateRequestSchema":{"title":"ImportLayoutUpdateRequestSchema","type":"object","properties":{"fieldName":{"type":"string","description":"Entity field name in FlowRetail"},"value":{"type":"string","description":"Static value, or reference to field in import file.\n\nExample: For EXCEL import use `A` to get the value from column A"}},"required":["fieldName","value"]}}},"paths":{"/tenants/{tenantUid}/imports/templates/{importTemplateUid}/layouts/{importLayoutUid}":{"get":{"description":"Get import layout details\n\nRequired permissions: IMPORT","operationId":"get-tenants-imports-layouts-details","parameters":[{"$ref":"#/components/parameters/includeConversionsQuery"}],"responses":{"200":{"$ref":"#/components/responses/ImportLayoutResponse"}},"summary":"Get layout details for an import template","tags":["Import"]}}}}
```

## Update layout for an import template

> Update import layout\
> \
> Required permissions: IMPORT

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Import","description":"Import"}],"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":{"ImportLayoutResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportLayoutResponseSchema"}}}}},"schemas":{"ImportLayoutResponseSchema":{"title":"ImportLayoutResponseSchema","allOf":[{"type":"object","properties":{"layoutUid":{"$ref":"#/components/schemas/UID"},"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"conversions":{"type":"array","items":{"$ref":"#/components/schemas/ImportConversionResponseSchema"}}},"required":["layoutUid","conversions","createdBy","createdAt","lastModifiedBy","lastModifiedAt"]},{"$ref":"#/components/schemas/ImportLayoutUpdateRequestSchema"}]},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"ImportConversionResponseSchema":{"title":"ImportConversionResponseSchema","allOf":[{"type":"object","properties":{"conversionUid":{"$ref":"#/components/schemas/UID"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"}},"required":["conversionUid","createdAt","createdBy","lastModifiedAt","lastModifiedBy"]},{"$ref":"#/components/schemas/ImportConversionUpdateRequestSchema"}]},"ImportConversionUpdateRequestSchema":{"title":"ImportConversionUpdateRequestSchema","type":"object","properties":{"fromValue":{"type":"string"},"toValue":{"type":"string"}},"required":["fromValue","toValue"]},"ImportLayoutUpdateRequestSchema":{"title":"ImportLayoutUpdateRequestSchema","type":"object","properties":{"fieldName":{"type":"string","description":"Entity field name in FlowRetail"},"value":{"type":"string","description":"Static value, or reference to field in import file.\n\nExample: For EXCEL import use `A` to get the value from column A"}},"required":["fieldName","value"]}},"requestBodies":{"ImportLayoutUpdateRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportLayoutUpdateRequestSchema"}}}}}},"paths":{"/tenants/{tenantUid}/imports/templates/{importTemplateUid}/layouts/{importLayoutUid}":{"put":{"summary":"Update layout for an import template","operationId":"put-tenants-imports-layouts-detail","responses":{"200":{"$ref":"#/components/responses/ImportLayoutResponse"}},"requestBody":{"$ref":"#/components/requestBodies/ImportLayoutUpdateRequest"},"description":"Update import layout\n\nRequired permissions: IMPORT","tags":["Import"]}}}}
```

## Delete a layout  for an import template

> Delete an Import layout\
> \
> Required permissions: IMPORT

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Import","description":"Import"}],"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}/imports/templates/{importTemplateUid}/layouts/{importLayoutUid}":{"delete":{"summary":"Delete a layout  for an import template","operationId":"delete-tenants-imports-layouts-details","responses":{"204":{"description":"No Content"}},"description":"Delete an Import layout\n\nRequired permissions: IMPORT","tags":["Import"]}}}}
```

## List import files

> List import files. Use query parameter to narrow list\
> \
> Required permissions: IMPORT

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Import","description":"Import"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"authToken":[]},{"integrationToken":[]},{"accessToken":[]}],"components":{"securitySchemes":{"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"},"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"}},"parameters":{"importTemplateUidsQuery":{"description":"Reference to a Import Template.","in":"query","name":"importTemplateUids","required":false,"schema":{"items":{"$ref":"#/components/schemas/UID"},"type":"array"},"style":"form"},"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"},"importFileStateQuery":{"description":"Reference to a importfile state.","in":"query","name":"importFileState","required":false,"schema":{"$ref":"#/components/schemas/ImportStateENUM"}}},"schemas":{"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"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"},"ImportStateENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| NOT_STARTED | Import not started |\n| IMPORT_IN_PROGRESS | Import is running |\n| IMPORT_ABORT | Import is aborting| \n| IMPORT_ABORTED | Import has been aborted |\n| VALIDATE_IN_PROGRESS | Validate is running| \n| COMPLETE_NOTHING_TO_IMPORT | Import is done, but there where nothing to import |\n| COMPLETE | Import complete |\n| VALIDATE_FAILED | Validate failed |\n| IMPORT_FAILED | Import failed |\n| IMPORT_ABORT | Import is aborting |\n| IMPORT_ABORTED | Import has been aborted  |\n| READY_TO_IMPORT | Validation OK, import is ready |\n","minLength":1,"title":"ImportStateENUM","type":"string","enum":["NOT_STARTED","COMPLETE","COMPLETE_NOTHING_TO_IMPORT","IMPORT_FAILED","IMPORT_ABORT","IMPORT_ABORTED","VALIDATE_FAILED","VALIDATE_ABORT","VALIDATE_ABORTED","IMPORT_IN_PROGRESS","VALIDATE_IN_PROGRESS","READY_TO_IMPORT"]},"ImportFileResponseSchema":{"title":"ImportFileResponseSchema","allOf":[{"$ref":"#/components/schemas/ImportFileBasicResponseSchema"},{"type":"object","required":["template"],"properties":{"template":{"$ref":"#/components/schemas/ImportTemplateResponseSchema"}}}]},"ImportFileBasicResponseSchema":{"title":"ImportFileBasicResponseSchema","type":"object","required":["importFileUid","createdBy","createdAt","lastModifiedBy","lastModifiedAt","state","filename","columnCount","rowCount","progressCount","errorCount","ignoredCount","estimatedRemainingTime","estimatedRemainingTimeText","totalTime","operation","errorMessage"],"properties":{"importFileUid":{"$ref":"#/components/schemas/UID"},"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"state":{"$ref":"#/components/schemas/ImportStateENUM"},"filename":{"type":"string"},"columnCount":{"type":"integer"},"rowCount":{"type":"integer","description":"header row is not counted"},"progressCount":{"type":"integer"},"errorCount":{"type":"integer"},"ignoredCount":{"type":"integer","description":"unprocessed rows"},"estimatedRemainingTime":{"type":"integer","description":"in hundreths of a second"},"estimatedRemainingTimeText":{"type":"string"},"totalTime":{"type":"integer","description":"in hundreths of a second"},"operation":{"$ref":"#/components/schemas/ImportOperationENUM"},"errorMessage":{"type":"string"}}},"ImportOperationENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| INSERT | Only insert non-existing records, existing records will be ignored|\n| UPDATE | Only update existing records, non-existing records will be ignored|\n| UPSERT | non-existing records will be inserted, existing records will be updated|\n","minLength":1,"title":"ImportOperationENUM","type":"string","enum":["INSERT","UPDATE","UPSERT"]},"ImportTemplateResponseSchema":{"title":"ImportTemplateResponseSchema","type":"object","required":["templateUid","name","description","createdBy","createdAt","lastModifiedBy","lastModifiedAt","layouts","entity","importFormat"],"properties":{"templateUid":{"$ref":"#/components/schemas/UID"},"name":{"type":"string"},"description":{"type":"string"},"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"layouts":{"type":"array","items":{"$ref":"#/components/schemas/ImportLayoutResponseSchema"}},"entity":{"$ref":"#/components/schemas/ImportEntityENUM"},"importFormat":{"$ref":"#/components/schemas/ImportFormatENUM"}}},"ImportLayoutResponseSchema":{"title":"ImportLayoutResponseSchema","allOf":[{"type":"object","properties":{"layoutUid":{"$ref":"#/components/schemas/UID"},"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"conversions":{"type":"array","items":{"$ref":"#/components/schemas/ImportConversionResponseSchema"}}},"required":["layoutUid","conversions","createdBy","createdAt","lastModifiedBy","lastModifiedAt"]},{"$ref":"#/components/schemas/ImportLayoutUpdateRequestSchema"}]},"ImportConversionResponseSchema":{"title":"ImportConversionResponseSchema","allOf":[{"type":"object","properties":{"conversionUid":{"$ref":"#/components/schemas/UID"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"}},"required":["conversionUid","createdAt","createdBy","lastModifiedAt","lastModifiedBy"]},{"$ref":"#/components/schemas/ImportConversionUpdateRequestSchema"}]},"ImportConversionUpdateRequestSchema":{"title":"ImportConversionUpdateRequestSchema","type":"object","properties":{"fromValue":{"type":"string"},"toValue":{"type":"string"}},"required":["fromValue","toValue"]},"ImportLayoutUpdateRequestSchema":{"title":"ImportLayoutUpdateRequestSchema","type":"object","properties":{"fieldName":{"type":"string","description":"Entity field name in FlowRetail"},"value":{"type":"string","description":"Static value, or reference to field in import file.\n\nExample: For EXCEL import use `A` to get the value from column A"}},"required":["fieldName","value"]},"ImportEntityENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| PRODUCTS | Import products |\n| PRICES | Import prices|\n| PRODUCT_GROUPS | Import product groups |\n| BRANDS | Import brands|\n| CUSTOMERS | Import customers|\n| STOCK | Import stock values|\n| SUPPLIER_PRODUCT | Import Product supplier information|\n| SUPPLIERS | Import suppliers|","minLength":1,"title":"ImportEntityENUM","type":"string","enum":["PRODUCTS","PRICES","PRODUCT_GROUPS","BRANDS","CUSTOMERS","STOCK","SUPPLIER_PRODUCT","SUPPLIERS"]},"ImportFormatENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| EXCEL | XLS file |\n","minLength":1,"title":"ImportFormatENUM","type":"string","enum":["EXCEL"]},"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"}},"responses":{"ImportFilesListResponse":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ImportFileResponseSchema"}},"paging":{"$ref":"#/components/schemas/Paging"}},"required":["items","paging"]}}}}}},"paths":{"/tenants/{tenantUid}/imports/files":{"get":{"description":"List import files. Use query parameter to narrow list\n\nRequired permissions: IMPORT","operationId":"get-tenants-imports-files","parameters":[{"$ref":"#/components/parameters/importTemplateUidsQuery"},{"$ref":"#/components/parameters/pageNumberQuery"},{"$ref":"#/components/parameters/pageSizeQuery"},{"$ref":"#/components/parameters/sortByQuery"},{"$ref":"#/components/parameters/sortDirectionQuery"},{"$ref":"#/components/parameters/importFileStateQuery"}],"responses":{"200":{"$ref":"#/components/responses/ImportFilesListResponse"}},"summary":"List import files","tags":["Import"]}}}}
```

## Process or simulate import

> This will create and return a new import file record with state \`NOT\_STARTED\` and the \`importFileUid\`.\
> The validation and import is processed in a new thread \
> that will update the import progress every 5 seconds. \
> To fetch the current state, use the \`Get import-file details\` endpoint.\
> \
> Use action \`PROCESS\` to commit the import upon validation. \
> If no errors occur the import state is \`COMPLETE\`.\
> \
> Use action \`SIMULATE\` if you do not want to commit the import data and only validat. \
> If no errors occur the import state will be \`READY\_TO\_IMPORT\`.\
> \
> Use the \`Execute import content\` endpoint to abort the processing or \
> to commit (execute) a successful simulation.\
> \
> Required permissions: IMPORT<br>

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Import","description":"Import"}],"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":{"ImportFileDataResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportFileDataResponseSchema"}}}}},"schemas":{"ImportFileDataResponseSchema":{"title":"ImportFileDataResponseSchema","type":"object","properties":{"templateUid":{"$ref":"#/components/schemas/UID"},"base64Data":{"type":"string"},"contentType":{"type":"string"},"action":{"$ref":"#/components/schemas/ImportActionENUM"},"importFileUid":{"$ref":"#/components/schemas/OptionalUID"},"operation":{"$ref":"#/components/schemas/ImportOperationENUM"},"state":{"$ref":"#/components/schemas/ImportStateENUM"}},"required":["templateUid","base64Data","contentType","action","importFileUid","operation","state"]},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"ImportActionENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| SIMULATE | Do a simulate on import. Return content without saving |\n| PROCESS | Process file with given template. Save file if no errors|\n","minLength":1,"title":"ImportActionENUM","type":"string","enum":["SIMULATE","PROCESS"]},"OptionalUID":{"title":"OptionalUID","type":"string","pattern":"^[A-Za-z0-9-_]*"},"ImportOperationENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| INSERT | Only insert non-existing records, existing records will be ignored|\n| UPDATE | Only update existing records, non-existing records will be ignored|\n| UPSERT | non-existing records will be inserted, existing records will be updated|\n","minLength":1,"title":"ImportOperationENUM","type":"string","enum":["INSERT","UPDATE","UPSERT"]},"ImportStateENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| NOT_STARTED | Import not started |\n| IMPORT_IN_PROGRESS | Import is running |\n| IMPORT_ABORT | Import is aborting| \n| IMPORT_ABORTED | Import has been aborted |\n| VALIDATE_IN_PROGRESS | Validate is running| \n| COMPLETE_NOTHING_TO_IMPORT | Import is done, but there where nothing to import |\n| COMPLETE | Import complete |\n| VALIDATE_FAILED | Validate failed |\n| IMPORT_FAILED | Import failed |\n| IMPORT_ABORT | Import is aborting |\n| IMPORT_ABORTED | Import has been aborted  |\n| READY_TO_IMPORT | Validation OK, import is ready |\n","minLength":1,"title":"ImportStateENUM","type":"string","enum":["NOT_STARTED","COMPLETE","COMPLETE_NOTHING_TO_IMPORT","IMPORT_FAILED","IMPORT_ABORT","IMPORT_ABORTED","VALIDATE_FAILED","VALIDATE_ABORT","VALIDATE_ABORTED","IMPORT_IN_PROGRESS","VALIDATE_IN_PROGRESS","READY_TO_IMPORT"]},"ImportFileRequestSchema":{"title":"ImportFileRequestSchema","type":"object","properties":{"templateUid":{"$ref":"#/components/schemas/UID"},"base64Data":{"type":"string","description":"base64 encoded data to be processed"},"operation":{"$ref":"#/components/schemas/ImportOperationENUM"},"action":{"$ref":"#/components/schemas/ImportActionENUM"},"importFileUid":{"$ref":"#/components/schemas/UID"}},"required":["templateUid","base64Data","operation","action"]}},"requestBodies":{"ImportFileRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportFileRequestSchema"}}}}}},"paths":{"/tenants/{tenantUid}/imports/files":{"post":{"summary":"Process or simulate import","operationId":"post-tenants-imports-files","responses":{"200":{"$ref":"#/components/responses/ImportFileDataResponse"}},"description":"This will create and return a new import file record with state `NOT_STARTED` and the `importFileUid`.\nThe validation and import is processed in a new thread \nthat will update the import progress every 5 seconds. \nTo fetch the current state, use the `Get import-file details` endpoint.\n\nUse action `PROCESS` to commit the import upon validation. \nIf no errors occur the import state is `COMPLETE`.\n\nUse action `SIMULATE` if you do not want to commit the import data and only validat. \nIf no errors occur the import state will be `READY_TO_IMPORT`.\n\nUse the `Execute import content` endpoint to abort the processing or \nto commit (execute) a successful simulation.\n\nRequired permissions: IMPORT\n","requestBody":{"$ref":"#/components/requestBodies/ImportFileRequest"},"tags":["Import"]}}}}
```

## Get importfile details

> Get importfile details

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Import","description":"Import"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"authToken":[]},{"integrationToken":[]},{"accessToken":[]}],"components":{"securitySchemes":{"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"},"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"}},"responses":{"ImportFileDetailResponse":{"description":"Example response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ImportFileDetailResponseSchema"},{"$ref":"#/components/schemas/ImportFileBasicResponseSchema"}]}}}}},"schemas":{"ImportFileDetailResponseSchema":{"title":"ImportFileResponseSchema","allOf":[{"$ref":"#/components/schemas/ImportFileResponseSchema"},{"type":"object","properties":{"base64Data":{"type":"string","description":"base64 encoded data of response.\nDeprecated: Use the download endpoint instead","deprecated":true}}}]},"ImportFileResponseSchema":{"title":"ImportFileResponseSchema","allOf":[{"$ref":"#/components/schemas/ImportFileBasicResponseSchema"},{"type":"object","required":["template"],"properties":{"template":{"$ref":"#/components/schemas/ImportTemplateResponseSchema"}}}]},"ImportFileBasicResponseSchema":{"title":"ImportFileBasicResponseSchema","type":"object","required":["importFileUid","createdBy","createdAt","lastModifiedBy","lastModifiedAt","state","filename","columnCount","rowCount","progressCount","errorCount","ignoredCount","estimatedRemainingTime","estimatedRemainingTimeText","totalTime","operation","errorMessage"],"properties":{"importFileUid":{"$ref":"#/components/schemas/UID"},"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"state":{"$ref":"#/components/schemas/ImportStateENUM"},"filename":{"type":"string"},"columnCount":{"type":"integer"},"rowCount":{"type":"integer","description":"header row is not counted"},"progressCount":{"type":"integer"},"errorCount":{"type":"integer"},"ignoredCount":{"type":"integer","description":"unprocessed rows"},"estimatedRemainingTime":{"type":"integer","description":"in hundreths of a second"},"estimatedRemainingTimeText":{"type":"string"},"totalTime":{"type":"integer","description":"in hundreths of a second"},"operation":{"$ref":"#/components/schemas/ImportOperationENUM"},"errorMessage":{"type":"string"}}},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"ImportStateENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| NOT_STARTED | Import not started |\n| IMPORT_IN_PROGRESS | Import is running |\n| IMPORT_ABORT | Import is aborting| \n| IMPORT_ABORTED | Import has been aborted |\n| VALIDATE_IN_PROGRESS | Validate is running| \n| COMPLETE_NOTHING_TO_IMPORT | Import is done, but there where nothing to import |\n| COMPLETE | Import complete |\n| VALIDATE_FAILED | Validate failed |\n| IMPORT_FAILED | Import failed |\n| IMPORT_ABORT | Import is aborting |\n| IMPORT_ABORTED | Import has been aborted  |\n| READY_TO_IMPORT | Validation OK, import is ready |\n","minLength":1,"title":"ImportStateENUM","type":"string","enum":["NOT_STARTED","COMPLETE","COMPLETE_NOTHING_TO_IMPORT","IMPORT_FAILED","IMPORT_ABORT","IMPORT_ABORTED","VALIDATE_FAILED","VALIDATE_ABORT","VALIDATE_ABORTED","IMPORT_IN_PROGRESS","VALIDATE_IN_PROGRESS","READY_TO_IMPORT"]},"ImportOperationENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| INSERT | Only insert non-existing records, existing records will be ignored|\n| UPDATE | Only update existing records, non-existing records will be ignored|\n| UPSERT | non-existing records will be inserted, existing records will be updated|\n","minLength":1,"title":"ImportOperationENUM","type":"string","enum":["INSERT","UPDATE","UPSERT"]},"ImportTemplateResponseSchema":{"title":"ImportTemplateResponseSchema","type":"object","required":["templateUid","name","description","createdBy","createdAt","lastModifiedBy","lastModifiedAt","layouts","entity","importFormat"],"properties":{"templateUid":{"$ref":"#/components/schemas/UID"},"name":{"type":"string"},"description":{"type":"string"},"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"layouts":{"type":"array","items":{"$ref":"#/components/schemas/ImportLayoutResponseSchema"}},"entity":{"$ref":"#/components/schemas/ImportEntityENUM"},"importFormat":{"$ref":"#/components/schemas/ImportFormatENUM"}}},"ImportLayoutResponseSchema":{"title":"ImportLayoutResponseSchema","allOf":[{"type":"object","properties":{"layoutUid":{"$ref":"#/components/schemas/UID"},"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"conversions":{"type":"array","items":{"$ref":"#/components/schemas/ImportConversionResponseSchema"}}},"required":["layoutUid","conversions","createdBy","createdAt","lastModifiedBy","lastModifiedAt"]},{"$ref":"#/components/schemas/ImportLayoutUpdateRequestSchema"}]},"ImportConversionResponseSchema":{"title":"ImportConversionResponseSchema","allOf":[{"type":"object","properties":{"conversionUid":{"$ref":"#/components/schemas/UID"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"}},"required":["conversionUid","createdAt","createdBy","lastModifiedAt","lastModifiedBy"]},{"$ref":"#/components/schemas/ImportConversionUpdateRequestSchema"}]},"ImportConversionUpdateRequestSchema":{"title":"ImportConversionUpdateRequestSchema","type":"object","properties":{"fromValue":{"type":"string"},"toValue":{"type":"string"}},"required":["fromValue","toValue"]},"ImportLayoutUpdateRequestSchema":{"title":"ImportLayoutUpdateRequestSchema","type":"object","properties":{"fieldName":{"type":"string","description":"Entity field name in FlowRetail"},"value":{"type":"string","description":"Static value, or reference to field in import file.\n\nExample: For EXCEL import use `A` to get the value from column A"}},"required":["fieldName","value"]},"ImportEntityENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| PRODUCTS | Import products |\n| PRICES | Import prices|\n| PRODUCT_GROUPS | Import product groups |\n| BRANDS | Import brands|\n| CUSTOMERS | Import customers|\n| STOCK | Import stock values|\n| SUPPLIER_PRODUCT | Import Product supplier information|\n| SUPPLIERS | Import suppliers|","minLength":1,"title":"ImportEntityENUM","type":"string","enum":["PRODUCTS","PRICES","PRODUCT_GROUPS","BRANDS","CUSTOMERS","STOCK","SUPPLIER_PRODUCT","SUPPLIERS"]},"ImportFormatENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| EXCEL | XLS file |\n","minLength":1,"title":"ImportFormatENUM","type":"string","enum":["EXCEL"]}}},"paths":{"/tenants/{tenantUid}/imports/files/{importFileUid}":{"get":{"description":"Get importfile details","operationId":"get-tenants-import-file-details","parameters":[{"schema":{"type":"boolean"},"in":"query","name":"light","description":"Set this to true to get a lighter version of the response, without the base64encoded version"}],"responses":{"200":{"$ref":"#/components/responses/ImportFileDetailResponse"}},"summary":"Get importfile details","tags":["Import"]}}}}
```

## Execute import content

> Execute import content\
> \
> Required permissions: IMPORT

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Import","description":"Import"}],"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":{"ImportFileDataResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportFileDataResponseSchema"}}}}},"schemas":{"ImportFileDataResponseSchema":{"title":"ImportFileDataResponseSchema","type":"object","properties":{"templateUid":{"$ref":"#/components/schemas/UID"},"base64Data":{"type":"string"},"contentType":{"type":"string"},"action":{"$ref":"#/components/schemas/ImportActionENUM"},"importFileUid":{"$ref":"#/components/schemas/OptionalUID"},"operation":{"$ref":"#/components/schemas/ImportOperationENUM"},"state":{"$ref":"#/components/schemas/ImportStateENUM"}},"required":["templateUid","base64Data","contentType","action","importFileUid","operation","state"]},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"ImportActionENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| SIMULATE | Do a simulate on import. Return content without saving |\n| PROCESS | Process file with given template. Save file if no errors|\n","minLength":1,"title":"ImportActionENUM","type":"string","enum":["SIMULATE","PROCESS"]},"OptionalUID":{"title":"OptionalUID","type":"string","pattern":"^[A-Za-z0-9-_]*"},"ImportOperationENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| INSERT | Only insert non-existing records, existing records will be ignored|\n| UPDATE | Only update existing records, non-existing records will be ignored|\n| UPSERT | non-existing records will be inserted, existing records will be updated|\n","minLength":1,"title":"ImportOperationENUM","type":"string","enum":["INSERT","UPDATE","UPSERT"]},"ImportStateENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| NOT_STARTED | Import not started |\n| IMPORT_IN_PROGRESS | Import is running |\n| IMPORT_ABORT | Import is aborting| \n| IMPORT_ABORTED | Import has been aborted |\n| VALIDATE_IN_PROGRESS | Validate is running| \n| COMPLETE_NOTHING_TO_IMPORT | Import is done, but there where nothing to import |\n| COMPLETE | Import complete |\n| VALIDATE_FAILED | Validate failed |\n| IMPORT_FAILED | Import failed |\n| IMPORT_ABORT | Import is aborting |\n| IMPORT_ABORTED | Import has been aborted  |\n| READY_TO_IMPORT | Validation OK, import is ready |\n","minLength":1,"title":"ImportStateENUM","type":"string","enum":["NOT_STARTED","COMPLETE","COMPLETE_NOTHING_TO_IMPORT","IMPORT_FAILED","IMPORT_ABORT","IMPORT_ABORTED","VALIDATE_FAILED","VALIDATE_ABORT","VALIDATE_ABORTED","IMPORT_IN_PROGRESS","VALIDATE_IN_PROGRESS","READY_TO_IMPORT"]},"ImportFileJobRequestSchema":{"title":"ImportFileJobRequestSchema","type":"object","properties":{"action":{"$ref":"#/components/schemas/ImportFileJobActionENUM"}}},"ImportFileJobActionENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| EXECUTE | Execute Import job |\n| ABORT | Abort running job |\n","title":"ImportFileJobActionENUM","type":"string","enum":["EXECUTE","ABORT"]}},"requestBodies":{"ImportFileJobRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportFileJobRequestSchema"}}}}}},"paths":{"/tenants/{tenantUid}/imports/files/{importFileUid}":{"post":{"summary":"Execute import content","operationId":"post-tenants-imports-file-execute","description":"Execute import content\n\nRequired permissions: IMPORT","responses":{"200":{"$ref":"#/components/responses/ImportFileDataResponse"}},"tags":["Import"],"requestBody":{"$ref":"#/components/requestBodies/ImportFileJobRequest"}}}}}
```

## Delete Import file

> Delete Import file\
> \
> Required permissions: IMPORT

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

## Download importfile

> The importfile will be returned as a binary file\
> \
> Required permissions: IMPORT

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Import","description":"Import"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"authToken":[]},{"integrationToken":[]},{"accessToken":[]}],"components":{"securitySchemes":{"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"},"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"}}},"paths":{"/tenants/{tenantUid}/imports/files/{importFileUid}/download":{"get":{"operationId":"get-tenants-import-file-download","description":"The importfile will be returned as a binary file\n\nRequired permissions: IMPORT","parameters":[],"responses":{"200":{"description":"Shared Response","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}},"summary":"Download importfile","tags":["Import"]}}}}
```

## List layout conversions

> List conversions for a  import layout

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Import","description":"Import"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"authToken":[]},{"integrationToken":[]},{"accessToken":[]}],"components":{"securitySchemes":{"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"},"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"}},"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"}},"schemas":{"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"},"ImportConversionResponseSchema":{"title":"ImportConversionResponseSchema","allOf":[{"type":"object","properties":{"conversionUid":{"$ref":"#/components/schemas/UID"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"}},"required":["conversionUid","createdAt","createdBy","lastModifiedAt","lastModifiedBy"]},{"$ref":"#/components/schemas/ImportConversionUpdateRequestSchema"}]},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"ImportConversionUpdateRequestSchema":{"title":"ImportConversionUpdateRequestSchema","type":"object","properties":{"fromValue":{"type":"string"},"toValue":{"type":"string"}},"required":["fromValue","toValue"]},"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"}},"responses":{"ImportConversionListResponse":{"content":{"application/json":{"schema":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ImportConversionResponseSchema"},"type":"array"},"paging":{"$ref":"#/components/schemas/Paging"}},"required":["items","paging"],"type":"object"}}},"description":"Example response"}}},"paths":{"/tenants/{tenantUid}/imports/templates/{importTemplateUid}/layouts/{importLayoutUid}/conversions":{"get":{"description":"List conversions for a  import layout","operationId":"get-tenants-imports-conversions","parameters":[{"$ref":"#/components/parameters/pageNumberQuery"},{"$ref":"#/components/parameters/pageSizeQuery"},{"$ref":"#/components/parameters/sortByQuery"},{"$ref":"#/components/parameters/sortDirectionQuery"}],"responses":{"200":{"$ref":"#/components/responses/ImportConversionListResponse"}},"summary":"List layout conversions","tags":["Import"]}}}}
```

## Create layout conversion

> Create conversion for an import layout\
> \
> Required permissions: IMPORT

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Import","description":"Import"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"integrationToken":[]},{"authToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"}},"responses":{"ImportConversionResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportConversionResponseSchema"}}}}},"schemas":{"ImportConversionResponseSchema":{"title":"ImportConversionResponseSchema","allOf":[{"type":"object","properties":{"conversionUid":{"$ref":"#/components/schemas/UID"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"}},"required":["conversionUid","createdAt","createdBy","lastModifiedAt","lastModifiedBy"]},{"$ref":"#/components/schemas/ImportConversionUpdateRequestSchema"}]},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"ImportConversionUpdateRequestSchema":{"title":"ImportConversionUpdateRequestSchema","type":"object","properties":{"fromValue":{"type":"string"},"toValue":{"type":"string"}},"required":["fromValue","toValue"]},"ImportConversionCreateRequestSchema":{"allOf":[{"$ref":"#/components/schemas/ImportConversionUpdateRequestSchema"},{"properties":{"conversionUid":{"$ref":"#/components/schemas/UID"}}}],"type":"object","title":"ImportConversionCreateRequestSchema"}},"requestBodies":{"ImportConversionCreateRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportConversionCreateRequestSchema"}}}}}},"paths":{"/tenants/{tenantUid}/imports/templates/{importTemplateUid}/layouts/{importLayoutUid}/conversions":{"post":{"summary":"Create layout conversion","operationId":"post-tenants-imports-conversions","responses":{"200":{"$ref":"#/components/responses/ImportConversionResponse"}},"requestBody":{"$ref":"#/components/requestBodies/ImportConversionCreateRequest"},"description":"Create conversion for an import layout\n\nRequired permissions: IMPORT","tags":["Import"]}}}}
```

## Get layout conversion details

> Get import layout conversion details

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Import","description":"Import"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"authToken":[]},{"integrationToken":[]},{"accessToken":[]}],"components":{"securitySchemes":{"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"},"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"}},"responses":{"ImportConversionResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportConversionResponseSchema"}}}}},"schemas":{"ImportConversionResponseSchema":{"title":"ImportConversionResponseSchema","allOf":[{"type":"object","properties":{"conversionUid":{"$ref":"#/components/schemas/UID"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"}},"required":["conversionUid","createdAt","createdBy","lastModifiedAt","lastModifiedBy"]},{"$ref":"#/components/schemas/ImportConversionUpdateRequestSchema"}]},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"ImportConversionUpdateRequestSchema":{"title":"ImportConversionUpdateRequestSchema","type":"object","properties":{"fromValue":{"type":"string"},"toValue":{"type":"string"}},"required":["fromValue","toValue"]}}},"paths":{"/tenants/{tenantUid}/imports/templates/{importTemplateUid}/layouts/{importLayoutUid}/conversions/{importConversionUid}":{"get":{"description":"Get import layout conversion details","operationId":"get-tenants-imports-conversions-details","parameters":[],"responses":{"200":{"$ref":"#/components/responses/ImportConversionResponse"}},"summary":"Get layout conversion details","tags":["Import"]}}}}
```

## Update layout conversion

> Update import layout\
> \
> Required permissions: IMPORT

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Import","description":"Import"}],"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":{"ImportConversionResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportConversionResponseSchema"}}}}},"schemas":{"ImportConversionResponseSchema":{"title":"ImportConversionResponseSchema","allOf":[{"type":"object","properties":{"conversionUid":{"$ref":"#/components/schemas/UID"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"}},"required":["conversionUid","createdAt","createdBy","lastModifiedAt","lastModifiedBy"]},{"$ref":"#/components/schemas/ImportConversionUpdateRequestSchema"}]},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"ImportConversionUpdateRequestSchema":{"title":"ImportConversionUpdateRequestSchema","type":"object","properties":{"fromValue":{"type":"string"},"toValue":{"type":"string"}},"required":["fromValue","toValue"]}},"requestBodies":{"ImportConversionUpdateRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportConversionUpdateRequestSchema"}}}}}},"paths":{"/tenants/{tenantUid}/imports/templates/{importTemplateUid}/layouts/{importLayoutUid}/conversions/{importConversionUid}":{"put":{"summary":"Update layout conversion","operationId":"put-tenants-imports-conversions-details","responses":{"200":{"$ref":"#/components/responses/ImportConversionResponse"}},"requestBody":{"$ref":"#/components/requestBodies/ImportConversionUpdateRequest"},"description":"Update import layout\n\nRequired permissions: IMPORT","tags":["Import"]}}}}
```

## Delete a layout conversion

> Delete an Import layout\
> \
> Required permissions: IMPORT

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Import","description":"Import"}],"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}/imports/templates/{importTemplateUid}/layouts/{importLayoutUid}/conversions/{importConversionUid}":{"delete":{"summary":"Delete a layout conversion","operationId":"delete-tenants-imports-conversions-details","responses":{"204":{"description":"No Content"}},"description":"Delete an Import layout\n\nRequired permissions: IMPORT","tags":["Import"]}}}}
```