Event · Orders
order.refunded
A refund was recorded on the order.
Without customers:read, the customer and shipping_address keys are absent from the payload. Each installation receives the webhook according to its own scopes. Orders never include the payment method, gateway or card details.
Payload data
Every event arrives in the standard webhook envelope. These are the fields of data.
- idstring
- Order ID.
- numberinteger
- Display order number.
- statuspending | processing | completed | cancelled | returned
- Order status.
- payment_statusunpaid | paid | refunded
- Payment status.
- currencySAR
- totalsobject
- subtotal, discount, shipping and total, as strings with two decimal places.
- itemsarray
- product_id, name, kind, quantity, unit_price and total.
- order_urlstring | null
- The customer's orders page in the store, the same link as the order email. Not a per-order link.
- created_atdate-time
- updated_atdate-time
- paid_atdate-time | null
- refunded_atdate-time | null
- customerobject
- id, name, phone in E.164 format, and email.Returned with
customers:readRead customer contact details - shipping_addressobject | null
- name, phone (E.164), country, city, district, street, postal_code, short_address_code, building_number, secondary_number and notes; null when the order has no address.Returned with
customers:readRead customer contact details - resource_versioninteger
- Always 0 for orders. Order the events of one order by resource.version in the envelope.