Управлять брендами

Заголовок	Описание
x-auth-token	Ваш jwt токен для авторизации.
x-request-locale	Необязательный. Язык сообщения об ошибке. Укажите значение ru_RU

Параметры запроса

Параметр	Тип	Обязательный	Описание
offset	string minimum: 1 maximum: 1000	Да	На сколько пунктов сдвинуть список. Например, чтобы получить бренды начиная с 10-го, укажите 9.
limit	string	Да	Сколько получить брендов.
filters	object	Нет
↳ dateFrom	string	Нет	Фильтровать по дате (и времени), после которой добавлен бренд, формат: YYY-MM-DDThh:mm:ssZ.
↳ dateTo	string	Нет	Фильтровать по дате (и времени), до которой добавлен бренд, формат: YYY-MM-DDThh:mm:ssZ.
↳ status	array of strings	Нет	Фильтровать по статусам брендов: approved (одобрен); pending (на рассмотрении); declined (отклонён).
↳ name	string	Нет	Фильтровать по названию бренда.
sort	object	Нет	Параметры сортировки.
↳ by	string	Нет	По какому параметру сортировать: name (по названию); createdAt (по дате добавления); status (по статусу). По умолчанию бренды сортируются по дате добавления, по убыванию.
↳ dir	string	Нет	Как сортировать: asc (по возрастанию); desc (по убыванию). По умолчанию бренды сортируются по дате добавления, по убыванию.

Пример запроса

curl --location --request POST 'https://openapi.ru.laliexpress.com/api/v1/brand/get-brand-list' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <YOUR_API_TOKEN>' \
--data-raw '{
    "offset": "0",
    "limit": "2",
    "filters": {
    },
    "sort": {
        "by": "name",
        "dir": "asc"
    }
}'

Параметры ответа

Параметр	Тип	Описание
data	object	Результаты запроса.
↳ total	string	Сколько брендов нашлось по запросу.
↳ fullTotal	string	Сколько всего у вас брендов.
↳ list	object	Список найденных брендов.
↳ id, bizId	string	Идентификаторы бренда в системе. bizId — Устаревший.
↳ name	string	Название бренда.
↳ createdAt	string	Дата и время, когда добавлен бренд. Формат: YYY-MM-DDThh:mm:ss.
↳ status	string	Статус бренда: approved (одобрен); pending (на рассмотрении); declined (отклонён).
offset	string	На сколько пунктов сдвинут список, вы указывали это значение в запросе. Например, если значение 9, то вы видите бренды начиная с 10-го.
limit	string	Сколько максимум брендов можно было получить, вы указывали это значение в запросе.
filters	object	Параметры фильтров.
↳ dateFrom	string	Дата (и время), после которой добавлен бренд, вы указывали это значение в запросе. Формат: YYY-MM-DDThh:mm:ssZ.
↳ dateTo	string	Дата (и время), до которой добавлен бренд, вы указывали это значение в запросе. Формат: YYY-MM-DDThh:mm:ssZ.
↳ status	array of strings	По каким статусам отфильтрованы бренды: approved (одобрен); pending (на рассмотрении); declined (отклонён). Вы указывали это в запросе.
↳ name	string	Название бренда, которое вы указывали в запросе.
sort	object	Параметры сортировки.
↳ by	string	По какому параметру отсортированы бренды: name (название); createdAt (дата добавления); status (статус). Вы указывали это в запросе.
↳ dir	string	Как остортированы бренды: asc (по возрастанию); decs (по убыванию). Вы указывали это в запросе.

Пример ответа

{
    "data": {
        "total": "33",
        "fullTotal": "33",
        "list": [
            {
                "id": "310368382",
                "name": "ALL INCLUSIVE",
                "createdAt": "2022-06-20T08:39:17+00:00",
                "status": "approved"
            },
            {
                "id": "203730195",
                "name": "Alvin D'or",
                "createdAt": "2022-06-20T08:39:39+00:00",
                "status": "approved"
            }
        ],
        "offset": "0",
        "limit": "2",
        "filters": {
            "dateFrom": "",
            "dateTo": "",
            "status": [],
            "name": ""
        },
        "sort": {
            "by": "name",
            "dir": "asc"
        }
    }
}

Найти бренд на LAliExpress

POST /api/v1/brand/search-brand

Возвращает список всех брендов, которые содержат поисковое слово и представлены на LAliExpress.

В запросе укажите следующие заголовки:

Заголовок	Описание
x-auth-token	Ваш jwt токен для авторизации.
x-request-locale	Необязательный. Язык сообщения об ошибке. Укажите значение ru_RU

Параметры запроса

Параметр	Тип	Обязательный	Описание
search	string minimum: 2	Да	Поисковое слово или словосочетание. Должно соответствовать названию бренда.

