Heads up, our devs are blazing ahead—docs are catching up, so some features might not be fully documented yet.
Visit our websiteAPI Documentation

Import

Import

List all import templates

get

List all import templates

Required permission: TENANT.ADMIN

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional
ENUM Description
ASC Sort in ascending order
DESC Sort in descending order
Possible values:
Responses
200
Example response
application/json
get
GET /v2/tenants/{tenantUid}/imports/templates HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Example response

{
  "items": [
    {
      "templateUid": "text",
      "createdBy": "text",
      "createdAt": "2025-07-30T17:50:52.192Z",
      "lastModifiedBy": "text",
      "lastModifiedAt": "2025-07-30T17:50:52.192Z",
      "layouts": [
        {
          "layoutUid": "text",
          "createdBy": "text",
          "createdAt": "2025-07-30T17:50:52.192Z",
          "lastModifiedBy": "text",
          "lastModifiedAt": "2025-07-30T17:50:52.192Z",
          "conversions": [
            {
              "conversionUid": "text",
              "createdAt": "2025-07-30T17:50:52.192Z",
              "createdBy": "text",
              "lastModifiedAt": "2025-07-30T17:50:52.192Z",
              "lastModifiedBy": "text",
              "fromValue": "text",
              "toValue": "text"
            }
          ],
          "fieldName": "text",
          "value": "text"
        }
      ],
      "name": "text",
      "description": "text",
      "entity": "PRODUCTS",
      "importFormat": "EXCEL"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create import template

post

Create import template

Required permission: TENANT.ADMIN

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Body
namestringRequired
descriptionstringRequired
entitystring · enum · min: 1Required
ENUM Description
PRODUCTS Import products
PRICES Import prices
PRODUCT_GROUPS Import product groups
BRANDS Import brands
CUSTOMERS Import customers
STOCK Import stock values
SUPPLIER_PRODUCT Import Product supplier information
SUPPLIERS Import suppliers
Possible values:
importFormatstring · enum · min: 1Required
ENUM Description
EXCEL XLS file
Possible values:
templateUidstringOptionalPattern: ^[A-Za-z0-9-_]+
Responses
200
Example response
application/json
Responseall of
and
post
POST /v2/tenants/{tenantUid}/imports/templates HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 100

{
  "name": "text",
  "description": "text",
  "entity": "PRODUCTS",
  "importFormat": "EXCEL",
  "templateUid": "text"
}
200

Example response

{
  "templateUid": "text",
  "createdBy": "text",
  "createdAt": "2025-07-30T17:50:52.192Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-07-30T17:50:52.192Z",
  "layouts": [
    {
      "layoutUid": "text",
      "createdBy": "text",
      "createdAt": "2025-07-30T17:50:52.192Z",
      "lastModifiedBy": "text",
      "lastModifiedAt": "2025-07-30T17:50:52.192Z",
      "conversions": [
        {
          "conversionUid": "text",
          "createdAt": "2025-07-30T17:50:52.192Z",
          "createdBy": "text",
          "lastModifiedAt": "2025-07-30T17:50:52.192Z",
          "lastModifiedBy": "text",
          "fromValue": "text",
          "toValue": "text"
        }
      ],
      "fieldName": "text",
      "value": "text"
    }
  ],
  "name": "text",
  "description": "text",
  "entity": "PRODUCTS",
  "importFormat": "EXCEL"
}

Get import template details

get

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

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a import template.

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

Include layouts in response

includeConversionsbooleanOptional

Include conversions in response

Responses
200
Example response
application/json
Responseall of
and
get
GET /v2/tenants/{tenantUid}/imports/templates/{importTemplateUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Example response

{
  "templateUid": "text",
  "createdBy": "text",
  "createdAt": "2025-07-30T17:50:52.192Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-07-30T17:50:52.192Z",
  "layouts": [
    {
      "layoutUid": "text",
      "createdBy": "text",
      "createdAt": "2025-07-30T17:50:52.192Z",
      "lastModifiedBy": "text",
      "lastModifiedAt": "2025-07-30T17:50:52.192Z",
      "conversions": [
        {
          "conversionUid": "text",
          "createdAt": "2025-07-30T17:50:52.192Z",
          "createdBy": "text",
          "lastModifiedAt": "2025-07-30T17:50:52.192Z",
          "lastModifiedBy": "text",
          "fromValue": "text",
          "toValue": "text"
        }
      ],
      "fieldName": "text",
      "value": "text"
    }
  ],
  "name": "text",
  "description": "text",
  "entity": "PRODUCTS",
  "importFormat": "EXCEL"
}

Update import template

put

Update import template

Required permission: TENANT.ADMIN

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a import template.

Pattern: ^[A-Za-z0-9-_]+
Body
namestringRequired
descriptionstringRequired
Responses
200
Example response
application/json
Responseall of
and
put
PUT /v2/tenants/{tenantUid}/imports/templates/{importTemplateUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "name": "text",
  "description": "text"
}
200

Example response

{
  "templateUid": "text",
  "createdBy": "text",
  "createdAt": "2025-07-30T17:50:52.192Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-07-30T17:50:52.192Z",
  "layouts": [
    {
      "layoutUid": "text",
      "createdBy": "text",
      "createdAt": "2025-07-30T17:50:52.192Z",
      "lastModifiedBy": "text",
      "lastModifiedAt": "2025-07-30T17:50:52.192Z",
      "conversions": [
        {
          "conversionUid": "text",
          "createdAt": "2025-07-30T17:50:52.192Z",
          "createdBy": "text",
          "lastModifiedAt": "2025-07-30T17:50:52.192Z",
          "lastModifiedBy": "text",
          "fromValue": "text",
          "toValue": "text"
        }
      ],
      "fieldName": "text",
      "value": "text"
    }
  ],
  "name": "text",
  "description": "text",
  "entity": "PRODUCTS",
  "importFormat": "EXCEL"
}

Delete an Import template

delete

Delete an Import template

Required permission: TENANT.ADMIN

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a import template.

Pattern: ^[A-Za-z0-9-_]+
Responses
204
No Content
delete
DELETE /v2/tenants/{tenantUid}/imports/templates/{importTemplateUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204

No Content

No content

List layouts for a import template

get

List layouts for a import template

Required permission: TENANT.ADMIN

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a import template.

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

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional
ENUM Description
ASC Sort in ascending order
DESC Sort in descending order
Possible values:
Responses
200
Example response
application/json
get
GET /v2/tenants/{tenantUid}/imports/templates/{importTemplateUid}/layouts HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Example response

{
  "items": [
    {
      "layoutUid": "text",
      "createdBy": "text",
      "createdAt": "2025-07-30T17:50:52.192Z",
      "lastModifiedBy": "text",
      "lastModifiedAt": "2025-07-30T17:50:52.192Z",
      "conversions": [
        {
          "conversionUid": "text",
          "createdAt": "2025-07-30T17:50:52.192Z",
          "createdBy": "text",
          "lastModifiedAt": "2025-07-30T17:50:52.192Z",
          "lastModifiedBy": "text",
          "fromValue": "text",
          "toValue": "text"
        }
      ],
      "fieldName": "text",
      "value": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create layout for an import template

post

Create layout for an import template

Required permission: TENANT.ADMIN

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a import template.

Pattern: ^[A-Za-z0-9-_]+
Body
all ofOptional
Responses
200
Example response
application/json
Responseall of
and
post
POST /v2/tenants/{tenantUid}/imports/templates/{importTemplateUid}/layouts HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "fieldName": "text",
  "value": "text",
  "layoutUid": "text"
}
200

Example response

{
  "layoutUid": "text",
  "createdBy": "text",
  "createdAt": "2025-07-30T17:50:52.192Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-07-30T17:50:52.192Z",
  "conversions": [
    {
      "conversionUid": "text",
      "createdAt": "2025-07-30T17:50:52.192Z",
      "createdBy": "text",
      "lastModifiedAt": "2025-07-30T17:50:52.192Z",
      "lastModifiedBy": "text",
      "fromValue": "text",
      "toValue": "text"
    }
  ],
  "fieldName": "text",
  "value": "text"
}

Get layout details for an import template

get

Get import layout details

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a import template.

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

Reference to a import layout.

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

Include conversions in response

Responses
200
Example response
application/json
Responseall of
and
get
GET /v2/tenants/{tenantUid}/imports/templates/{importTemplateUid}/layouts/{importLayoutUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Example response

{
  "layoutUid": "text",
  "createdBy": "text",
  "createdAt": "2025-07-30T17:50:52.192Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-07-30T17:50:52.192Z",
  "conversions": [
    {
      "conversionUid": "text",
      "createdAt": "2025-07-30T17:50:52.192Z",
      "createdBy": "text",
      "lastModifiedAt": "2025-07-30T17:50:52.192Z",
      "lastModifiedBy": "text",
      "fromValue": "text",
      "toValue": "text"
    }
  ],
  "fieldName": "text",
  "value": "text"
}

Update layout for an import template

put

Update import layout

Required permission: TENANT.ADMIN

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a import template.

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

Reference to a import layout.

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

Entity field name in FlowRetail

valuestringRequired

Static value, or reference to field in import file.

Example: For EXCEL import use A to get the value from column A

Responses
200
Example response
application/json
Responseall of
and
put
PUT /v2/tenants/{tenantUid}/imports/templates/{importTemplateUid}/layouts/{importLayoutUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "fieldName": "text",
  "value": "text"
}
200

Example response

{
  "layoutUid": "text",
  "createdBy": "text",
  "createdAt": "2025-07-30T17:50:52.192Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-07-30T17:50:52.192Z",
  "conversions": [
    {
      "conversionUid": "text",
      "createdAt": "2025-07-30T17:50:52.192Z",
      "createdBy": "text",
      "lastModifiedAt": "2025-07-30T17:50:52.192Z",
      "lastModifiedBy": "text",
      "fromValue": "text",
      "toValue": "text"
    }
  ],
  "fieldName": "text",
  "value": "text"
}

Delete a layout for an import template

delete

Delete an Import layout

Required permission: TENANT.ADMIN

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a import template.

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

Reference to a import layout.

Pattern: ^[A-Za-z0-9-_]+
Responses
204
No Content
delete
DELETE /v2/tenants/{tenantUid}/imports/templates/{importTemplateUid}/layouts/{importLayoutUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204

No Content

No content

List import files

get

List import files. Use query parameter to narrow list

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Query parameters
importTemplateUidsstring[]Optional

Reference to a Import Template.

pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional
ENUM Description
ASC Sort in ascending order
DESC Sort in descending order
Possible values:
importFileStatestring · enum · min: 1Optional
ENUM Description
NOT_STARTED Import not started
IMPORT_IN_PROGRESS Import is running
IMPORT_ABORT Import is aborting
IMPORT_ABORTED Import has been aborted
VALIDATE_IN_PROGRESS Validate is running
COMPLETE_NOTHING_TO_IMPORT Import is done, but there where nothing to import
COMPLETE Import complete
VALIDATE_FAILED Validate failed
IMPORT_FAILED Import failed
IMPORT_ABORT Import is aborting
IMPORT_ABORTED Import has been aborted
READY_TO_IMPORT Validation OK, import is ready
Possible values:
Responses
200
Example response
application/json
get
GET /v2/tenants/{tenantUid}/imports/files HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Example response

{
  "items": [
    {
      "importFileUid": "text",
      "template": {
        "templateUid": "text",
        "createdBy": "text",
        "createdAt": "2025-07-30T17:50:52.192Z",
        "lastModifiedBy": "text",
        "lastModifiedAt": "2025-07-30T17:50:52.192Z",
        "layouts": [
          {
            "layoutUid": "text",
            "createdBy": "text",
            "createdAt": "2025-07-30T17:50:52.192Z",
            "lastModifiedBy": "text",
            "lastModifiedAt": "2025-07-30T17:50:52.192Z",
            "conversions": [
              {
                "conversionUid": "text",
                "createdAt": "2025-07-30T17:50:52.192Z",
                "createdBy": "text",
                "lastModifiedAt": "2025-07-30T17:50:52.192Z",
                "lastModifiedBy": "text",
                "fromValue": "text",
                "toValue": "text"
              }
            ],
            "fieldName": "text",
            "value": "text"
          }
        ],
        "name": "text",
        "description": "text",
        "entity": "PRODUCTS",
        "importFormat": "EXCEL"
      },
      "createdBy": "text",
      "createdAt": "2025-07-30T17:50:52.192Z",
      "lastModifiedBy": "text",
      "lastModifiedAt": "2025-07-30T17:50:52.192Z",
      "state": "NOT_STARTED",
      "filename": "text",
      "columnCount": 1,
      "rowCount": 1,
      "progressCount": 1,
      "errorCount": 1,
      "ignoredCount": 1,
      "estimatedRemainingTime": 1,
      "estimatedRemainingTimeText": "text",
      "totalTime": 1,
      "operation": "INSERT",
      "errorMessage": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Process or simulate import

post

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.

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

base64 encoded data to be processed

operationstring · enum · min: 1Required
ENUM Description
INSERT Only insert non-existing records, existing records will be ignored
UPDATE Only update existing records, non-existing records will be ignored
UPSERT non-existing records will be inserted, existing records will be updated
Possible values:
actionstring · enum · min: 1Required
ENUM Description
SIMULATE Do a simulate on import. Return content without saving
PROCESS Process file with given template. Save file if no errors
Possible values:
importFileUidstringOptionalPattern: ^[A-Za-z0-9-_]+
Responses
200
Example response
application/json
post
POST /v2/tenants/{tenantUid}/imports/files HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "templateUid": "text",
  "base64Data": "text",
  "operation": "INSERT",
  "action": "SIMULATE",
  "importFileUid": "text"
}
200

Example response

{
  "templateUid": "text",
  "base64Data": "text",
  "contentType": "text",
  "action": "SIMULATE",
  "importFileUid": "text",
  "operation": "INSERT",
  "state": "NOT_STARTED"
}

Get importfile details

get

Get importfile details

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a import file.

Pattern: ^[A-Za-z0-9-_]+
Responses
200
Example response
application/json
Responseall of
get
GET /v2/tenants/{tenantUid}/imports/files/{importFileUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Example response

{
  "importFileUid": "text",
  "template": {
    "templateUid": "text",
    "createdBy": "text",
    "createdAt": "2025-07-30T17:50:52.192Z",
    "lastModifiedBy": "text",
    "lastModifiedAt": "2025-07-30T17:50:52.192Z",
    "layouts": [
      {
        "layoutUid": "text",
        "createdBy": "text",
        "createdAt": "2025-07-30T17:50:52.192Z",
        "lastModifiedBy": "text",
        "lastModifiedAt": "2025-07-30T17:50:52.192Z",
        "conversions": [
          {
            "conversionUid": "text",
            "createdAt": "2025-07-30T17:50:52.192Z",
            "createdBy": "text",
            "lastModifiedAt": "2025-07-30T17:50:52.192Z",
            "lastModifiedBy": "text",
            "fromValue": "text",
            "toValue": "text"
          }
        ],
        "fieldName": "text",
        "value": "text"
      }
    ],
    "name": "text",
    "description": "text",
    "entity": "PRODUCTS",
    "importFormat": "EXCEL"
  },
  "createdBy": "text",
  "createdAt": "2025-07-30T17:50:52.192Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-07-30T17:50:52.192Z",
  "state": "NOT_STARTED",
  "filename": "text",
  "columnCount": 1,
  "rowCount": 1,
  "progressCount": 1,
  "errorCount": 1,
  "ignoredCount": 1,
  "estimatedRemainingTime": 1,
  "estimatedRemainingTimeText": "text",
  "totalTime": 1,
  "operation": "INSERT",
  "errorMessage": "text",
  "base64Data": "text"
}

Execute import content

post

Execute or abort import job.

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a import file.

Pattern: ^[A-Za-z0-9-_]+
Body
actionstring · enumOptional
ENUM Description
EXECUTE Execute Import job
ABORT Abort running job
Possible values:
Responses
200
Example response
application/json
post
POST /v2/tenants/{tenantUid}/imports/files/{importFileUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "action": "EXECUTE"
}
200

Example response

{
  "templateUid": "text",
  "base64Data": "text",
  "contentType": "text",
  "action": "SIMULATE",
  "importFileUid": "text",
  "operation": "INSERT",
  "state": "NOT_STARTED"
}

Delete Import file

delete

Delete Import file

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a import file.

Pattern: ^[A-Za-z0-9-_]+
Responses
200
OK
delete
DELETE /v2/tenants/{tenantUid}/imports/files/{importFileUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

No content

List layout conversions

get

List conversions for a import layout

Required permission: TENANT.ADMIN

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a import template.

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

Reference to a import layout.

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

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional
ENUM Description
ASC Sort in ascending order
DESC Sort in descending order
Possible values:
Responses
200
Example response
application/json
get
GET /v2/tenants/{tenantUid}/imports/templates/{importTemplateUid}/layouts/{importLayoutUid}/conversions HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Example response

{
  "items": [
    {
      "conversionUid": "text",
      "createdAt": "2025-07-30T17:50:52.192Z",
      "createdBy": "text",
      "lastModifiedAt": "2025-07-30T17:50:52.192Z",
      "lastModifiedBy": "text",
      "fromValue": "text",
      "toValue": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create layout conversion

post

Create conversion for an import layout

Required permission: TENANT.ADMIN

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a import template.

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

Reference to a import layout.

Pattern: ^[A-Za-z0-9-_]+
Body
all ofOptional
and
Responses
200
Example response
application/json
Responseall of
and
post
POST /v2/tenants/{tenantUid}/imports/templates/{importTemplateUid}/layouts/{importLayoutUid}/conversions HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "fromValue": "text",
  "toValue": "text",
  "conversionUid": "text"
}
200

Example response

{
  "conversionUid": "text",
  "createdAt": "2025-07-30T17:50:52.192Z",
  "createdBy": "text",
  "lastModifiedAt": "2025-07-30T17:50:52.192Z",
  "lastModifiedBy": "text",
  "fromValue": "text",
  "toValue": "text"
}

Get layout conversion details

get

Get import layout conversion details

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a import template.

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

Reference to a import layout.

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

Reference to a import layout conversion.

Pattern: ^[A-Za-z0-9-_]+
Responses
200
Example response
application/json
Responseall of
and
get
GET /v2/tenants/{tenantUid}/imports/templates/{importTemplateUid}/layouts/{importLayoutUid}/conversions/{importConversionUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Example response

{
  "conversionUid": "text",
  "createdAt": "2025-07-30T17:50:52.192Z",
  "createdBy": "text",
  "lastModifiedAt": "2025-07-30T17:50:52.192Z",
  "lastModifiedBy": "text",
  "fromValue": "text",
  "toValue": "text"
}

Update layout conversion

put

Update import layout

Required permission: TENANT.ADMIN

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a import template.

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

Reference to a import layout.

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

Reference to a import layout conversion.

Pattern: ^[A-Za-z0-9-_]+
Body
fromValuestringRequired
toValuestringRequired
Responses
200
Example response
application/json
Responseall of
and
put
PUT /v2/tenants/{tenantUid}/imports/templates/{importTemplateUid}/layouts/{importLayoutUid}/conversions/{importConversionUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "fromValue": "text",
  "toValue": "text"
}
200

Example response

{
  "conversionUid": "text",
  "createdAt": "2025-07-30T17:50:52.192Z",
  "createdBy": "text",
  "lastModifiedAt": "2025-07-30T17:50:52.192Z",
  "lastModifiedBy": "text",
  "fromValue": "text",
  "toValue": "text"
}

Delete a layout conversion

delete

Delete an Import layout

Required permission: TENANT.ADMIN

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a import template.

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

Reference to a import layout.

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

Reference to a import layout conversion.

Pattern: ^[A-Za-z0-9-_]+
Responses
204
No Content
delete
DELETE /v2/tenants/{tenantUid}/imports/templates/{importTemplateUid}/layouts/{importLayoutUid}/conversions/{importConversionUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204

No Content

No content
PreviousHandlingNextInternal

Was this helpful?