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

Глосарій

Замовлення (order) — знімок кошика з контактами, доставкою й сумами; у статусі draft це і є кошик, після оплати не змінюється. Канонічний JSON — у Документі замовлення.

Кошик (cart) — те, що покупець збирає в магазині. У Neocarts окремої сутності немає: кошик — це замовлення в статусі draft, яке сервер магазину може замінити цілком через PUT /v1/shop/orders/{order}/items.

Чернетка (draft) — перший статус замовлення: позиції ще можна міняти, оформлення не починалося.

Позиція (item, line) — один товар у замовленні з ціною, кількістю та режимом one_time або subscription.

Підписка (subscription) — регулярна доставка одного товару із заданим інтервалом; створюється лише після успішної першої оплати, зберігає власну ціну, кількість і відсоток знижки.

Платіж (payment) — одна спроба оплати; повторне оформлення створює новий платіж. Статуси — у Статусах.

Токен картки — збережені провайдером реквізити для списань без участі покупця; без нього підписку створити не можна (card_not_saved).

Списання (charge) — регулярний платіж за підпискою; кожне створює нове замовлення на період.

Переоцінка — зміна ціни товару в активних і призупинених підписках через PUT …/price; діє з наступного списання.

Магазин (shop) — продавець у Neocarts; має назву, країну, ключ API та UUID.

UUID магазину (shop id) — публічний ідентифікатор магазину для data-shop-id віджета. Не таємний. Показується в панелі магазину на вкладці «Інтеграція» поруч із API-ключем.

Ключ API (shop key) — таємний nc_live_… для Shop API; показується один раз при генерації, один діючий ключ на магазин, перегенерація одразу вимикає старий.

Вебхук — підписаний POST від Neocarts на сервер магазину про подію: order.paid, subscription.renewed, payment.refunded та інші. Підпис — HMAC-SHA256 секретом whsec_… із вкладки «Інтеграція». Див. Вебхуки.

id замовлення — UUID, технічний ідентифікатор, який сервер магазину передає віджету в open({ orderId }).

number замовлення — людський номер YYMMDD-NNNNN; безпечно показувати покупцю й у листах.

Сервер магазину — бекенд або плагін платформи, що викликає Shop API з ключем і єдиний називає ціни.

Shop API — серверний API https://core.neocarts.com/v1/shop/* з Authorization: Bearer nc_live_…; без CORS; версіонований.

Widget API — внутрішній API, який віджет викликає з браузера. Не публічний контракт: магазин його не викликає, і тут він не документується.

Віджет — скрипт https://cdn.neocarts.com/bundle.js: кнопка підписки, вікно підписки, вікно «Як працює підписка» і діалог оформлення в Shadow DOM; грошей не рахує.

Кнопка підписки — елемент <neocarts-button product-id="…" amount="…" title="…" image="…"> під кнопкою купівлі: показує ціну за підпискою й відкриває вікно, де покупець обирає частоту; amount у копійках. Див. Кнопка підписки.

Оформлення (checkout) — кроки у віджеті: контакти → доставка → огляд → оплата → результат.

Згода (consent) — прапорець у кроці перегляду, обовʼязковий при позиціях subscription.

Панель магазину (shop panel) — кабінет продавця: замовлення, підписки, платежі, клієнти, товари, користувачі, налаштування.

Конфігурація магазину (shop config) — те, що повертає NeocartsSubscription.config(): назва, знижка, інтервали, палітра, готовність.

Готовність (config().ready) — оплату налаштовано й увімкнено хоча б один спосіб доставки; інакше кнопка підписки не показується, а open() відхиляється.

Копійки (kopecks) — одиниця всіх сум: цілі числа, 249000 = 2 490,00 ₴. Див. Гроші та округлення.

Знижка на підписку — відсоток 0–100 з налаштувань магазину; копіюється в замовлення і підписку при створенні; лише для позицій subscription.

Інтервал — періодичність доставки: interval_value 1–365 і interval_unit day або week.

Пресет — готовий інтервал, який віджет пропонує чипом: 1, 2, 3, 4 тижні; однаковий для всіх магазинів.

Пауза — стан підписки без списань; ставиться вручну (з необовʼязковою датою) або автоматично (charge_failed, no_card).

Палітра — одна з 8 колірних схем віджета, обирається в панелі; окремі кольори не налаштовуються. Перелік — у Перелічуваних значеннях.

Мова (locale) — uk або en; Accept-Language керує мовою відповідей API, locale замовлення — мовою листів покупцю.

Провайдер оплати — Plata by Mono або LiqPay (ключі магазину вводяться в панелі); після першої підписки змінюється лише через підтримку.

Пісочниця (sandbox) — тестовий провайдер на staging-середовищах: без реальних грошей і реквізитів, із кнопками для сценаріїв успіху, відмови й незбереженої картки. На production поки немає.

Довідник доставки — списки міст, відділень, поштоматів і вулиць перевізника, з яких покупець обирає адресу у віджеті; оновлюється щотижня.

Отримувач (recipient) — імʼя, прізвище й телефон у блоці доставки; може відрізнятися від контакту замовлення.

redirect_url — адреса, куди віджет веде кнопкою «Назад до магазину» після завершеного замовлення; провайдеру не передається.

Маркер ?neocarts=checkout — параметр URL, за яким віджет при завантаженні сторінки знову відкриває останнє незавершене оформлення покупця.