Skip to content

Chain Management

Multi-location chain operations and clients

Operations

Obtaining chains available to the user

Request

The location chain object has the following fields:

FieldTypeDescription
idnumberLocation chain ID
titlestringLocation chain name
locationsarrayList of chain locations
accessobjectObject with access rights for chain management
Security
BearerPartner
Headers
Acceptstringrequired

e.g. application/vnd.api.v2+json

Example:application/vnd.api.v2+json
Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer partner_token, User user_token

curl -i -X GET \
  https://developer.alteg.io/_mock/en/b2b-v1/openapi/chains \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}_HERE>' \
  -H 'Content-Type: string'

Responses

OK

Bodyapplication/json
successboolean

Execution success status (true)

Example:true
dataArray of objects

Array of objects with data

Example:
[
  {
    "id": 509,
    "title": "Chain of salons in New York",
    "companies": [ … ],
    "access": { … }
  },
  {
    "id": 508,
    "title": "Chain of salons in New York",
    "companies": [ … ],
    "access": { … }
  }
]
metaArray of objects

Metadata (empty array)

Response
{
  "success": true,
  "data": [
    { … },
    { … }
  ]
}