Store

Get all stores accessible to the current user

get

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

/api/{tenantId}/stores

Returns stores based on the caller's authorization level:

Administrator Access

Global administrators see all stores in the tenant.

Limited Access

Regular users see only stores they have Stores.Read permission for, as determined by:

• JWT token claims

• Tenant permission providers

• Store-specific access controls

Use Cases

• Store selector UI

• Multi-location dashboards

• Regional filtering

Path parameters

tenantIdstringRequired

Responses

200

Stores returned based on caller authorization.

text/plainapplication/jsontext/json

storeIdstring · nullableRequired

displayNamestring · nullableRequired

availableLanguagesstring[] · nullableOptional

additionalResourcesobject · nullableOptional

additionalPropertiesobject · nullableOptional

401

Caller not authenticated.

text/plainapplication/jsontext/json

500

Unexpected server error.

get

/api/{tenantId}/stores

HTTPcURLJavaScriptPython

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

[
  {
    "storeId": null,
    "displayName": null,
    "availableLanguages": [
      "text"
    ],
    "additionalResources": null,
    "additionalProperties": null
  }
]

Get detailed information for a specific store

get

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

/api/{tenantId}/stores/{storeId}

Retrieves comprehensive store details including localized resources and custom properties.

Authorization

Requires Stores.Read scope for the specified store.

Use Cases

• Store detail pages

• Location-based routing

• Store-specific configuration

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

storeIdstringRequired

The store identifier.

tenantIdstringRequired

Responses

200

Store found and returned.

text/plainapplication/jsontext/json

storeIdstring · nullableRequired

displayNamestring · nullableRequired

availableLanguagesstring[] · nullableOptional

additionalResourcesobject · nullableOptional

additionalPropertiesobject · nullableOptional

401

Caller not authenticated.

text/plainapplication/jsontext/json

403

Caller not authorized for the store.

text/plainapplication/jsontext/json

404

Store not found.

text/plainapplication/jsontext/json

500

Unexpected server error.

get

/api/{tenantId}/stores/{storeId}

HTTPcURLJavaScriptPython

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

{
  "storeId": null,
  "displayName": null,
  "availableLanguages": [
    "text"
  ],
  "additionalResources": null,
  "additionalProperties": null
}

Get localized resources for a store

get

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

/api/{tenantId}/stores/{storeId}/additionalResources

Retrieves store-specific localized content from configured resource files.

Resource Structure

Resources are organized hierarchically:

stores:
  store123:
    welcomeMessage: "Welcome to our downtown location"
    hours: "Mon-Fri 9AM-9PM"

Localization

• Resources vary by language/culture

• Configured via AdditionalLocaleFiles in tenant settings

• Falls back gracefully when translations are missing

Use Cases

• Store-specific messaging

• Location hours and contact info

• Custom promotional content

Path parameters

storeIdstringRequired

The store identifier.

tenantIdstringRequired

Responses

200

Localized resources returned.

text/plainapplication/jsontext/json

Other propertiesanyOptional

401

Caller not authenticated.

text/plainapplication/jsontext/json

403

Caller not authorized for the store.

text/plainapplication/jsontext/json

404

Store not found.

text/plainapplication/jsontext/json

500

Unexpected server error.

get

/api/{tenantId}/stores/{storeId}/additionalResources

HTTPcURLJavaScriptPython

GET /api/{tenantId}/stores/{storeId}/additionalResources HTTP/1.1
Host: app.neostore.cloud
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get all staff advisors for a store

get

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

/api/{tenantId}/stores/{storeId}/advisors

Returns the list of advisors (sales associates, staff members) assigned to a specific store location.

Authorization

Requires Stores.Read scope for the specified store.

Use Cases

• Staff selection in appointment booking

• Associate assignment for customer service

• Sales attribution and tracking

• Employee directory

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

storeIdstringRequired

The store identifier.

tenantIdstringRequired

Responses

200

Advisors returned.

text/plainapplication/jsontext/json

advisorIdstring · nullableRequired

displayNamestring · nullableRequired

401

Caller not authenticated.

text/plainapplication/jsontext/json

403

Caller not authorized for the store.

text/plainapplication/jsontext/json

404

Store not found.

text/plainapplication/jsontext/json

500

Unexpected server error.

get

/api/{tenantId}/stores/{storeId}/advisors

HTTPcURLJavaScriptPython

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

[
  {
    "advisorId": null,
    "displayName": null
  }
]