Tenant

List all tenant identifiers.

get

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/tenants

Authorization: Global Administrator role required.

Pagination: If results exceed max page size, X-continuationToken header contains token for next page.

Use Cases: Tenant directory; system-wide operations; migration tools; admin dashboards.

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearer

OAuth2implicitRequired

Authorization URL:

Responses

200

Tenant identifiers returned.

text/plainapplication/jsontext/json

string[]Optional

401

Caller not authenticated as admin.

text/plainapplication/jsontext/json

403

Caller is not a Global Administrator.

text/plainapplication/jsontext/json

500

Unexpected server error.

get

/api/tenants

HTTPcURLJavaScriptPython

GET /api/tenants HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  "text"
]

Download tenant configuration as ZIP archive.

get

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/tenants/{tenantId}

Authorization: Requires TenantConfiguration.Read scope.

File Selection: Omit files parameter for complete backup; specify files for partial backup.

Versioning: Omit datetime for latest version; specify for point-in-time snapshot.

Archive Naming: {datetime}-{partial-}tenantId.fctwc (e.g., 20240115-093045-mystore.fctwc or 20240115-093045-partial-mystore.fctwc).

Use Cases: Backup, disaster recovery, configuration comparison, audit, environment synchronization.

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Identifier of the tenant

Query parameters

filesstring[]Optional

Get only a subset of configuration. Don't specify any file to get all the configuration

datetimestring · date-timeOptional

Date when to retrieve the configuration. If null or omitted, latest version would be returned

Responses

200

Configuration archive returned.

No content

401

Caller not authenticated.

text/plainapplication/jsontext/json

403

Caller not authorized to read tenant configuration.

text/plainapplication/jsontext/json

404

Tenant or specified files not found.

text/plainapplication/jsontext/json

500

Unexpected server error.

get

/api/tenants/{tenantId}

HTTPcURLJavaScriptPython

GET /api/tenants/{tenantId} HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Create or update tenant configuration files.

post

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/tenants/{tenantId}

Authorization: Requires TenantConfiguration.Write scope.

Full Replacement: All configured files overwritten. Missing files deleted.

Force: Set force=true to save despite validation errors.

Input: Multipart form with ZIP containing all config files.

Use Cases: Full config deployment; environment promotion; disaster recovery restore.

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Identifier of the tenant

Query parameters

forcebooleanOptional

force save even if there is any errors

Body

multipart/form-data

filestring · binaryOptional

A zip file containing all configuration file

Responses

200

Tenant configuration created or updated.

text/plainapplication/jsontext/json

Version information related to a tenant configuration

versionstring · nullableRead-onlyOptional

Version of the configuration

filesobject · nullableOptional

Returns version of each files of the configuration

appliedMigrationsstring[] · nullableOptional

400

Invalid input payload.

text/plainapplication/jsontext/json

401

Caller not authenticated.

text/plainapplication/jsontext/json

403

Caller not authorized to write tenant configuration.

text/plainapplication/jsontext/json

500

Unexpected server error.

post

/api/tenants/{tenantId}

HTTPcURLJavaScriptPython

POST /api/tenants/{tenantId} HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

{
  "version": null,
  "files": null,
  "appliedMigrations": [
    "text"
  ]
}

Create a new tenant with configuration files.

put

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/tenants/{tenantId}

Authorization: Requires TenantConfiguration.Write scope.

Conflict: Returns 409 if tenant already exists.

Force: Set force=true to save despite validation errors (use with caution).

Use Cases: New tenant provisioning; initial deployment; tenant migration.

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Identifier of the tenant

Query parameters

forcebooleanOptional

force save even if there is any errors

Body

multipart/form-data

filestring · binaryOptional

A zip file containing all configuration file

Responses

200

Tenant created with configuration.

text/plainapplication/jsontext/json

Version information related to a tenant configuration

versionstring · nullableRead-onlyOptional

Version of the configuration

filesobject · nullableOptional

Returns version of each files of the configuration

appliedMigrationsstring[] · nullableOptional

400

Invalid input payload.

text/plainapplication/jsontext/json

401

Caller not authenticated.

text/plainapplication/jsontext/json

