Get downstream reseller

The Get downstream reseller method returns information about the current reseller or any of its downstream resellers.

An API token of a manager is required for authorization. To get an API token via the Operator Control Panel, see Viewing and updating Manager's information

The manager's API token specified in an API request determines the current reseller and downstream resellers accessible within a method.

For getting information about the current reseller or any of its downstream resellers, the Get reseller (Customer Store) method can also be used (see Get reseller (Customer Store)).

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

Arguments

Name

Parameter type

Data type

Required/Optional

Description

X-Api-TokenheaderstringRequiredAPI token of a manager that performs the operation (see Viewing and updating Manager's information)
Content-TypeheaderstringRequiredMedia type of the request. Specify the following: application/vnd.api+json
AcceptheaderstringRequired

Supported media types of the answer. Specify the following: application/vnd.api+json

base_urlpathstringRequiredActivePlatform URL
reseller_idpathintegerRequiredID of the current reseller or any of its downstream resellers (see Viewing and updating Reseller general information)

Response model

NameData typeDescription
idstringReseller ID
typestringData type
attributesobjectReseller information

created_atdateDate and time of the reseller creation

updated_atdateDate and time of the last update of the reseller information

parent_idstringUpstream (parent) reseller ID

generalobjectModel of the general information about the reseller


created_atdateDate and time of the reseller creation


updated_atdateDate and time of the last update of the reseller information


namestringReseller name


domainstringReseller domain


managerstringManager of the upstream reseller (Operator) that is attached to the reseller


currencystringReseller currency in the ISO 4217 alpha-3 format

companyobjectModel of the information about the reseller company


created_atdateDate and time of the reseller company creation


updated_atdateDate and time of the last update of the reseller company information


citystringCity where the company is located


zipstringZip-code of the company


countrystringCompany country code according to ISO 3166-1 alpha-2 standard


faxstringCompany fax number


namestringCompany name


address_line_1stringFirst line of the company address


address_line_2stringSecond line of the company address


statestringState, in which the company is situated


phonestring

Phone number of the company:

  • + < country code > < city code or network code > < phone number >.
  • 00 < country code > < city code or network code > < phone number >.


emailstringCompany email

contactsobjectInformation about reseller contact person


created_atdateDate and time of the reseller contact person creation


updated_atdateDate and time of the last update of the reseller contact person information


first_namestringFirst name of the company contact person


last_namestringLast name of the company contact person


middle_namestringMiddle name of the company contact person


positionstringPosition of the company contact person


phonestring

Phone number of the company contact person:

  • + < country code > < city code or network code > < phone number >.
  • 00 < country code > < city code or network code > < phone number >.


emailstringCompany contact person's email

managerobjectModel of the information about the manager of the upstream reseller (operator) that is attached to the reseller


created_atdateDate and time of the manager creation


updated_atdateDate and time of the last update of the manager information


reseller_idintegerID of the upstream reseller (operator) linked to the manager


idintegerManager ID


namestringManager's name


statusstringManager's status:
  • active — the manager has access to the Operator Control Panel.
  • inactive — the manager has no access to the Operator Control Panel.


emailstringManager's email used as the login to signing in to the Operator Control Panel.


rolestringManager's role (see Managers' Roles)


phonestring

Manager's phone number:

  • + < country code > < city code or network code > < phone number >
  • 00 < country code > < city code or network code > < phone number >


photostringLink to the file of the manager's photo


manager_keystringUnique manager's key


custom_attributesobjectManager attributes



['custom_attribute_key']stringManager attribute value for the specified attribute key

custom_attributesobjectReseller attributes


['custom_attribute_key']stringReseller attribute value for the specified attribute key

Request example

GET /api/v3/resellers/1
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetest3gJXZH5uHCw
Accept: application/vnd.api+json

Response example

{
    "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": "Reseller Root",
                "domain": "test.activeplatform.com",
                "manager": "Alena R",
                "currency": "BYN"
            },
            "company": {
                "created_at": "2016-08-25T09:26:12.491+03:00",
                "updated_at": "2020-01-16T13:10:53.572+03:00",
                "city": "Minsk",
                "zip": "220053",
                "country": "BY",
                "fax": "",
                "name": "Reseller Root",
                "address_line_1": "Main",
                "address_line_2": "str",
                "state": "Минская",
                "phone": "+375250000000",
                "email": "example3@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": "+375260000000",
                "email": "aaaa@example.ru"
            },
            "manager": {
                "created_at": "2017-10-12T15:27:56.354+03:00",
                "updated_at": "2020-11-13T15:49:13.667+03:00",
                "reseller_id": 1,
                "id": 188,
                "name": "Alena R",
                "status": "active",
                "email": "alena@example.com",
                "role": "sales",
                "phone": "+375270000000",
                "photo": "/images/manager/188/188.jpg",
				"manager_key": "",
                "custom_attributes": {}
                },
            "custom_attributes": {
                "inn": "",
                "email": "",
                "l": ""
            }
        }
    }
}

Отзыв | Feedback