Stores

List stores for the tenant

get

/api/{tenantId}/admin/stores

Returns every store defined in server/data/stores.yml, with full details.

Authorization

Requires tenant.configuration.dataStore:read scope.

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Responses

200

Stores returned.

Full definition of a store, returned by list/get/create/update endpoints.

storeIdstringRequired

Unique identifier of the store.

displayNamestring · nullableOptional

Display name of the store.

addressstring · nullableOptional

Postal address of the store.

longitudenumber · doubleRequired

Longitude of the store in decimal value.

latitudenumber · doubleRequired

Latitude of the store in decimal value.

altitudeinteger · nullableOptional

Optional altitude of the store in meters.

availableLanguagesstring[]Optional

List of ISO 639 language codes available for this store.

get/api/{tenantId}/admin/stores

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

200

Stores returned.

[
  {
    "storeId": "text",
    "displayName": null,
    "address": null,
    "longitude": 1,
    "latitude": 1,
    "altitude": null,
    "availableLanguages": [
      "text"
    ],
    "advisors": [
      {
        "advisorId": "text",
        "displayName": "text"
      }
    ],
    "additionalProperties": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
]

Create a new store

post

/api/{tenantId}/admin/stores

Adds a new physical store location to the tenant's store configuration.

Authorization

Requires tenant.configuration.dataStore:write scope.

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Body

Request body to create a store.

storeIdstring · min: 1Required

Unique identifier of the store. Only alphanumeric characters, hyphens, underscores and dots are allowed.

displayNamestring · nullableOptional

Display name of the store.

addressstring · nullableOptional

Postal address of the store.

longitudenumber · doubleRequired

Longitude of the store in decimal value.

latitudenumber · doubleRequired

Latitude of the store in decimal value.

altitudeinteger · nullableOptional

Optional altitude of the store in meters.

availableLanguagesstring[]Optional

List of ISO 639 language codes available for this store.

Responses

201

Store created.

Full definition of a store, returned by list/get/create/update endpoints.

storeIdstringRequired

Unique identifier of the store.

displayNamestring · nullableOptional

Display name of the store.

addressstring · nullableOptional

Postal address of the store.

longitudenumber · doubleRequired

Longitude of the store in decimal value.

latitudenumber · doubleRequired

Latitude of the store in decimal value.

altitudeinteger · nullableOptional

Optional altitude of the store in meters.

availableLanguagesstring[]Optional

List of ISO 639 language codes available for this store.

400

Store identifier is invalid.

409

A store with this identifier already exists.

post/api/{tenantId}/admin/stores

POST /api/{tenantId}/admin/stores HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 242

{
  "storeId": "text",
  "displayName": null,
  "address": null,
  "longitude": 1,
  "latitude": 1,
  "altitude": null,
  "availableLanguages": [
    "text"
  ],
  "advisors": [
    {
      "advisorId": "text",
      "displayName": "text"
    }
  ],
  "additionalProperties": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "storeId": "text",
  "displayName": null,
  "address": null,
  "longitude": 1,
  "latitude": 1,
  "altitude": null,
  "availableLanguages": [
    "text"
  ],
  "advisors": [
    {
      "advisorId": "text",
      "displayName": "text"
    }
  ],
  "additionalProperties": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Get a specific store

get

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

Returns the full definition of the store identified by storeId.

Authorization

Requires tenant.configuration.dataStore:read scope.

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2implicitRequired

Authorization URL:

Path parameters

storeIdstringRequired

tenantIdstringRequired

Responses

200

Store returned.

Full definition of a store, returned by list/get/create/update endpoints.

storeIdstringRequired

Unique identifier of the store.

displayNamestring · nullableOptional

Display name of the store.

addressstring · nullableOptional

Postal address of the store.

longitudenumber · doubleRequired

Longitude of the store in decimal value.

latitudenumber · doubleRequired

Latitude of the store in decimal value.

altitudeinteger · nullableOptional

Optional altitude of the store in meters.

availableLanguagesstring[]Optional

List of ISO 639 language codes available for this store.

404

Store not found.

get/api/{tenantId}/admin/stores/{storeId}

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

{
  "storeId": "text",
  "displayName": null,
  "address": null,
  "longitude": 1,
  "latitude": 1,
  "altitude": null,
  "availableLanguages": [
    "text"
  ],
  "advisors": [
    {
      "advisorId": "text",
      "displayName": "text"
    }
  ],
  "additionalProperties": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Update an existing store

put

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

Replaces the store's fields. The store identifier cannot be changed.

Authorization

Requires tenant.configuration.dataStore:write scope.

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

storeIdstringRequired

Body

Request body to update a store. Fully replaces the store's fields other than its identifier.

displayNamestring · nullableOptional

Display name of the store.

addressstring · nullableOptional

Postal address of the store.

longitudenumber · doubleRequired

Longitude of the store in decimal value.

latitudenumber · doubleRequired

Latitude of the store in decimal value.

altitudeinteger · nullableOptional

Optional altitude of the store in meters.

availableLanguagesstring[]Optional

List of ISO 639 language codes available for this store.

Responses

200

Store updated.

Full definition of a store, returned by list/get/create/update endpoints.

storeIdstringRequired

Unique identifier of the store.

displayNamestring · nullableOptional

Display name of the store.

addressstring · nullableOptional

Postal address of the store.

longitudenumber · doubleRequired

Longitude of the store in decimal value.

latitudenumber · doubleRequired

Latitude of the store in decimal value.

altitudeinteger · nullableOptional

Optional altitude of the store in meters.

availableLanguagesstring[]Optional

List of ISO 639 language codes available for this store.

404

Store not found.

put/api/{tenantId}/admin/stores/{storeId}

PUT /api/{tenantId}/admin/stores/{storeId} HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 225

{
  "displayName": null,
  "address": null,
  "longitude": 1,
  "latitude": 1,
  "altitude": null,
  "availableLanguages": [
    "text"
  ],
  "advisors": [
    {
      "advisorId": "text",
      "displayName": "text"
    }
  ],
  "additionalProperties": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "storeId": "text",
  "displayName": null,
  "address": null,
  "longitude": 1,
  "latitude": 1,
  "altitude": null,
  "availableLanguages": [
    "text"
  ],
  "advisors": [
    {
      "advisorId": "text",
      "displayName": "text"
    }
  ],
  "additionalProperties": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Delete a store

delete

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

Removes the store from the tenant's store configuration.

Authorization

Requires tenant.configuration.dataStore:write scope.

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

storeIdstringRequired

Responses

204

Store deleted.

No content

404

Store not found.

delete/api/{tenantId}/admin/stores/{storeId}

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

No content