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

Request

Base URL
https://api.komerza.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/komerza/apis/komerza-api/docs/stores/:storeId/orders/:orderId/refund/delete.ts
A function with typed inputs. Its response is checked against the schema.

storeIdstring uuid required

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

orderIdstring uuid required

The ID of the order to refund

reason0 | 1 | 2 | 3 required

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

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

No recorded changes to this operation across all 1 revision of this API.