Skip to main content
PATCH
Act on a return

Authorizations

x-api-key
string
header
required

Your Store API key (pk_live_...). Create it in Developers › API keys.

x-store-hash
string
header
required

The ID of the store the request is for. Shown in Developers › API keys.

Path Parameters

invoiceId
string
required

Public order ID.

Example:

"c35ffd-19a1b2c3d4e-8c7a20"

returnId
string
required

Return ID.

Example:

"9f1c2a7b3d4e5f60"

Body

application/json
action
enum<string>
required
Available options:
approve,
reject,
receive,
refund,
close
note
string
Maximum string length: 2000
location_id
integer
restock
boolean
refund_cents
integer
Required range: x >= 0

Response

Updated

success
boolean
required
Example:

true

return
object