Получение списка реселлеров (Customer Store)
Метод Get list of resellers (Customer Store) доступен только при наличии установленного модуля Customer Store (см. Управление Витриной).
Для получения cписка нижестоящих реселлеров также может использоваться метод Get list of downstream resellers (см. Получение списка нижестоящих реселлеров).
Метод Get list of resellers (Customer Store) используется для получения списка нижестоящих реселлеров по отношению к текущему реселлеру.
Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).
По указанному в запросе API-токену определяются:
- Роль и уровень доступа менеджера, от которых зависит доступность метода.
- Текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.
GET {base_url}/api/v3/customer_store/resellersАргументы
Название | Тип параметра | Тип данных | Обязательный/ | Описание |
|---|---|---|---|---|
| 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 |
page[number] | query | integer | Опциональный | Возвращается список реселлеров по указанному номеру страницы |
page[size] | query | integer | Опциональный | Установка числа элементов на странице |
Модель ответа
| Название | Тип данных | Описание | ||
|---|---|---|---|---|
| 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 alfa-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/?page[size]=2&page[number]=78
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetest3gJXZH5uHCw
Accept: application/vnd.api+jsonПример ответа
{
"data": [
{
"id": "297",
"type": "resellers",
"attributes": {
"created_at": "2020-02-06T11:04:58.024+03:00",
"updated_at": "2020-02-06T11:04:58.031+03:00",
"parent_id": 294,
"general": {
"created_at": "2020-02-06T11:04:58.024+03:00",
"updated_at": "2020-02-06T11:04:58.031+03:00",
"name": "3 2 child",
"domain": "",
"manager": "admin",
"currency": "USD"
},
"company": {
"created_at": "2020-02-06T11:04:58.024+03:00",
"updated_at": "2020-02-06T11:04:58.031+03:00",
"city": "Минск",
"zip": "220005",
"country": "BY",
"fax": "",
"name": "yuy",
"address_line_1": "Колоса",
"address_line_2": "",
"state": "Минская",
"phone": "+375298794561",
"email": "hko@tttu.by"
},
"contacts": {
"created_at": "2020-02-06T11:04:58.024+03:00",
"updated_at": "2020-02-06T11:04:58.031+03:00",
"first_name": "Юлий",
"last_name": "Юлий",
"middle_name": "",
"position": "",
"phone": "+375298794599",
"email": "ko@tttu.by"
},
"custom_attributes": {}
}
},
{
"id": "298",
"type": "resellers",
"attributes": {
"created_at": "2020-02-13T02:43:51.617+03:00",
"updated_at": "2020-02-16T07:36:55.100+03:00",
"parent_id": 1,
"general": {
"created_at": "2020-02-13T02:43:51.617+03:00",
"updated_at": "2020-02-16T07:36:55.100+03:00",
"name": "ResellerRoman",
"domain": "romankuzenkotest.com",
"manager": "Roman Kuzenko",
"currency": "USD"
},
"company": {
"created_at": "2020-02-13T02:43:51.617+03:00",
"updated_at": "2020-02-16T07:36:55.100+03:00",
"city": "Minsk",
"zip": "",
"country": "BY",
"fax": "",
"name": "RomanCompany",
"address_line_1": "Tanka",
"address_line_2": "",
"state": "Minsk",
"phone": "+375175555555",
"email": ""
},
"contacts": {
"created_at": "2020-02-13T02:43:51.617+03:00",
"updated_at": "2020-02-16T07:36:55.100+03:00",
"first_name": "Roman",
"last_name": "Kuzmenko",
"middle_name": "",
"position": "",
"phone": "+375175555555",
"email": "roman@lop.com"
},
"custom_attributes": {
"softline1c_plugin_api_password": "",
"softline1c_plugin_api_name": "",
"kpp": "",
"inn": "1321",
"reseller_mpn_id_ttttt": "",
"loc_1": "555",
"l_ocation": "",
"l_ocationv": "",
"ererere": "5445",
"inn_inn": ""
}
}
}
],
"links": {
"self": "http://test.activeplatform.com/api/v3/customer_store/resellers/?page%5Bnumber%5D=78&page%5Bsize%5D=2",
"first": "http://test.activeplatform.com/api/v3/customer_store/resellers/?page%5Bnumber%5D=1&page%5Bsize%5D=2",
"prev": "http://test.activeplatform.com/api/v3/customer_store/resellers/?page%5Bnumber%5D=77&page%5Bsize%5D=2",
"next": "http://test.activeplatform.com/api/v3/customer_store/resellers/?page%5Bnumber%5D=79&page%5Bsize%5D=2",
"last": "http://test.activeplatform.com/api/v3/customer_store/resellers/?page%5Bnumber%5D=80&page%5Bsize%5D=2"
}
}