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 МБ

Порядок загрузки:

  1. Вызовите /claims/upload-urls, чтобы получить предварительно подписанный URL
  2. Отправьте файл методом PUT прямо по этому URL с правильным заголовком Content-Type

Статусы заявок

СтатусОписание
pendingПодана, ожидает рассмотрения продавцом
approvedОдобрена продавцом
deniedОтклонена продавцом
in_reviewНаходится на рассмотрении
resolvedПолностью урегулирована (замена, возврат денег и т. п.)

См. также

Запросить демо

Узнайте, как myUmbrella может преобразить вашу гарантийную программу

Выберите время

Выберите удобное время для персональной демонстрации

ESC

Начните вводить текст для поиска по всему контенту

Ничего не найдено

Попробуйте другой запрос