Обзор эндпоинтов

Полный справочник по всем доступным эндпоинтам 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/callbackOAuth-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 полисов — подробный справочник по эндпоинтам полисов

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

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

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

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

ESC

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

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

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