Extensions
Extensions
List extensions for a tenant
Required permissions: EXTENSION
Token received from the auth service
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a specific page in a result set.
The number of items per page in a result set.
Defines which field the resource list is sorted by.
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
Example response
GET /v2/tenants/{tenantUid}/extensions HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
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 details for a tenant extension.
Token received from the auth service
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a tenant extension.
^[A-Za-z0-9-_]+Example response
TenantExtensionResponseSchema
^[A-Za-z0-9-_]+Indicate if the extension needs to be activated and configured pr store
GET /v2/tenants/{tenantUid}/extensions/{tenantExtensionUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
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 details for a tenant extension.
Required permissions: EXTENSION
Token received from the auth service
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a tenant extension.
^[A-Za-z0-9-_]+Example response
TenantExtensionResponseSchema
^[A-Za-z0-9-_]+Indicate if the extension needs to be activated and configured pr store
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"
}
]
}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
}
]
}Deletes a tenant extension.
Required permissions: EXTENSION
Token received from the auth service
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a tenant extension.
^[A-Za-z0-9-_]+No Content
No content
DELETE /v2/tenants/{tenantUid}/extensions/{tenantExtensionUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No Content
No content
List store extensions for a tenant extension
List store extensions for a tenant extension
Required permissions: EXTENSION
Token received from the auth service
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a tenant extension.
^[A-Za-z0-9-_]+Reference to a specific page in a result set.
The number of items per page in a result set.
Defines which field the resource list is sorted by.
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
filter on active status for a store extension.
filter on store name for a store extension
Example response
GET /v2/tenants/{tenantUid}/extensions/{tenantExtensionUid}/stores HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"items": [
{
"storeExtensionUid": "text",
"active": true,
"storeUid": "text",
"storeName": "text"
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}List extensions for a store
Required permissions: EXTENSION
Token received from the auth service
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to a specific page in a result set.
The number of items per page in a result set.
Defines which field the resource list is sorted by.
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
Example response
GET /v2/tenants/{tenantUid}/stores/{storeUid}/extensions HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
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"
],
"capabilities": [
"VALIDATE_CREDENTIALS"
]
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}Add a new extension to a store
Required permissions: EXTENSION
Token received from the auth service
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Activate/Deactivate the extension on the store
^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+Example response
StoreExtensionResponseSchema
^[A-Za-z0-9-_]+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"
}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"
],
"capabilities": [
"VALIDATE_CREDENTIALS"
]
}Get details for a store extension.
Required permissions: EXTENSION
Token received from the auth service
Reference to a Store.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a store extension.
^[A-Za-z0-9-_]+Example response
StoreExtensionResponseSchema
^[A-Za-z0-9-_]+GET /v2/tenants/{tenantUid}/stores/{storeUid}/extensions/{storeExtensionUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
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"
],
"capabilities": [
"VALIDATE_CREDENTIALS"
]
}Update store extension details
Update details for a store extension
Required permissions: EXTENSION
Token received from the auth service
Reference to a Store.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a store extension.
^[A-Za-z0-9-_]+Activate/Deactivate the extension on the store
Example response
StoreExtensionResponseSchema
^[A-Za-z0-9-_]+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"
}
]
}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"
],
"capabilities": [
"VALIDATE_CREDENTIALS"
]
}Deletes a store extension.
Required permissions: EXTENSION
Token received from the auth service
Reference to a Store.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a store extension.
^[A-Za-z0-9-_]+No Content
No content
DELETE /v2/tenants/{tenantUid}/stores/{storeUid}/extensions/{storeExtensionUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No Content
No content
Validate store extension credentials
Validates that the store extension's saved credentials are correct by calling the underlying provider.
Required permissions: EXTENSION
Token received from the auth service
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to a store extension.
^[A-Za-z0-9-_]+Credentials are valid
No content
POST /v2/tenants/{tenantUid}/stores/{storeUid}/extensions/{storeExtensionUid}/validate-credentials HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Credentials are valid
No content
List payment terminals for a store extension
Lists payment terminals available through the store extension.
Required permissions: EXTENSION,TILL
Token received from the auth service
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to a store extension.
^[A-Za-z0-9-_]+OK
GET /v2/tenants/{tenantUid}/stores/{storeUid}/extensions/{storeExtensionUid}/payment-terminals HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"items": [
{
"id": "text"
}
]
}Last updated