Управлять товарными группами

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

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

Параметр	Тип	Обязательный	Описание
parent_group_id	string	Нет	Идентификатор родительской группы.
settings	object	Нет	Настройки для создаваемой продуктовой группы.
↳ rank	int	Нет	Ранг товарной группы. Чем больше ранг, тем выше эта группа будет в списке товарных групп.
↳ sort_type	string	Нет	Атрибут, по которому должны быть отсортированы товары в группе. Возможные значения: PRODUCT_GROUP_SORT_TYPE_DEFAULT — Значение по умолчанию — без сортировки PRODUCT_GROUP_SORT_TYPE_ORDERS — Отсортировать по числу заказов PRODUCT_GROUP_SORT_TYPE_NEWEST — Отсортировать по времени добавления PRODUCT_GROUP_SORT_TYPE_PRICE — Отсортировать по цене
↳ sort_dir	string	Нет	Порядок сортировки товаров в группе. Возможные значения: PRODUCT_GROUP_SORT_DIR_DEFAULT — Значение по умолчанию — без сортировки PRODUCT_GROUP_SORT_DIR_DESC — Отсортировать по убыванию PRODUCT_GROUP_SORT_DIR_ASC — Отсортировать по возрастанию
↳ is_active	boolean	Нет	Видимость товарной группы. По умолчанию true.
names	array of objects	Да	Названия товарной группы на разных языках. Обязательно передайте название на дефолтном языке: "lang": "PRODUCT_GROUP_LANG_DEFAULT" и его value. Названия на других языках — опционально.
↳ lang	string	Да, для дефолтного языка (PRODUCT_GROUP_LANG_DEFAULT). Для остальных языков — опционально.	Язык названия товарной группы. Возможные значения: PRODUCT_GROUP_LANG_DEFAULT — Дефолтный язык вашего магазина PRODUCT_GROUP_LANG_AR — Арабский PRODUCT_GROUP_LANG_NL — Нидерландский (Голландский) PRODUCT_GROUP_LANG_EN — Английский PRODUCT_GROUP_LANG_FR — Французский PRODUCT_GROUP_LANG_DE — Немецкий PRODUCT_GROUP_LANG_HE — Иврит PRODUCT_GROUP_LANG_ID — Индонезийский PRODUCT_GROUP_LANG_IT — Итальянский PRODUCT_GROUP_LANG_JA — Японский PRODUCT_GROUP_LANG_KO — Корейский PRODUCT_GROUP_LANG_PL — Польский PRODUCT_GROUP_LANG_PT — Португальский PRODUCT_GROUP_LANG_ES — Испанский PRODUCT_GROUP_LANG_TH — Тайский PRODUCT_GROUP_LANG_TR — Турецкий PRODUCT_GROUP_LANG_UK — Украинский PRODUCT_GROUP_LANG_VI — Вьетнамский PRODUCT_GROUP_LANG_RU — Русский
↳ value	string	Да, если передаёте lang.	Название товарной группы на указанном языке.

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

curl --location --request POST 'https://openapi.ru.laliexpress.com/api/v2/posting/create-product-group' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <YOUR_API_TOKEN>' \
--data-raw '{
  "parent_group_id": "9000000000000000015",
  "settings": {
    "rank": 0,
    "sort_type": "PRODUCT_GROUP_SORT_TYPE_DEFAULT",
    "sort_dir": "PRODUCT_GROUP_SORT_DIR_DEFAULT",
    "is_active": true
  },
  "names": [
    {
      "lang": "PRODUCT_GROUP_LANG_DEFAULT",
      "value": "Vinyl Records"
    }
  ]
}'

Параметры успешного ответа

Параметр	Тип	Описание
group_id	string	Идентификатор созданной группы.

Пример успешного ответа

{
  "group_id": "9000000000000009429"
}

Параметры ответа с ошибкой

Параметр	Тип	Описание
data	object	Данные ответа.
error	object	Информация об ошибке.
↳ code	string	Код ошибки.
↳ message	string	Сообщение об ошибке.
↳ details	object	Подробности об ошибке.

Пример ответа с ошибкой

{
  "data": {},
  "error": {
    "code": "400",
    "message": "Bad Request: The request is malformed or missing required parameters.",
    "details": {}
  }
}