Пример запроса

curl --location --request POST 'https://openapi.ru.laliexpress.com/api/v1/brand/search-brand' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <YOUR_API_TOKEN>' \
--data '{
    "search": "ADIDAS"
}'

Параметры ответа

Параметр	Тип	Описание
data	object	Результаты запроса.
↳ id	string	Идентификатор бренда.
↳ name	string	Название бренда.
↳ requiredApproval	boolean	Требуются ли разрешительные документы для продажи товаров бренда: true (требуются). Для добавления бренда в ваш список нужно предоставить ссылки на разрешительные документы; false (не требуются).

Пример ответа

{
    "data": [
        {
            "id": "200746885",
            "name": "Adidas",
            "requiredApproval": true
        },
        {
            "id": "6112724",
            "name": "Adidas.",
            "requiredApproval": false
        },
        {
            "id": "201459775",
            "name": "adidas neo",
            "requiredApproval": false
        },
        {
            "id": "877258650",
            "name": "ADIDAS TERREX",
            "requiredApproval": false
        },
        {
            "id": "203594417",
            "name": "hkadidasty",
            "requiredApproval": false
        },
        {
            "id": "204764116",
            "name": "adldas",
            "requiredApproval": false
        },
        {
            "id": "203390135",
            "name": "ADIDAS ORIGINALS",
            "requiredApproval": false
        }
    ]
}

Добавить бренд c LAliExpress в свой список

POST /api/v1/brand/add-existing-brand

Добавляет бренд, который уже представлен на LAliExpress, в список ваших брендов.

В запросе укажите следующие заголовки:

Заголовок	Описание
x-auth-token	Ваш jwt токен для авторизации.
x-request-locale	Необязательный. Язык сообщения об ошибке. Укажите значение ru_RU

Параметры запроса

Параметр	Тип	Обязательный	Описание
id	string	Да	Идентификатор бренда.
fileUrls	array of strings minimum: null maximum: 5	Нет	Список ссылок на разрешительные документы. Требования к файлу: до 5 Мб в формате PDF, JPEG или PNG. Укажите ссылки, если для бренда требуются разрешительные документы. Проверить обязательность можно с помощью метода POST /api/v1/brand/search-brand.

Пример запроса

curl --location --request POST 'https://openapi.ru.laliexpress.com/api/v1/brand/add-existing-brand' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <YOUR_API_TOKEN>' \
--data '{
    "id": "300092364",
    "fileUrls": [   ]
}'

Параметры ответа

Параметр	Тип	Описание
data	boolean	Результаты обработки запроса: true (бренд добавлен). Если бренд не добавлен, в ответе вернётся ошибка с указанием причины.

Пример ответа

{
    "data": true
}

Создать бренд

POST /api/v1/brand/add-new-brand

Добавляет новый бренд на LAliExpress и в список ваших брендов.

Перед созданием убедитесь, что такого бренда ещё нет на LAliExpress с помощью метода POST /api/v1/brand/search-brand. После создания бренда LAliExpress может его проверить и запросить разрешительные документы либо удалить бренд. Подробнее о создании бренда.

В запросе укажите следующие заголовки:

Заголовок	Описание
x-auth-token	Ваш jwt токен для авторизации.
x-request-locale	Необязательный. Язык сообщения об ошибке. Укажите значение ru_RU

Параметры запроса

Параметр	Тип	Обязательный	Описание
country	string	Да	Страна регистрации бренда. Возможные значения
name	string	Да	Наименование бренда.
enName	string	Нет	Наименование на английском.
registrationNumber	string	Нет	Регистрационный номер. Данные о брендах можно найти, например, на сайте Online patent. Для этого введите название бренда в поисковую строку и нажмите Искать. Нажмите на нужный бренд — на открывшейся странице найдите «Номер товарного знака» (укажите его в параметре registrationNumber).
registrationOwner	string	Нет	Владелец регистрации. Данные о брендах можно найти, например, на сайте Online patent. Для этого введите название бренда в поисковую строку и нажмите Искать. Нажмите на нужный бренд — на открывшейся странице найдите «Номер правообладателя» (укажите его в параметре registrationOwner).

Пример запроса

curl --location --request POST 'https://openapi.ru.laliexpress.com/api/v1/brand/add-new-brand' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <YOUR_API_TOKEN>' \
--data '{
        "country": "Russia",
        "name": "Bester007",
        "enName": "Bester007",
        "registrationNumber": "1234569800983401",
        "registrationOwner": "Bester Iternational"
}'

Параметры ответа

Параметр	Тип	Описание
data	boolean	Результаты обработки запроса: true (бренд создан). Если бренд не создан, в ответе вернётся ошибка с указанием причины.