Extensions

Extensions

List extensions for a tenant

get

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

/tenants/{tenantUid}/extensions

List extensions for a tenant

Authorizations

authToken

AuthorizationstringRequired

Token received from the auth service

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

Query parameters

pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional

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

Possible values:

Responses

200

Example response

application/json

get/tenants/{tenantUid}/extensions

HTTPcURLJavaScriptPython

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

200

Example response

{
  "items": [
    {
      "tenantExtensionUid": "text",
      "name": "text",
      "active": true,
      "extensionCode": "FLOWGIFTCARD",
      "hasStoreExtensionSettings": true,
      "tenantParameters": [
        {
          "key": "text",
          "value": "text",
          "type": "STRING",
          "allowedValues": [
            "text"
          ],
          "validationRegex": "text",
          "name": "text",
          "required": true
        }
      ],
      "statusMessages": [
        "text"
      ],
      "availableStoreParameters": [
        {
          "key": "text",
          "value": "text",
          "type": "STRING",
          "allowedValues": [
            "text"
          ],
          "validationRegex": "text",
          "name": "text",
          "required": true
        }
      ]
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Get tenant extension details

get

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

/tenants/{tenantUid}/extensions/{tenantExtensionUid}

Get details for a tenant extension.

Authorizations

authToken

AuthorizationstringRequired

Token received from the auth service

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

tenantExtensionUidstringRequired

Reference to a tenant extension.

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

Responses

200

Example response

application/json

TenantExtensionResponseSchema

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

namestringRequired

activebooleanRequired

extensionCodestring · enumRequiredPossible values:

hasStoreExtensionSettingsbooleanRequired

Indicate if the extension needs to be activated and configured pr store

statusMessagesstring[]Required

get/tenants/{tenantUid}/extensions/{tenantExtensionUid}

HTTPcURLJavaScriptPython

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

200

Example response

{
  "tenantExtensionUid": "text",
  "name": "text",
  "active": true,
  "extensionCode": "FLOWGIFTCARD",
  "hasStoreExtensionSettings": true,
  "tenantParameters": [
    {
      "key": "text",
      "value": "text",
      "type": "STRING",
      "allowedValues": [
        "text"
      ],
      "validationRegex": "text",
      "name": "text",
      "required": true
    }
  ],
  "statusMessages": [
    "text"
  ],
  "availableStoreParameters": [
    {
      "key": "text",
      "value": "text",
      "type": "STRING",
      "allowedValues": [
        "text"
      ],
      "validationRegex": "text",
      "name": "text",
      "required": true
    }
  ]
}

Update tenant extension details

put

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

/tenants/{tenantUid}/extensions/{tenantExtensionUid}

Update details for a tenant extension.

Authorizations

authToken

AuthorizationstringRequired

Token received from the auth service

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

tenantExtensionUidstringRequired

Reference to a tenant extension.

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

Body

application/json

namestringOptional

activebooleanRequired

Responses

200

Example response

application/json

TenantExtensionResponseSchema

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

namestringRequired

activebooleanRequired

extensionCodestring · enumRequiredPossible values:

hasStoreExtensionSettingsbooleanRequired

Indicate if the extension needs to be activated and configured pr store

statusMessagesstring[]Required

put/tenants/{tenantUid}/extensions/{tenantExtensionUid}

HTTPcURLJavaScriptPython

PUT /v2/tenants/{tenantUid}/extensions/{tenantExtensionUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 80

{
  "name": "text",
  "active": true,
  "tenantParameters": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

200

Example response

{
  "tenantExtensionUid": "text",
  "name": "text",
  "active": true,
  "extensionCode": "FLOWGIFTCARD",
  "hasStoreExtensionSettings": true,
  "tenantParameters": [
    {
      "key": "text",
      "value": "text",
      "type": "STRING",
      "allowedValues": [
        "text"
      ],
      "validationRegex": "text",
      "name": "text",
      "required": true
    }
  ],
  "statusMessages": [
    "text"
  ],
  "availableStoreParameters": [
    {
      "key": "text",
      "value": "text",
      "type": "STRING",
      "allowedValues": [
        "text"
      ],
      "validationRegex": "text",
      "name": "text",
      "required": true
    }
  ]
}

Delete a tenant extension

delete

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

/tenants/{tenantUid}/extensions/{tenantExtensionUid}

Deletes a tenant extension.

Authorizations

authToken

AuthorizationstringRequired

Token received from the auth service

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

tenantExtensionUidstringRequired

Reference to a tenant extension.

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

Responses

204

No Content

No content

delete/tenants/{tenantUid}/extensions/{tenantExtensionUid}

HTTPcURLJavaScriptPython

DELETE /v2/tenants/{tenantUid}/extensions/{tenantExtensionUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

No content

List store extensions for a tenant extension

get

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

/tenants/{tenantUid}/extensions/{tenantExtensionUid}/stores

List store extensions for a tenant extension

Authorizations

authToken

AuthorizationstringRequired

Token received from the auth service

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

tenantExtensionUidstringRequired

Reference to a tenant extension.

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:

tenantExtensionActiveQuerybooleanOptional

filter on active status for a store extension.

tenantExtensionStoreNameQuerystringOptional

filter on store name for a store extension

Responses

200

Example response

application/json

get/tenants/{tenantUid}/extensions/{tenantExtensionUid}/stores

HTTPcURLJavaScriptPython

GET /v2/tenants/{tenantUid}/extensions/{tenantExtensionUid}/stores HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "storeExtensionUid": "text",
      "active": true,
      "storeUid": "text",
      "storeName": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

List extensions for a store

get

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

/tenants/{tenantUid}/stores/{storeUid}/extensions

List extensions for a store

Authorizations

authToken

AuthorizationstringRequired

Token received from the auth service

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

storeUidstringRequired

Reference to a Store.

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

Query parameters

pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional

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

Possible values:

Responses

200

Example response

application/json

get/tenants/{tenantUid}/stores/{storeUid}/extensions

HTTPcURLJavaScriptPython

GET /v2/tenants/{tenantUid}/stores/{storeUid}/extensions HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "storeExtensionUid": "text",
      "active": true,
      "storeParameters": [
        {
          "key": "text",
          "value": "text",
          "type": "STRING",
          "allowedValues": [
            "text"
          ],
          "validationRegex": "text",
          "name": "text",
          "required": true
        }
      ],
      "tenantExtension": {
        "extensionCode": "FLOWGIFTCARD",
        "active": true,
        "tenantExtensionUid": "text",
        "name": "text"
      },
      "statusMessages": [
        "text"
      ]
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Add a new extension to a store

post

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

/tenants/{tenantUid}/stores/{storeUid}/extensions

Add a new extension to a store

Required store or tenant role ADMIN

Authorizations

authToken

AuthorizationstringRequired

Token received from the auth service

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

storeUidstringRequired

Reference to a Store.

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

Body

application/json

activebooleanRequired

Activate/Deactivate the extension on the store

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

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

Responses

201

Example response

application/json

StoreExtensionResponseSchema

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

activebooleanRequired

statusMessagesstring[]Required

post/tenants/{tenantUid}/stores/{storeUid}/extensions

HTTPcURLJavaScriptPython

POST /v2/tenants/{tenantUid}/stores/{storeUid}/extensions HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 120

{
  "active": true,
  "storeParameters": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "tenantExtensionUid": "text",
  "storeExtensionUid": "text"
}

201

Example response

{
  "storeExtensionUid": "text",
  "active": true,
  "storeParameters": [
    {
      "key": "text",
      "value": "text",
      "type": "STRING",
      "allowedValues": [
        "text"
      ],
      "validationRegex": "text",
      "name": "text",
      "required": true
    }
  ],
  "tenantExtension": {
    "extensionCode": "FLOWGIFTCARD",
    "active": true,
    "tenantExtensionUid": "text",
    "name": "text"
  },
  "statusMessages": [
    "text"
  ]
}

Get store extension details

get

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

/tenants/{tenantUid}/stores/{storeUid}/extensions/{storeExtensionUid}

Get details for a store extension.

Authorizations

authToken

AuthorizationstringRequired

Token received from the auth service

Path parameters

storeUidstringRequired

Reference to a Store.

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

tenantUidstringRequired

Reference to a tenant.

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

storeExtensionUidstringRequired

Reference to a store extension.

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

Responses

200

Example response

application/json

StoreExtensionResponseSchema

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

activebooleanRequired

statusMessagesstring[]Required

get/tenants/{tenantUid}/stores/{storeUid}/extensions/{storeExtensionUid}

HTTPcURLJavaScriptPython

GET /v2/tenants/{tenantUid}/stores/{storeUid}/extensions/{storeExtensionUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "storeExtensionUid": "text",
  "active": true,
  "storeParameters": [
    {
      "key": "text",
      "value": "text",
      "type": "STRING",
      "allowedValues": [
        "text"
      ],
      "validationRegex": "text",
      "name": "text",
      "required": true
    }
  ],
  "tenantExtension": {
    "extensionCode": "FLOWGIFTCARD",
    "active": true,
    "tenantExtensionUid": "text",
    "name": "text"
  },
  "statusMessages": [
    "text"
  ]
}

Update store extension details

put

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

/tenants/{tenantUid}/stores/{storeUid}/extensions/{storeExtensionUid}

Update details for a store extension

Authorizations

authToken

AuthorizationstringRequired

Token received from the auth service

Path parameters

storeUidstringRequired

Reference to a Store.

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

tenantUidstringRequired

Reference to a tenant.

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

storeExtensionUidstringRequired

Reference to a store extension.

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

Body

application/json

activebooleanRequired

Activate/Deactivate the extension on the store

Responses

200

Example response

application/json

StoreExtensionResponseSchema

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

activebooleanRequired

statusMessagesstring[]Required

put/tenants/{tenantUid}/stores/{storeUid}/extensions/{storeExtensionUid}

HTTPcURLJavaScriptPython

PUT /v2/tenants/{tenantUid}/stores/{storeUid}/extensions/{storeExtensionUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "active": true,
  "storeParameters": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

200

Example response

{
  "storeExtensionUid": "text",
  "active": true,
  "storeParameters": [
    {
      "key": "text",
      "value": "text",
      "type": "STRING",
      "allowedValues": [
        "text"
      ],
      "validationRegex": "text",
      "name": "text",
      "required": true
    }
  ],
  "tenantExtension": {
    "extensionCode": "FLOWGIFTCARD",
    "active": true,
    "tenantExtensionUid": "text",
    "name": "text"
  },
  "statusMessages": [
    "text"
  ]
}

Delete a store extension

delete

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

/tenants/{tenantUid}/stores/{storeUid}/extensions/{storeExtensionUid}

Deletes a store extension.

Authorizations

authToken

AuthorizationstringRequired

Token received from the auth service

Path parameters

storeUidstringRequired

Reference to a Store.

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

tenantUidstringRequired

Reference to a tenant.

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

storeExtensionUidstringRequired

Reference to a store extension.

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

Responses

204

No Content

No content

delete/tenants/{tenantUid}/stores/{storeUid}/extensions/{storeExtensionUid}

HTTPcURLJavaScriptPython

DELETE /v2/tenants/{tenantUid}/stores/{storeUid}/extensions/{storeExtensionUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

No content