Получить товарные группы

POST /api/v2/posting/get-product-groups-by-seller

Возвращает список ваших товарных групп.

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

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

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

В запросе нет обязательных входящих параметров.

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

curl --location --request POST 'https://openapi.ru.laliexpress.com/api/v2/posting/get-product-groups-by-seller' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <YOUR_API_TOKEN>'

Параметры успешного ответа

Параметр	Тип	Описание
product_groups	array of objects	Товарные группы.
↳ group_id	string	Идентификатор товарной группы.
↳ child_groups	array of objects	Дочерние товарные группы.
↳ localized_names	array of objects	Названия товарной группы на разных языках.
↳ lang	string	Язык названия товарной группы. Возможные значения: PRODUCT_GROUP_LANG_DEFAULT — Дефолтный язык вашего магазина PRODUCT_GROUP_LANG_AR — Арабский PRODUCT_GROUP_LANG_NL — Нидерландский (Голландский) PRODUCT_GROUP_LANG_EN — Английский PRODUCT_GROUP_LANG_FR — Французский PRODUCT_GROUP_LANG_DE — Немецкий PRODUCT_GROUP_LANG_HE — Иврит PRODUCT_GROUP_LANG_ID — Индонезийский PRODUCT_GROUP_LANG_IT — Итальянский PRODUCT_GROUP_LANG_JA — Японский PRODUCT_GROUP_LANG_KO — Корейский PRODUCT_GROUP_LANG_PL — Польский PRODUCT_GROUP_LANG_PT — Португальский PRODUCT_GROUP_LANG_ES — Испанский PRODUCT_GROUP_LANG_TH — Тайский PRODUCT_GROUP_LANG_TR — Турецкий PRODUCT_GROUP_LANG_UK — Украинский PRODUCT_GROUP_LANG_VI — Вьетнамский PRODUCT_GROUP_LANG_RU — Русский
↳ value	string	Название товарной группы на указанном языке.
↳ rank	int	Ранг товарной группы. Чем больше ранг, тем выше эта группа будет в списке товарных групп.
↳ sort_type	string	Атрибут, по которому должны быть отсортированы товары в группе. Возможные значения: PRODUCT_GROUP_SORT_TYPE_DEFAULT — Значение по умолчанию — без сортировки PRODUCT_GROUP_SORT_TYPE_ORDERS — Отсортировать по числу заказов PRODUCT_GROUP_SORT_TYPE_NEWEST — Отсортировать по времени добавления PRODUCT_GROUP_SORT_TYPE_PRICE — Отсортировать по цене
↳ sort_dir	string	Порядок сортировки товаров в группе. Возможные значения: PRODUCT_GROUP_SORT_DIR_DEFAULT — Значение по умолчанию — без сортировки PRODUCT_GROUP_SORT_DIR_DESC — Отсортировать по убыванию PRODUCT_GROUP_SORT_DIR_ASC — Отсортировать по возрастанию
↳ product_count	int	Количество товаров в группе.
↳ is_active	boolean	Видимость товарной группы. По умолчанию true.

Пример успешного ответа

{
  "product_groups": [
    {
      "group_id": "9000000000000000015",
      "child_groups": [
        "9000000000000009429"
      ],
      "localized_names": [
        {
          "lang": "PRODUCT_GROUP_LANG_DEFAULT",
          "value": "string"
        }
      ],
      "rank": 0,
      "sort_type": "PRODUCT_GROUP_SORT_TYPE_DEFAULT",
      "sort_dir": "PRODUCT_GROUP_SORT_DIR_DEFAULT",
      "product_count": 0,
      "is_active": true
    }
  ]
}

Параметры ответа с ошибкой

Параметр	Тип	Описание
data	object	Данные ответа.
error	object	Информация об ошибке.
↳ code	string	Код ошибки.
↳ message	string	Сообщение об ошибке.
↳ details	object	Подробности об ошибке.

Пример ответа с ошибкой

{
  "data": {},
  "error": {
    "code": "400",
    "message": "Bad Request: The request is malformed or missing required parameters.",
    "details": {}
  }
}

Редактировать товарную группу

POST /api/v2/posting/edit-product-group

Обновляет настройки товарной группы.

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

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

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

