Create order refund

Issues a refund on the order with the given id for the given items and quantities, with an optional reason and an option to send the customer a confirmation email. Returns the created refund.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

-customer

Path Params
string
required

The site's unique name (its ID), returned when the site is created.

string
required

The order's ID.

Body Params
string | null

Optional merchant defined reason for the refund

boolean

Send a confirmation email to the customer related to the order

items
array of objects
required
length ≥ 1

Items affected by the refund, at least one item must be set

items*
string
required
length ≥ 1

Line item id to issue a refund on. use item_shipping to refund the shipping fees

double
required

Quantity to refund for the item. This quantity can be a decimal for partial refunds. If id is item_shipping, the quantity must be set to 1

Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json