Order status changed

post

https://yourplatform.com/ewity-webhook/order-status-changed

Sent BY Ewity TO your registered webhook URL. All events
POST to the same URL you registered with Ewity — the path on
this page is for grouping in the docs only. Identify the event
by the X-Event header.

Fires every time the order's status changes. This is the event
you'll care about most — it covers merchant acceptance (the moment
a bill is generated and POST /orders/{id}/payment becomes
callable), all forward transitions, cancellations, and the
merchant-driven "review requested" flow.

Triggering transitions:

pending → acknowledged (merchant has seen the order)
acknowledged → accepted (bill generated here)
accepted → ready-for-pickup
ready-for-pickup → on-delivery
on-delivery → completed
any state → cancelled
any state → review-requested (merchant proposed edits)

How to use it

Watch for status === "accepted" to know that a bill now exists
and POST /orders/{id}/payment is callable.
Watch for status === "review-requested" if you expose
merchant-edit confirmations to the customer — see
Change Order Status for the
customer-driven pending transition that completes that flow.
cancelled and completed are terminal — stop polling /
archive on your side.
Dedupe by (id, status); the same tuple may be delivered more
than once.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

int64

number

string

online_location

object

An online location ("storefront"). Use id as online_location_id /
locationId in subsequent calls.

customer

object

fulfilment_type

string

Display label ("Delivery", "Pickup", ...) — not the input enum value.

payment_method

string | null

Display label for the payment method selected at checkout. For
orders created via this API there is no checkout-time payment
method, so this field is always null on platform-created
orders. Record what you collected from the customer via
POST /orders/{id}/payment after the merchant accepts the order.

customer_notes

string | null

merchant_remarks

string | null

Set by the merchant when reviewing or editing the order.

status

string

enum

ui_status

string

paid

boolean

True only when cumulative payments on the bill cover the bill
total. Stays false for partial payments.

total

double

reminder_count

integer

lines

array of objects

lines

total_components

array of objects

total_components

online_payments

array of objects

Online payment options the customer can settle this order with,
as configured on the merchant's account. Empty for most platform
integrations (you'd typically collect payment yourself and call
POST /orders/{id}/payment); only relevant if you want to hand
the customer off to one of Ewity's online payment flows.

Each entry has a key you can pass to a settlement endpoint
(e.g. payment_key on POST /orders/{id}/payment/bank-transfer
for type: bank_transfer entries). Other type values are
handled through Ewity-managed flows that aren't exposed in this
doc set — contact [email protected] if you need them.

online_payments

payments

array of objects

Payments recorded against the order's bill. Empty until the
merchant accepts the order (no bill yet).

payments

created_at

date-time

created_at_text

string

extra

object

Headers

X-Event

string

enum

required

Always OrderStatusChanged for this event.

Allowed:

Response

2XX

Receiver acknowledged. Anything in the 2xx range is treated
as successful delivery; non-2xx is logged as a failure.