Ideal House Product Import API#
Используйте Product Import API для импорта, получения списка и логического удаления товаров в каталоге Ideal House. Пакетный импорт принимает от 1 до 500 товаров и выполняется асинхронно. Получение списка и удаление выполняются синхронно.
Базовый URL#
https://sdkapi.ideal.house
Используйте HTTPS для всех запросов. Тела запросов и ответов JSON закодированы в UTF-8.
Перед началом#
Ideal House предоставит следующие значения при подключении:
- Shop ID
- Client ID
- Client Secret
Client ID и Client Secret являются серверными учетными данными. Никогда не раскрывайте Client Secret в браузерном коде, мобильных приложениях, публичных репозиториях, журналах или других клиентских средах.
Аутентификация#
Включайте эти заголовки в каждом запросе:
X-Client-Id: <YOUR_CLIENT_ID>
X-Client-Secret: <YOUR_CLIENT_SECRET>
Для запросов с телом JSON также включайте:
Content-Type: application/json
shopId в запросе должен соответствовать магазину, связанному с учетными данными. Несоответствие возвращает 403 Forbidden.
Сводка по API#
| Метод | Путь | Назначение |
|---|---|---|
POST | /product-import/products | Отправить асинхронную партию импорта товаров. |
GET | /product-import/products/status | Получить текущее или последнее задание импорта. |
GET | /product-import/products | Перечислить текущие товары магазина. |
DELETE | /product-import/products | Логически удалить один товар по идентификатору товара или SKU. |
Порядок пакетного импорта#
- Отправьте партию товаров с помощью
POST /product-import/products. - Сохраните
jobId, возвращаемый в ответе202 Accepted. - Запрашивайте
GET /product-import/products/statusкаждые 2–5 секунд. - Остановите опрос, когда статус станет
completedилиfailed. - Если задание
completed, проверьтеfailedCountиfailuresна предмет ошибок на уровне элементов.
Для магазина может быть активно только одно задание импорта за раз.