An order was cancelled by the customer or the staff, or declined by the staff.
data
-
The order number people see, eg SO-K7M2QX.
e.g.SO-K7M2QX -
new = waiting for the business to accept it.
newacceptedpreparingreadyout_for_deliverycompletedcancelledrejectedexpired - source string
webchatflowcounterapi -
pickupdelivery - asap boolean
true = as soon as possible; false = the customer chose a time.
- due string (date-time) | null
When the order is ready (pickup) or arrives (delivery).
- customer object
-
10 item fields
- item_id integer
- variant_id integer | null
- sku string
- name string
- variant string
- options string[]
- quantity integer
- unit_price number
- total number
- note string
- items_count integer
- e.g.
USD - subtotal number
- discount number
- discount_code string
- delivery_fee number
- fees number
- tip number
- tax number
- total_label stringe.g.
$30.50 - refunded number
-
3 fields
- state string
authorised: the card is held (the shop charges only when it accepts the order, a per-shop setting); released: that hold was released, nothing was charged.
not_neededon_pickupon_deliverypendingauthorisedpaidpart_refundedrefundedreleasedfailed - method string
stripe, paypal, cash, card, or empty while nothing was paid.
- payment_id integer | null
The id of the online payment (GET /payments/{id}).
- delivery object | null
null for a pickup.
- note string
- allergy_note string
- pickup_code string
The 4 characters the customer can say at the counter.
- timestamp string (date-time)
- cancelled object
Inside the envelope {id, type, created, number, test?, data}: envelope, headers, signature.
Caused by
- POST /v1/{number}/shop/orders/{id}/action Move an order on, change its time, cancel or decline it