Получение информации о реселлере (Customer Store)
Метод Get reseller (Customer Store) доступен только при наличии установленного модуля Customer Store (см. Управление Витриной).
Для получения информации о текущем реселлере или о его нижестоящем реселлере также может использоваться метод Get downstream reseller (см. Получение информации о реселлере).
Метод Get reseller (Customer Store) позволяет получить информацию о текущем реселлере или о его нижестоящем реселлере по уникальному идентификационному номеру.
Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).
По указанному в запросе API-токену определяются:
- Роль и уровень доступа менеджера, от которых зависит доступность метода.
- Текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.
GET /api/v3/customer_store/resellers/{reseller_id}
Аргументы
Название | Тип параметра | Тип данных | Обязательный/ | Описание |
---|---|---|---|---|
X-Api-Token | header | string | Обязательный | API-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике) |
Content-Type | header | string | Обязательный | Тип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json |
Accept | header | string | Обязательный | Поддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json |
base_url | path | string | Обязательный | URL ActivePlatform |
reseller_id | path | integer | Обязательный | ID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере) |
Модель ответа
Название | Тип данных | Описание | ||
---|---|---|---|---|
id | string | Уникальный идентификатор реселлера | ||
type | string | Тип данных | ||
attributes | object | Информация о реселлере | ||
parent_id | string | Уникальный идентификатор вышестоящего (родительского) реселлера | ||
created_at | date | Дата создания реселлера | ||
updated_at | date | Дата обновления информации о реселлере | ||
general | object | Общая информация о реселлере | ||
name | string | Название реселлера | ||
domain | string | Домен реселлера | ||
currency | string | Код валюты реселлера ISO 4217 alpha-3. | ||
manager | string | Менеджер, прикрепленный к реселлеру | ||
company | object | Модель информации о компании, которая является данным реселлером | ||
name | string | Название компании | ||
address_line_1 | string | Первая строка адреса компании | ||
address_line_2 | string | Вторая строка адреса компании | ||
city | string | Город, в котором расположена компания | ||
state | string | Штат/Область, в которой расположена компания | ||
zip | string | Почтовый индекс компании | ||
country | string | Код страны ISO 3166-1 alpha-2, в которой расположена компания | ||
phone | string | Номер телефона компании в международном формате:
| ||
fax | string | Номер факса компании | ||
string | Адрес электронной почты компании | |||
contacts | object | Модель информации о контактном лице компании, которая является реселлером | ||
first_name | string | Имя контактного лица компании | ||
last_name | string | Фамилия контактного лица компании | ||
middle_name | string | Отчество контактного лица компании | ||
position | string | Должность контактного лица компании | ||
phone | string | Телефонный номер контактного лица компании в международном формате:
| ||
string | Адрес электронной почты контактного лица компании | |||
attributes.custom_attributes | object | Дополнительные параметры реселлера | ||
attributes.custom_attributes['custom_attribute_key'] | string | Значение дополнительного параметра |
Пример запроса
GET /api/v3/customer_store/resellers/1
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetest3gJXZH5uHCw
Accept: application/vnd.api+json
Пример ответа
{
"data": {
"id": "1",
"type": "resellers",
"attributes": {
"created_at": "2016-08-25T09:26:12.491+03:00",
"updated_at": "2020-01-16T13:10:53.572+03:00",
"parent_id": 27,
"general": {
"created_at": "2016-08-25T09:26:12.491+03:00",
"updated_at": "2020-01-16T13:10:53.572+03:00",
"name": "SL SP Root",
"domain": "test.activeplatform.com",
"manager": "Alena Rataeva",
"currency": "BYN"
},
"company": {
"created_at": "2016-08-25T09:26:12.491+03:00",
"updated_at": "2020-01-16T13:10:53.572+03:00",
"city": "Минск",
"zip": "220053",
"country": "BY",
"fax": "",
"name": "SL SP Root",
"address_line_1": "Гаяяяя",
"address_line_2": "Гаяяяяя",
"state": "Минская",
"phone": "+375252222060",
"email": "example@gmail.com"
},
"contacts": {
"created_at": "2016-08-25T09:26:12.491+03:00",
"updated_at": "2020-01-16T13:10:53.572+03:00",
"first_name": "Ivan",
"last_name": "Ivanov",
"middle_name": "",
"position": "",
"phone": "+375252222060",
"email": "aaaa@example.ru"
},
"custom_attributes": {
"inn": "",
"email": "",
"l": ""
}
}
}
}