Получение информации о Реселлере (Customer Store)

Метод Get Reseller by ID (Customer Store) доступен только при наличии установленного модуля Customer Store (см. Модуль "Настройки Customer Store").

Для получения информации о текущем Реселлере или о его нижестоящем Реселлере также может использоваться метод Get downstream Reseller information by ID (см. Получение информации о Реселлере).

Метод Get Reseller by ID (Customer Store) позволяет получить информацию о текущем Реселлере или о его нижестоящем Реселлере по уникальному идентификационному номеру.

Доступ к текущему Реселлеру, относительно которого формируется список нижестоящих Реселлеров, определяется по токену Сотрудника, указанному в заголовке запроса.

GET /api/v3/customer_store/resellers/{reseller_id}

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
X-Api-Token	header	string	Обязательный	API токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)
Content-Type	header	string	Обязательный	Предназначен для идентификации формата и способа представления сущности
Accept	header	string	Обязательный	Предназначен для информирования сервера о типах данных, которые поддерживаются клиентом (браузером)
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	Номер телефона компании в международном формате: + < код страны > < код города или сети > < номер телефона > 00 < код страны > < код города или сети > < номер телефона >
		fax	string	Номер факса компании
		email	string	Адрес электронной почты компании
	contacts		object	Модель информации о контактном лице компании, которая является Реселлером
		first_name	string	Имя контактного лица компании
		last_name	string	Фамилия контактного лица компании
		middle_name	string	Отчество контактного лица компании
		position	string	Должность контактного лица компании
		phone	string	Телефонный номер контактного лица компании в международном формате: + < код страны > < код города или сети > < номер телефона > 00 < код страны > < код города или сети > < номер телефона >
		email	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": ""
            }
        }
    }
}