403

Caller not authorized to write tenant configuration.

text/plainapplication/jsontext/json

409

Tenant already exists.

text/plainapplication/jsontext/json

500

Unexpected server error.

put

/api/tenants/{tenantId}

HTTPcURLJavaScriptPython

PUT /api/tenants/{tenantId} HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

{
  "version": null,
  "files": null,
  "appliedMigrations": [
    "text"
  ]
}

Delete tenant configuration files.

delete

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/tenants/{tenantId}

Authorization: Global Administrator role required.

Operation: Removes all config files for tenant.

Use Cases: Tenant deprovisioning; cleanup; environment removal.

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearer

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Identifier of the tenant

Responses

204

Tenant configuration deleted.

401

Caller not authenticated.

text/plainapplication/jsontext/json

403

Caller not authorized to delete tenant configuration.

text/plainapplication/jsontext/json

500

Unexpected server error.

delete

/api/tenants/{tenantId}

HTTPcURLJavaScriptPython

DELETE /api/tenants/{tenantId} HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Partially update tenant configuration files.

patch

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/tenants/{tenantId}

Authorization: Requires TenantConfiguration.Write scope.

Partial Update: Only included files updated/removed. Other files unchanged.

Empty Files: Empty file in ZIP = removal from config.

Force: Set force=true to save despite validation errors.

Use Cases: Targeted config changes; single-file updates; incremental deployments.

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Identifier of the tenant

Query parameters

forcebooleanOptional

force save even if there is any errors

Body

multipart/form-data

filestring · binaryOptional

A zip containing the files to modify. If a zip contains an empty file it will be removed from the configuration.

Responses

200

Tenant configuration partially updated.

text/plainapplication/jsontext/json

Version information related to a tenant configuration

versionstring · nullableRead-onlyOptional

Version of the configuration

filesobject · nullableOptional

Returns version of each files of the configuration

appliedMigrationsstring[] · nullableOptional

400

Invalid input payload.

text/plainapplication/jsontext/json

401

Caller not authenticated.

text/plainapplication/jsontext/json

403

Caller not authorized to write tenant configuration.

text/plainapplication/jsontext/json

404

Tenant not found.

text/plainapplication/jsontext/json

500

Unexpected server error.

patch

/api/tenants/{tenantId}

HTTPcURLJavaScriptPython

PATCH /api/tenants/{tenantId} HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

{
  "version": null,
  "files": null,
  "appliedMigrations": [
    "text"
  ]
}

Get merged configuration for a tenant layout.

get

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/tenants/{tenantId}/{layoutId}

Merging: Loads base configuration and merges with layout-specific settings. Layout settings take precedence. Applies registered configuration modifiers.

Layouts: Different UI/UX configurations—web (desktop), mobile (native app), kiosk (in-store), pos (point-of-sale).

Use Cases: App initialization; feature flags; themes; layout-specific rules.

Path parameters

tenantIdstringRequired

Identifier of the tenant

layoutIdstringRequired

Identifier of the layout

Responses

200

Merged layout configuration returned.

text/plainapplication/jsontext/json

anyOptional

404

Tenant or layout configuration not found.

text/plainapplication/jsontext/json

500

Unexpected server error.

get

/api/tenants/{tenantId}/{layoutId}

HTTPcURLJavaScriptPython

GET /api/tenants/{tenantId}/{layoutId} HTTP/1.1
Host: app.neostore.cloud
Accept: */*

No content

Validate tenant configuration.

get

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/tenants/{tenantId}/test

Validation: YAML syntax, schemas, required fields, integration settings, resource references, business rule consistency.

Auth: Optional admin auth. Unauthenticated get basic success/failure. Authenticated get detailed errors.

Use Cases: Pre-deployment validation; troubleshooting; CI/CD checks; manual verification.

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Identifier of the tenant

Responses

200

Configuration valid.

No content

401

Caller not authenticated (when admin auth enforced).

text/plainapplication/jsontext/json

500

Validation failed or unexpected server error.

get

/api/tenants/{tenantId}/test

HTTPcURLJavaScriptPython

GET /api/tenants/{tenantId}/test HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content