Перейти до вмісту

Перелічувані значення

Значення передаються рядками точно в такому написанні (нижній регістр, дефіси й підкреслення як показано). Нових значень у поточній версії не зʼявиться без запису в журналі змін.

Значення Де зустрічається
draft Документ замовлення, щойно створений через POST /v1/shop/orders/create.
pending_payment Покупець перейшов до оплати у віджеті.
paid Після успішної оплати.
cancelled Після скасування з панелі.

Переходи й доступність запитів — у Статусах.

Причина невдалої оплати

Section titled “Причина невдалої оплати”

payment_failed, payment_expired, card_not_saved, cancelled — що означає кожна й що бачить покупець, у Статусах.

Значення Де зустрічається
one_time Позиція items[] у Shop API і документі замовлення; select() у віджеті. Купується один раз.
subscription Те саме; створює підписку після оплати. У замовленні має бути хоча б одна така позиція.
Значення Де зустрічається
day interval_unit позиції; config().intervals.units у віджеті; підписка.
week Те саме.

Інтервал: interval_value від 1 до 365 для обох одиниць. Пресети, які пропонує віджет: 1, 2, 3, 4 тижні. Усі магазини мають однакові інтервали.

Значення Де зустрічається
active Панелі, листи. Створюється після першої оплати.
paused Панелі; лист «Підписку призупинено».
cancelled Панелі.

Дозволені переходи: active → paused, active → cancelled, paused → active, paused → cancelled, cancelled → active.

Значення Де зустрічається
charge_failed Автоматична пауза після пʼятої невдалої спроби списання.
no_card Автоматична пауза, коли немає придатної картки.
довільний текст Пауза, яку поставив продавець у панелі.
null Пауза, яку поставив сам покупець; у вебхуку reason_key: "customer".
Значення uk en
too_expensive Задорого Too expensive
too_much_product Забагато товару Too much product
not_satisfied Не сподобався товар Did not like the product
delivery_issues Проблеми з доставкою Delivery issues
product_discontinued Товар знято з продажу Product discontinued
changed_product Змінив(ла) товар Switched to another product
moved Переїзд Moving
other Інше Other

Обирається в панелі при скасуванні підписки (з необовʼязковим коментарем). Масове скасування всіх підписок на товар зі сторінки товару використовує product_discontinued. Покупець, що скасовує сам, обирає будь-яку причину, крім product_discontinued, або жодної — тоді cancellation_reason дорівнює null.

Значення Де зустрічається
pending payment.status у документі замовлення одразу після checkout.
success Оплату отримано.
failed Провайдер відхилив.
expired Сторінка оплати або списання прострочені.
refunded Повне повернення з панелі або автоматичне при card_not_saved.

Храповик: pending < failed / expired < success < refunded; детальніше — у Статусах.

Значення Де зустрічається
plata-by-mono Налаштування «Оплата» в панелі.
liqpay Те саме.
sandbox Лише на середовищах, де увімкнено пісочницю; підміняє провайдера кожного магазину.
Значення Де зустрічається
nova-poshta Налаштування «Доставка» в панелі; delivery.provider замовлення. Увімкнено.
ukr-poshta Зарезервовано. Сьогодні вимкнено.
Значення Де зустрічається
branch Відділення. Перемикач «Відділення» в панелі.
parcel-locker Поштомат. Перемикач «Поштомат».
address Курʼєрська адреса. Перемикач «Адреса».

Форми delivery.data для кожного способу — у Документі замовлення.

Значення Назва в панелі Основний колір
default Neocarts (типова) #6C5CE7
blue Синя #2563EB
green Зелена #157F3D
purple Пурпурова #6D28D9
orange Помаранчева #C2410C
burgundy Бордова #9F1239
teal Бірюзова #0F766E
neutral Нейтральна темна #1F2937

Застосовується до кнопки підписки, модальних вікон і оформлення.

Значення Де зустрічається
uk locale замовлення; Accept-Language; мова користувача панелі (типова).
en Те саме; типове значення сервера, якщо Accept-Language не передано.

Сповіщення користувача магазину

Section titled “Сповіщення користувача магазину”
Значення Перемикач у панелі Лист
subscription_created «Нова підписка» «Нова підписка у :shop»
order_created «Замовлення по підписці» «Нове замовлення :number» (лише для замовлень-продовжень)

Обидва увімкнені за замовчуванням. Див. Листи.

Країна магазину (shop.country)

Section titled “Країна магазину (shop.country)”

Лише UA сьогодні; визначає регіон віджета (формат телефону +380, гривня).

order.created, order.paid, order.cancelled, subscription.created, subscription.renewed, subscription.paused, subscription.resumed, subscription.cancelled, subscription.updated, subscription.price_changed, payment.failed, payment.refunded. Коли саме спрацьовує кожна і що несе — у таблиці подій. Невідомі значення можуть зʼявитися з часом: ігноруйте їх і відповідайте 2xx.

Значення У панелі Коли
pending «В черзі» Створено або чекає повтору після невдалої спроби
success «Доставлено» Сервер магазину відповів 2xx
failed «Не доставлено» Пʼять спроб вичерпано, або URL прибрали до відправлення; доступне «Надіслати повторно»