Параметр	Тип	Обязательный	Описание
group_id	string	Да	Идентификатор редактируемой товарной группы.
settings	object	Да	Новые настройки товарной группы.
↳ rank	int	Нет	Ранг товарной группы. Чем больше ранг, тем выше эта группа будет в списке товарных групп.
↳ sort_type	string	Нет	Атрибут, по которому должны быть отсортированы товары в группе. Возможные значения: PRODUCT_GROUP_SORT_TYPE_DEFAULT — Значение по умолчанию — без сортировки PRODUCT_GROUP_SORT_TYPE_ORDERS — Отсортировать по числу заказов PRODUCT_GROUP_SORT_TYPE_NEWEST — Отсортировать по времени добавления PRODUCT_GROUP_SORT_TYPE_PRICE — Отсортировать по цене
↳ sort_dir	string	Нет	Порядок сортировки товаров в группе. Возможные значения: PRODUCT_GROUP_SORT_DIR_DEFAULT — Значение по умолчанию — без сортировки PRODUCT_GROUP_SORT_DIR_DESC — Отсортировать по убыванию PRODUCT_GROUP_SORT_DIR_ASC — Отсортировать по возрастанию
↳ is_active	boolean	Нет	Видимость товарной группы. По умолчанию true.
names	array of objects	Да	Названия товарной группы на разных языках. Обязательно передайте название на дефолтном языке: "lang": "PRODUCT_GROUP_LANG_DEFAULT" и его value. Названия на других языках — опционально.
↳ lang	string	Да, для дефолтного языка (PRODUCT_GROUP_LANG_DEFAULT). Для остальных языков — опционально.	Язык названия товарной группы. Возможные значения: PRODUCT_GROUP_LANG_DEFAULT — Дефолтный язык вашего магазина PRODUCT_GROUP_LANG_AR — Арабский PRODUCT_GROUP_LANG_NL — Нидерландский (Голландский) PRODUCT_GROUP_LANG_EN — Английский PRODUCT_GROUP_LANG_FR — Французский PRODUCT_GROUP_LANG_DE — Немецкий PRODUCT_GROUP_LANG_HE — Иврит PRODUCT_GROUP_LANG_ID — Индонезийский PRODUCT_GROUP_LANG_IT — Итальянский PRODUCT_GROUP_LANG_JA — Японский PRODUCT_GROUP_LANG_KO — Корейский PRODUCT_GROUP_LANG_PL — Польский PRODUCT_GROUP_LANG_PT — Португальский PRODUCT_GROUP_LANG_ES — Испанский PRODUCT_GROUP_LANG_TH — Тайский PRODUCT_GROUP_LANG_TR — Турецкий PRODUCT_GROUP_LANG_UK — Украинский PRODUCT_GROUP_LANG_VI — Вьетнамский PRODUCT_GROUP_LANG_RU — Русский
↳ value	string	Да, если передаёте lang.	Название товарной группы на указанном языке.

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

curl --location --request POST 'https://openapi.ru.laliexpress.com/api/v2/posting/edit-product-group' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <YOUR_API_TOKEN>' \
--data-raw '{
  "group_id": "9000000000000009429",
  "settings": {
    "rank": 0,
    "sort_type": "PRODUCT_GROUP_SORT_TYPE_DEFAULT",
    "sort_dir": "PRODUCT_GROUP_SORT_DIR_DEFAULT",
    "is_active": true
  },
  "names": [
    {
      "lang": "PRODUCT_GROUP_LANG_DEFAULT",
      "value": "Product group name in specified language."
    }
  ]
}'

Параметры успешного ответа

Параметр	Тип	Описание
{}	object	Пустой объект означает, что настройки товарной группы успешно обновлены.

Пример успешного ответа

{}

Параметры ответа с ошибкой

Параметр	Тип	Описание
data	object	Данные ответа.
error	object	Информация об ошибке.
↳ code	string	Код ошибки.
↳ message	string	Сообщение об ошибке.
↳ details	object	Подробности об ошибке.

Пример ответа с ошибкой

{
  "data": {},
  "error": {
    "code": "400",
    "message": "Bad Request: The request is malformed or missing required parameters.",
    "details": {}
  }
}

Переместить товары в товарную группу

