Получение информации о реселлере (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-TokenheaderstringОбязательныйAPI-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)
Content-TypeheaderstringОбязательныйТип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json
AcceptheaderstringОбязательныйПоддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json
base_urlpathstringОбязательныйURL ActivePlatform
reseller_idpathintegerОбязательныйID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере)

Модель ответа

НазваниеТип данныхОписание
idstringУникальный идентификатор реселлера
typestringТип данных
attributesobjectИнформация о реселлере

parent_idstringУникальный идентификатор вышестоящего (родительского) реселлера

created_atdateДата создания реселлера

updated_atdateДата обновления информации о реселлере

generalobjectОбщая информация о реселлере


namestringНазвание реселлера


domainstringДомен реселлера


currencystringКод валюты реселлера ISO 4217 alpha-3.


managerstringМенеджер, прикрепленный к реселлеру

companyobjectМодель информации о компании, которая является данным реселлером


namestringНазвание компании


address_line_1stringПервая строка адреса компании


address_line_2stringВторая строка адреса компании


citystringГород, в котором расположена компания


statestringШтат/Область, в которой расположена компания


zipstringПочтовый индекс компании


countrystringКод страны ISO 3166-1 alpha-2, в которой расположена компания


phonestring

Номер телефона компании в международном формате:

  • + < код страны > < код города или сети > < номер телефона >.
  • 00 < код страны > < код города или сети > < номер телефона >.


faxstringНомер факса компании


emailstringАдрес электронной почты компании

contactsobjectМодель информации о контактном лице компании, которая является реселлером


first_namestringИмя контактного лица компании


last_namestringФамилия контактного лица компании


middle_namestringОтчество контактного лица компании


positionstringДолжность контактного лица компании


phonestringТелефонный номер контактного лица компании в международном формате:
  • + < код страны > < код города или сети > < номер телефона >.
  • 00 < код страны > < код города или сети > < номер телефона >.


emailstringАдрес электронной почты контактного лица компании

attributes.custom_attributesobjectДополнительные параметры реселлера


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": ""
            }
        }
    }
}