API заявок
Подача заявок по гарантии и управление ими программно
API заявок
С помощью API заявок можно подавать заявки по гарантии, загружать файлы с доказательствами и запрашивать статус заявок.
Подача заявки
POST /api/public/claims/submit
Подаёт заявку по существующему полису. Заявка создаётся со статусом pending, а покупателю и продавцу отправляются уведомления по электронной почте.
Заголовки (рекомендуются): X-Shopify-Shop-Domain, X-Shopify-Customer-Id
Обязательные поля тела запроса:
policyId— полис, по которому подаётся заявкаclaimType— см. типы заявок нижеdescription— что произошлоdateOfIncident— дата происшествия в формате ISO
Необязательные: additionalInfo
Типы заявок
| Значение | Описание |
|---|---|
manufacturer_defect | Товар вышел из строя из-за производственного дефекта |
accidental_damage | Товар случайно повреждён |
wear_and_tear | Товар износился при обычном использовании |
spill_or_stain | Товар повреждён жидкостью или испачкан |
lost_or_stolen | Товар утерян или украден |
other | Другая причина |
При успехе возвращает claimId. Если по полису достигнут лимит заявок, возвращает ошибку CLAIM_LIMIT_REACHED с подробностями.
Подача ручной заявки
POST /api/public/claims/submit-manual
Подаёт заявку без существующего полиса. Используется для заявок, инициированных продавцом (например, из POS).
Обязательный заголовок: X-Shopify-Shop-Domain
Обязательные поля тела запроса: customerEmail, customerName, productName, claimType, description, dateOfIncident
Необязательные: customerPhone, orderNumber, additionalInfo
Получение заявок по полису
GET /api/public/claims/fetch?policy_id={policyId}
Обязательные заголовки: X-Shopify-Shop-Domain, X-Shopify-Customer-Id
Возвращает все заявки по указанному полису и покупателю, включая номер заявки, статус, тип, причину и даты.
Получение доказательств по заявке
GET /api/public/claims/{id}/evidence
Обязательные заголовки: X-Shopify-Shop-Domain, X-Shopify-Customer-Id
Возвращает файлы с доказательствами (фото, видео), прикреплённые к заявке.
Загрузка файлов с доказательствами
POST /api/public/claims/upload-urls
Создаёт предварительно подписанный URL для загрузки доказательств напрямую в облачное хранилище.
Обязательные поля тела запроса: fileName, fileType (тип MIME), fileSize (в байтах), claimId, fileCategory (photo или video)
Ограничения на файлы:
- Фото (JPEG, PNG, GIF, WebP): не более 10 МБ
- Видео (MP4, QuickTime, WebM): не более 100 МБ
Порядок загрузки:
- Вызовите
/claims/upload-urls, чтобы получить предварительно подписанный URL - Отправьте файл методом PUT прямо по этому URL с правильным заголовком Content-Type
Статусы заявок
| Статус | Описание |
|---|---|
pending | Подана, ожидает рассмотрения продавцом |
approved | Одобрена продавцом |
denied | Отклонена продавцом |
in_review | Находится на рассмотрении |
resolved | Полностью урегулирована (замена, возврат денег и т. п.) |
См. также
- API полисов — находите полисы перед подачей заявок
- API гарантий — сведения о гарантийных планах
- Справочник по Webhook — получайте уведомления об изменении статуса заявки