POST /api/v1/product/change-products-groups

Добавляет товары в указанные товарные группы и удаляет из остальных.

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

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

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

Параметр	Тип	Обязательный	Описание
productIds	array of string(int)	Да	Идентификаторы товаров, которые надо переместить.
groupIds	array of strings	Да	Идентификаторы товарных групп, в которые надо переместить товары.

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

curl --location --request POST 'https://openapi.ru.laliexpress.com/api/v1/product/change-products-groups' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <your_api_token>' \
--data-raw '{
  "productIds": [
    "1005004449114979",
    "1005004449114980"
  ],
  "groupIds": [
    "9000000000000009429"
  ]
}'

Параметры успешного ответа

Параметр	Тип	Описание
group_id	string	Идентификатор запроса. Группа заданий на перемещение товаров.
results	array of objects	Результат перемещения товаров в группу.
↳ ok	boolean	Был ли запрос успешным.
↳ task_id	string	Идентификатор задания.
↳ errors	object	Ошибки запроса.

Пример успешного ответа

{
  "group_id": "675816724",
  "results": [
    {
      "ok": true,
      "task_id": "11064475332",
      "errors": {},
      "external_id": ""
    }
  ]
}

Параметры ответа с ошибкой

Параметр	Тип	Описание
data	object	Данные ответа.
error	object	Информация об ошибке.
↳ code	string	Код ошибки.
↳ message	string	Сообщение об ошибке.
↳ details	object	Подробности об ошибке.

Пример ответа с ошибкой

{
  "data": {},
  "error": {
    "code": "400",
    "message": "Bad Request: The request is malformed or missing required parameters.",
    "details": {}
  }
}

Настроить видимость товарной группы

POST /api/v2/posting/set-product-groups-settings

Определяет видимость товарной группы и её место в списке товарных групп.

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

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

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

Параметр	Тип	Обязательный	Описание
product_group_settings	array of objects	Да	Настройки видимости товарных групп.
↳ group_id	string	Да	Идентификатор товарной группы.
↳ rank	int	Нет	Ранг товарной группы. Чем больше ранг, тем выше эта группа будет в списке товарных групп.
↳ is_active	boolean	Нет	Видимость товарной группы. По умолчанию true.

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

curl --location --request POST 'https://openapi.ru.laliexpress.com/api/v2/posting/set-product-groups-settings' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <your_api_token>' \
--data-raw '{
  "product_group_settings": [
    {
      "group_id": "9000000000000009429",
      "rank": 3,
      "is_active": true
    }
  ]
}'

Параметры успешного ответа

Параметр	Тип	Описание
{}	object	Пустой объект означает, что настройки видимости товарных групп успешно обновлены.

Пример успешного ответа

{}

Параметры ответа с ошибкой

Параметр	Тип	Описание
data	object	Данные ответа.
error	object	Информация об ошибке.
↳ code	string	Код ошибки.
↳ message	string	Сообщение об ошибке.
↳ details	object	Подробности об ошибке.

Пример ответа с ошибкой

{
  "data": {},
  "error": {
    "code": "400",
    "message": "Bad Request: The request is malformed or missing required parameters.",
    "details": {}
  }
}

Удалить товарную группу

POST /api/v2/posting/delete-product-group

Удаляет товарную группу.

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

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

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

Параметр	Тип	Обязательный	Описание
group_id	string	Да	Идентификатор товарной группы.

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

curl --location --request POST 'https://openapi.ru.laliexpress.com/api/v2/posting/delete-product-group' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <YOUR_API_TOKEN>' \
--data-raw '{
    "group_id": "103802"
}'

Параметры успешного ответа

Параметр	Тип	Описание
{}	object	Пустой объект означает, что товарная группа успешно удалена.

Пример успешного ответа

{}

Параметры ответа с ошибкой

Параметр	Тип	Описание
data	object	Данные ответа.
error	object	Информация об ошибке.
↳ code	string	Код ошибки.
↳ message	string	Сообщение об ошибке.
↳ details	object	Подробности об ошибке.

Пример ответа с ошибкой

{
  "data": {},
  "error": {
    "code": "400",
    "message": "Bad Request: The request is malformed or missing required parameters.",
    "details": {}
  }
}