Update Order

In order to provide more information about the status changes to the order, you can send the following statuses:

  • CANCELLED_BY_CUSTOMER - customer has cancelled the order.
  • FULFILLED - The order was completed successfully.
Request
Security:
path Parameters
orderId
required
string

Identifier of the order that needs to be updated

header Parameters
Authorization
required
string
Default: Bearer {$$.env.access_token}
Request Body schema: application/merge-patch+json
status
required
string
Enum: "CANCELLED_BY_CUSTOMER" "FULFILLED"
reason
string

Required only when status is CANCELLED_BY_CUSTOMER. An empty string will be considered as invalid

Responses
204

No body content. Order updated successfully

400

Bad request

401

Invalid or missing access token

403

Insufficient permissions to edit an order's status

404

Order id not found

409

Conflict when updating order status

500

Internal server error

patch/orders/{orderId}
Request samples
application/merge-patch+json
{
  • "status": "FULFILLED"
}
Response samples
application/json
{
  • "message": "string",
  • "errors": [
    ],
  • "error": "string"
}
Copyright © Tyro Payments 2019-2024. All right reserved.