Update Order

There are two kinds of status updates that you can send to Tyro Connect to indicate how the order is progressing: mandatory status updates (that allow us to track order properly) and optional status updates (that will positively impact user experience if the connected App can handle such status update).

The mandatory status updates that you must send to indicate if the POS was able to successfully handle the order are:

  • ACCEPTED - POS accepted the order and it will be fulfilled.
  • REJECTED - POS failed to handle the order and the order will not be fulfilled.
  • READY - The order is ready to be picked up by the customer.

Orders that stay in the CREATED state for longer than two minutes will be automatically rejected and no further update is possible.

The optional status updates are:

  • BEING_PREPARED - order is being prepared
  • OUT_FOR_DELIVERY - order was dispatched for delivery (where applicable)
  • FULFILLED - The order has been picked up by the customer and is fulfilled (this will not apply if the order was dispatched for delivery).
  • CANCELLED_BY_MERCHANT - the merchant cancelled the order and it will not be fulfilled
  • CANCELLED_BY_CUSTOMER - customer contacted merchant and cancelled the order
Request
Security:
path Parameters
id
required
string
header Parameters
Authorization
required
string
Default: Bearer {$$.env.access_token}
Request Body schema: application/merge-patch+json
status
required
string
Enum: "ACCEPTED" "REJECTED" "BEING_PREPARED" "READY" "OUT_FOR_DELIVERY" "CANCELLED_BY_MERCHANT" "CANCELLED_BY_CUSTOMER" "FULFILLED"
reason
string

Required only when status is REJECTED, CANCELLED_BY_MERCHANT or CANCELLED_BY_CUSTOMER. An empty string will be considered as invalid

Responses
204

No body content. Order updated successfully

409

The status updated request failed. The new status is not a valid transition from the current order status.

patch/orders/{id}
Request samples
application/merge-patch+json
{
  • "status": "ACCEPTED"
}
Response samples
application/json
{
  • "error": "Order status conflict. Order status REJECTED cannot be updated to ACCEPTED."
}
Copyright © Tyro Payments 2019-2024. All right reserved.