API полисов

С помощью API полисов вы можете получать гарантийные полисы — записи о покрытии, которые создаются, когда покупатель приобретает гарантию.

Получение полисов покупателя

GET /api/public/policies/fetch

Возвращает все гарантийные полисы покупателя. Добавьте ?policy_id={id}, чтобы получить один полис вместе с данными заказа.

Обязательные заголовки: X-Shopify-Shop-Domain, X-Shopify-Customer-Id

Каждый полис содержит: номер полиса, статус, данные покупателя, данные заказа, сведения о гарантийном плане, сведения о защищённом товаре и даты покрытия.

Получение полиса по ID

GET /api/public/policies/fetch/{policyId}

Возвращает конкретный полис по ID.

Параметры запроса:

• shopDomain (обязательный) — домен вашего магазина Shopify
• customerId (необязательный) — если указан, добавляет данные заказа и проверяет, что полис принадлежит покупателю

Поиск полиса по позиции заказа

POST /api/public/policies/fetch/order-line-item-policy

Находит гарантийный полис для конкретной позиции заказа. Используется на страницах статуса заказа, чтобы показать гарантийное покрытие для каждого товара.

Обязательный заголовок: X-Shopify-Shop-Domain

Параметры тела запроса:

• orderId или orderName (обязателен один из них) — определяет заказ
• lineItemId, variantId или position (обязателен хотя бы один) — определяет позицию
• protectionAttributes (необязательный) — ссылка на защиту из cart transform

Проверка полиса

POST /api/public/policies/validate

Проверяет, что полис существует, сопоставляя ID полиса и название заказа. Используется как мера безопасности во встроенных формах заявок.

Обязательные поля тела запроса: orderName, policyId

Возвращает { "valid": true } или { "valid": false }.

Статусы полисов

Статус	Описание
active	В пределах периода покрытия, принимает заявки
expired	Период покрытия закончился
cancelled	Отменён (возврат средств или действие продавца)
pending	В обработке (ожидает подтверждения заказа)
voided	Аннулирован из-за отмены заказа или чарджбэка

Связанные материалы

• API заявок — подача заявок по полисам
• API гарантий — сведения о гарантийных планах
• API товаров — проверка права товаров на гарантию