Быстрый старт с Accplanet Supplier API: товары, заказы и обновления доставки
Accplanet Supplier API quick start
Authenticate with X-API-Key, manage products, list orders, and update delivery through the Supplier REST API.
-
Create an API key
Generate a supplier API key in Profile → API key and send it as the X-API-Key header.
-
Create or update products
Use /products/api/supplier/create/ and /products/api/supplier/products/{id}/update/ with JSON bodies from the live docs.
-
Fulfill orders
List /orders/api/supplier/orders/ and POST delivered updates for each order id. Cache GETs and back off on 429.
Если вы продаёте на Accplanet и хотите автоматизации, Accplanet Supplier API — это REST-интерфейс для товаров, заказов и обновлений доставки. Это краткое руководство проведёт продавца от настройки API-ключа до создания / обновления / удаления товаров, получения списка заказов и отметки доставки — не заменяя полную документацию Supplier API.
Accplanet — это маркетплейс; ваш аккаунт поставщика владеет листингами и исполнением заказов. Скрипты аутентифицируются с помощью API-ключа в заголовке X-API-Key.
Кратко
- Сгенерируйте API-ключ в своём профиле Accplanet; отправляйте его как
X-API-Keyпри каждом вызове Supplier. - Цикл товара: создать → получить список/обновить поля остатков → удалить при выводе SKU из оборота.
- Цикл заказа: получить список заказов поставщика → обновить информацию о доставке → изменить статус, когда этого требует ваш процесс.
- Предпочитайте пути без префикса, например
/products/api/supplier/…, для POST (это предотвращает превращение POST в GET из-за языкового редиректа). - Кэшируйте чтения; соблюдайте HTTP 429 и
Retry-After.
Получите свой API-ключ
Войдите в аккаунт с правами поставщика, откройте Профиль → API-ключ и сгенерируйте API-ключ. Для интеграции продавца с Accplanet каждый запрос должен выглядеть так:
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Храните ключ в защищённом хранилище секретов. Смените его, если он когда-либо попал в лог ноутбука или CI.
Принципы дизайна API для синхронизации продавца
Эндпоинты поставщика следуют общим принципам дизайна API, которые делают синхронизацию с ERP или складом предсказуемой:
- URL-адреса ресурсов: товары и заказы — это отдельные REST-ресурсы, а не один мега-эндпоинт действий.
- Аутентификация через заголовок:
X-API-Keyне позволяет учётным данным попадать в строки запроса в логах доступа. - JSON на входе / JSON на выходе: тела запросов на создание и обновление структурированы; загрузки используют
multipart/form-data. - Идемпотентные привычки: обновляйте по id товара; осторожно используйте флаги слияния доставки, чтобы не стереть предыдущие строки доставки.
Товары: создание, обновление, удаление
1 · Создание
API создания товара
Отправьте POST в API создания товара поставщика. Имена полей и обязательные id категорий описаны в актуальной документации — начните с тестера в документации после того, как сможете аутентифицироваться.
curl -X POST https://accplanet.com/products/api/supplier/create/ \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d "{\"title\":\"Example listing\",\"price\":\"9.99\",\"category_id\":\"CATEGORY_ID\"}"
Замените JSON на полный payload из документации Supplier API. Рассматривайте пример выше как напоминание о форме, а не как полную схему.
2 · Список / обновление
Получение списка товаров и обновление по id
curl -X GET https://accplanet.com/products/api/supplier/products/ \
-H "X-API-Key: YOUR_API_KEY"
curl -X POST https://accplanet.com/products/api/supplier/products/PRODUCT_ID/update/ \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d "{\"price\":\"8.50\"}"
Используйте update для цены, полей, связанных с остатками, и изменений описания, которые уже поддерживает ваш магазин. Предпочитайте обновление существующего id товара созданию дубликатов.
3 · Удаление
Вывод листинга из оборота
curl -X POST https://accplanet.com/products/api/supplier/products/PRODUCT_ID/delete/ \
-H "X-API-Key: YOUR_API_KEY"
Убедитесь в админке или через последующий вызов списка, что товар удалён или неактивен, как определяют правила вашего аккаунта.
Заказы и обновления доставки
Список заказов
GET /orders/api/supplier/orders/ для API заказов поставщика. Фильтруйте по статусу в вашей задаче синхронизации; не опрашивайте чаще одного раза в минуту на ключ.
Обновление доставки
POST /orders/api/supplier/orders/{order_id}/delivered/ для передачи строк доставки. При слиянии следуйте документации по append_delivered_info, чтобы случайно не заменить предыдущие строки.
Статус / возвраты
Выделенные эндпоинты статуса и возвратов существуют в том же дереве заказов поставщика. Подключайте их только после того, как обновления доставки станут стабильными.
curl -X GET "https://accplanet.com/orders/api/supplier/orders/" \
-H "X-API-Key: YOUR_API_KEY"
curl -X POST https://accplanet.com/orders/api/supplier/orders/ORDER_ID/delivered/ \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d "{\"delivered_info\":\"[\\\"line1\\\",\\\"line2\\\"]\",\"append_delivered_info\":true}"
Проверяйте точный payload доставки по актуальной документации — форматы доставки различаются в зависимости от типа товара.
Загрузка изображений товаров
Используйте API загрузки изображения товара с multipart form data:
curl -X POST https://accplanet.com/products/api/supplier/upload-image/ \
-H "X-API-Key: YOUR_API_KEY" \
-F "image=@./cover.webp"
Используйте возвращённый URL в payload создания/обновления, когда ваша схема ожидает путь к изображению.
Лимиты запросов
Чтения, записи и загрузки Supplier REST имеют отдельные поминутные бюджеты (чтения часто самые жёсткие для наивных поллеров). Для интеграции продавца с Accplanet:
- Кэшируйте списки товаров и заказов, получаемые через GET.
- Объединяйте обновления UI в пакеты вместо вызовов списка на каждый клик.
- При 429 соблюдайте
Retry-Afterперед повторной попыткой загрузок или записей.