API гарантий

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

Получение гарантии по ID

GET /api/public/warranty/{warrantyId}

Возвращает сведения о гарантийном плане и соответствующий ему товар Shopify (используется для добавления гарантии в корзину).

Параметр пути: warrantyId (обязательный) — ID гарантийного плана.

Возвращает объект гарантии с типом плана, статусом, условиями (срок и цена), сведениями о покрытии, а также соответствующий товар Shopify с ID вариантов и ценами.

Проверка права на гарантию (по товару)

GET / POST /api/public/warranty-eligibility

Проверяет, подходит ли товар для гарантийного покрытия, и возвращает доступные планы. Это основной эндпоинт, которым пользуется виджет витрины.

Обязательные заголовки:

• X-Shopify-Shop-Domain — домен вашего магазина
• X-Shopify-Product-Id — ID проверяемого товара (или передайте его в теле/параметрах запроса)

Тело POST-запроса или параметры GET-запроса:

• shopifyShopDomain (обязательный) — домен вашего магазина
• eligibleProductId (обязательный) — ID товара в Shopify
• cached (необязательный) — укажите false, чтобы обойти кеш

Возвращает подходящую расширенную гарантию (с данными товара Shopify), подходящую гарантию OEM, лимиты плана, сведения о продавце, локаль, переводы и данные о валюте.

Проверка права на гарантию (позиция заказа)

POST /api/public/warranty/eligibility

Проверяет право на гарантию для конкретной позиции заказа. Используется после покупки и на странице статуса заказа.

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

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

• orderId или orderName (обязателен один из них) — определяет заказ
• lineItemId, variantId или position (обязателен хотя бы один) — определяет позицию заказа

Эндпоинт ищет позицию сначала по lineItemId, затем по variantId, затем по position. Формат ответа совпадает с эндпоинтом проверки по товару.

Типы планов

Тип плана	Значение	Описание
Расширенная гарантия	extended_warranty	Платная гарантия, приобретаемая при оформлении заказа
Гарантия OEM	oem_warranty	Гарантия производителя, предоставляемая бесплатно

См. также

• Аутентификация — учётные данные API и ограничения частоты запросов
• Обзор эндпоинтов — полный список эндпоинтов
• API товаров — поиск товаров и проверка права на гарантию
• API полисов — управление полисами после покупки