/v1/workspaces/{workspace_id}/data/refunds

string

required

length ≥ 1

The ID of the refund.

order_id

string | null

The ID of the order the refund belongs to.

created_at

date-time

required

The date and time (ISO 8601 format) when the refund was created.

refund_processed_at

date-time | null

The date and time (ISO 8601 format) when the refund was processed.

updated_at

date-time | null

The date and time (ISO 8601 format) when the refund was last updated.

note

string | null

An optional note attached to the refund.

user_id

string | null

The ID of the user who performed the refund.

total_refunded

string | null

The total amount across all transactions for the refund, in the shop currency. Zero when no payment was reversed, such as a store credit or restock-only refund.

currency

string | null

The shop currency of the refunded total.

additional_fields

array of objects | null

Extra properties.

additional_fields

201Default Response

202Default Response