Обзор эндпоинтов
Полный справочник по всем доступным эндпоинтам REST API
Обзор эндпоинтов
Все эндпоинты используют базовый URL: https://your-app-domain.com/api/public
Право на гарантию
| Метод | Путь | Описание |
|---|---|---|
| GET / POST | /warranty-eligibility | Проверить право на гарантию для товара |
| POST | /warranty/eligibility | Проверить право на гарантию для позиции заказа |
| GET / POST | /assess-eligibility | Пакетная переоценка права на гарантию для организации (администратор) |
| GET | /assess-eligibility/all | Пакетная оценка для всех организаций (администратор) |
Гарантии
| Метод | Путь | Описание |
|---|---|---|
| GET | /warranty/{warrantyId} | Получить сведения о гарантии по ID |
Полисы
| Метод | Путь | Описание |
|---|---|---|
| GET | /policies/fetch | Получить все полисы покупателя |
| GET | /policies/fetch/{policyId} | Получить конкретный полис по ID |
| POST | /policies/fetch/order-line-item-policy | Найти полис для позиции заказа |
| POST | /policies/validate | Проверить полис по ID и номеру заказа |
Заявки
| Метод | Путь | Описание |
|---|---|---|
| POST | /claims/submit | Подать гарантийную заявку по полису |
| POST | /claims/submit-manual | Подать заявку от имени продавца (полис не требуется) |
| GET | /claims/fetch | Получить заявки по полису и покупателю |
| GET | /claims/{id}/evidence | Получить файлы доказательств по заявке |
| POST | /claims/upload-urls | Сгенерировать предподписанные URL для загрузки доказательств |
| POST | /claims/upload | Загрузить доказательства по заявке напрямую |
| POST | /claims/evidence | Прикрепить метаданные доказательств к заявке |
Товары
| Метод | Путь | Описание |
|---|---|---|
| GET | /products/search | Искать товары по названию, SKU или штрихкоду |
| GET | /products/eligibility | Проверить право на гарантию для нескольких товаров |
| POST | /products/register | Зарегистрировать товар для гарантийного покрытия |
Покупатели
| Метод | Путь | Описание |
|---|---|---|
| GET | /customers/orders | Получить заказы покупателя |
Регистрация
| Метод | Путь | Описание |
|---|---|---|
| GET | /registration/lookup | Найти регистрацию по номеру |
Серийные номера
| Метод | Путь | Описание |
|---|---|---|
| POST | /serial-numbers/validate | Проверить серийный номер |
Аналитика
| Метод | Путь | Описание |
|---|---|---|
| POST | /analytics/events | Отправить события аналитики виджета |
Конфигурация
| Метод | Путь | Описание |
|---|---|---|
| GET / POST | /config | Получить конфигурацию виджета и переводы |
Статус заказа
| Метод | Путь | Описание |
|---|---|---|
| GET | /order-status | Получить статус заказа |
POS
| Метод | Путь | Описание |
|---|---|---|
| GET | /pos/customer-search | Искать покупателей в контексте POS |
Интеграция с Shopify
| Метод | Путь | Описание |
|---|---|---|
| GET | /shopify/auth/callback | OAuth-callback при установке приложения |
| POST | /shopify/webhooks | Получать события Webhook от Shopify |
| POST | /shopify/post-purchase/sign-changeset | Подписывать наборы изменений расширения post-purchase |
Синхронизация товаров
| Метод | Путь | Описание |
|---|---|---|
| POST | /sync-products | Синхронизировать товары организации |
| POST | /sync-products/all | Синхронизировать товары всех организаций |
Состояние
| Метод | Путь | Описание |
|---|---|---|
| GET | /health | Проверить состояние API |
Возвращает 200 (работает нормально), 206 (работает с ограничениями) или 503 (не работает).
См. также
- Аутентификация — настройка ключа API и ограничения частоты запросов
- API гарантий — подробный справочник по эндпоинтам гарантий
- API заявок — подробный справочник по эндпоинтам заявок
- API полисов — подробный справочник по эндпоинтам полисов


