Skip to main content
POST
Create customer return

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Body

application/json
sales_order_id
integer
required
items
object[]
required
Minimum array length: 1
order_date
string<date> | null
is_posted
enum<integer> | null

Optional. When 1, the return is created already received.

Available options:
0,
1
restock
boolean | null

When true, inventory is restocked on receive (default behavior).

transaction_type
enum<string> | null
Available options:
return-only,
refund-only,
return-and-refund

Response

Created

data
object

A customer return for a sales order — return-only, refund-only, or return-and-refund. Status is Pending until received, then Received.