Sign in

v1

latestOpenAPI 3.0.42026-07-2685196386.6 KB
Order

Refund order

Refunds a delivered order for a customer in the admin dashboard. Requires the stores.orders.refund permission.

delete/stores/{storeId}/orders/{orderId}/refund

Path parameters

storeIdstring uuid required

The ID of the store the order will be refunded in.

orderIdstring uuid required

The ID of the order to refund

Request body

reason0 | 1 | 2 | 3 required

Indicates a duplicate transaction or order as the reason for a refund.

Response

The object was successfully created.

successboolean required

Indicates whether the operation or response was successful.

messagestring nullable

A descriptive message providing additional context or information about the response.

codestring nullable

The error code (if there was an error) to use when referencing the error