Продавцы могут управлять своими товарами по MPN через простой HTTP API: получать, добавлять, обновлять и удалять товары с помощью ключа API. API работает только с собственными товарами продавца.
Ключ API
- Продавец открывает Личный кабинет > Мой аккаунт продавца > Редактировать данные продавца, вкладку «Личные данные».
- «Сгенерировать» создаёт «Ключ API» (или заменяет старый).
Администратор видит и может изменить ключ на вкладке «Продавец» покупателя. Запросы с ключом отключённого продавца или отключённого аккаунта покупателя отклоняются. См. «Ключи API».
Запросы и ответы
Все запросы отправляются на index.php витрины вашего магазина. Ключ передаётся в строке запроса как apikey; данные POST-запросов передаются как поля формы (multipart/form-data, если вы отправляете изображения).
| Операция | Метод | Маршрут |
|---|---|---|
| Получить товар | GET | extension/ka_extensions/ka_multivendor/api/product&apikey=KEY&mpn=MPN |
| Добавить товар | POST | extension/ka_extensions/ka_multivendor/api/product/add&apikey=KEY |
| Обновить товар | POST | extension/ka_extensions/ka_multivendor/api/product/update&apikey=KEY |
| Удалить товар | POST | extension/ka_extensions/ka_multivendor/api/product/delete&apikey=KEY |
Полный URL - это https://www.example.com/index.php?route= + маршрут. Используйте HTTPS: ключ является частью URL.
Товары ищутся по полю MPN с точным совпадением среди собственных товаров продавца. Делайте MPN уникальными и всегда передавайте mpn.
Каждый ответ - JSON. success равно true или false; при ошибках message содержит причину. HTTP-статус равен 200 и при ошибках, поэтому проверяйте success.
| message | Причина |
|---|---|
| apikey is required | В URL нет apikey. |
| apikey is not correct | Ни у одного продавца нет такого ключа. |
| vendor account is disabled | Профиль продавца отключён («Статус продавца»). Отключённый аккаунт покупателя даёт «apikey is not correct». |
| Invalid request type | Для добавления, обновления или удаления использован GET или для получения - POST. |
| MPN is empty | Получение, добавление, обновление или удаление: mpn отсутствует или пуст. |
| Product was not found | Получение или удаление: ни у одного товара этого продавца нет такого MPN. |
| Product already exists with the specified MPN ... | Добавление: этот MPN уже используется данным продавцом. |
| Product does not exist with the specified MPN | Обновление: ни у одного товара этого продавца нет такого MPN. |
| Missed product_description field | Добавление или обновление без product_description. |
| Category is not allowed for vendors: ID | Добавление или обновление: category_id - категория, не открытая для продавцов («Разрешить для продавцов» у категории и её родительских категорий). Категория, которая уже есть у товара, принимается. |
| The product limit reached | Добавление: продавец достиг лимита товаров. |
Поля товара
| Поле | Значение |
|---|---|
mpn |
Ключ товара. Обязательно. |
product_description[CODE][name], [description], [tag] |
Название, описание (HTML) и теги для каждого языка. CODE - код языка, например en-gb. Обязательно при добавлении и обновлении; каждый раз передавайте все языки. |
price, special_price |
Цена и специальная цена для группы покупателей по умолчанию. Пустой или отсутствующий special_price удаляет специальную цену. |
quantity, subtract, minimum |
Остаток, вычитание со склада (1 - остаток учитывается, 0 - без ограничений), минимальное количество. |
status |
1 - включён, 0 - отключён. Неодобренные товары остаются отключёнными. |
category_id |
Категория товара, одна из категорий, открытых для продавцов. 0 удаляет категорию. |
manufacturer_id |
Производитель. |
shipping, weight, weight_class_id, length, width, height, length_class_id |
Данные доставки, как в форме товара продавца. |
product_attributes[LANGUAGE_ID][ATTRIBUTE_ID] |
Тексты атрибутов. Обратите внимание: здесь ключом является числовой ID языка, а не код. Отсутствие списка удаляет атрибуты товара. |
image |
Основное изображение в виде загружаемого файла. |
additional_images[] |
Дополнительные изображения в виде загружаемых файлов. Они заменяют старые дополнительные изображения; их порядок соответствует порядку загрузки. |
При обновлении непереданные поля товара сохраняют свои значения, кроме special_price и product_attributes (см. выше). Изображения и категория сохраняются, если они не переданы.
Получить товар
Ответ содержит product с записью товара и его описанием на языке магазина, включая vendor_approval (пусто = черновик, W = ожидает одобрения, A = одобрен).
Добавить товар
Товар, добавленный через API, сразу отправляется на одобрение: ответ содержит "approval": "W", и товар остаётся отключённым, пока администратор его не одобрит. Черновиком он не становится. Действует лимит товаров продавца.
Обновить товар
Обновление работает как «Сохранить» в форме товара продавца (см. «Сохранение и отправка на одобрение»):
- одобренный товар остаётся одобренным, если меняются только цена, специальная цена, количество, вычитание со склада, минимум, статус, вес, размеры или доставка;
- другие изменения возвращают его в статус «Ожидает одобрения» и отключают;
- ожидающий товар остаётся ожидающим, черновик - черновиком.
Ответ содержит approval со статусом после обновления.
Удалить товар
Товар удаляется полностью, вместе со списком изображений, отзывами и SEO URL. Это действие нельзя отменить.
Пример на PHP
Другие модули могут добавлять в API свои поля; на этой странице описаны поля самого Multivendor.
