Skip to content

Enums

Values are sent as strings spelled exactly as shown (lowercase, hyphens and underscores as listed). No new value appears in the current version without an entry in the changelog.

Value Where it is used
draft The order document right after POST /v1/shop/orders/create.
pending_payment The shopper went on to payment in the widget.
paid After a successful payment.
cancelled After cancellation from a panel.

Transitions and request gating are in Statuses.

payment_failed, payment_expired, card_not_saved, cancelled — what each means and what the shopper sees is in Statuses.

Value Where it is used
one_time items[] line in the Shop API and the order document; select() in the widget. Bought once.
subscription Same; creates a subscription after payment. An order needs at least one such line.
Value Where it is used
day Line interval_unit; config().intervals.units in the widget; subscription.
week Same.

Interval: interval_value from 1 to 365 for either unit. Presets offered by the widget: 1, 2, 3, 4 weeks. Every shop has the same intervals.

Value Where it is used
active Panels, emails. Created after the first payment.
paused Panels; the “Subscription paused” email.
cancelled Panels.

Allowed transitions: active → paused, active → cancelled, paused → active, paused → cancelled, cancelled → active.

Value Where it is used
charge_failed Automatic pause after the fifth failed charge attempt.
no_card Automatic pause when no usable card exists.
free text A pause the merchant set in a panel.
null A pause the shopper set themselves; the webhook carries reason_key: "customer".
Value 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

Chosen in a panel when cancelling a subscription (with an optional comment). Mass-cancelling every subscription of a product from the product page uses product_discontinued. A shopper cancelling themselves picks any reason except product_discontinued, or none — then cancellation_reason is null.

Value Where it is used
pending payment.status in the order document right after checkout.
success Payment received.
failed Declined by the provider.
expired Payment page or charge expired.
refunded Full refund from a panel, or the automatic one on card_not_saved.

Ratchet: pending < failed / expired < success < refunded; details in Statuses.

Value Where it is used
plata-by-mono The Payment settings tab in the panel.
liqpay Same.
sandbox Only on environments with the sandbox enabled; replaces every shop’s provider.
Value Where it is used
nova-poshta The “Delivery” settings in the panel; order delivery.provider. Enabled.
ukr-poshta Reserved. Disabled today.
Value Where it is used
branch Pick-up branch. The “Branch” toggle in the panel.
parcel-locker Parcel locker. The “Parcel locker” toggle.
address Courier address. The “Address” toggle.

delivery.data shapes per type are in the Order document.

Value Panel label Primary colour
default Neocarts (default) #6C5CE7
blue Blue #2563EB
green Green #157F3D
purple Purple #6D28D9
orange Orange #C2410C
burgundy Burgundy #9F1239
teal Teal #0F766E
neutral Neutral dark #1F2937

Applied to the subscribe button, the modals and the checkout.

Value Where it is used
uk Order locale; Accept-Language; panel user language (default).
en Same; the server default when Accept-Language is absent.
Value Panel toggle Email
subscription_created “New subscription” “New subscription at :shop”
order_created “Subscription order” “New order :number” (renewal orders only)

Both are on by default. See Emails.

Only UA today; it sets the widget region (+380 phone format, hryvnia).

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. When each fires and what it carries is in the events table. Unknown values may appear over time: ignore them and still answer 2xx.

Value In the panel When
pending «Queued» Created, or waiting for a retry after a failed attempt
success «Delivered» The shop’s server answered 2xx
failed «Not delivered» Five attempts used up, or the URL was removed before sending; «Resend» is available