Skip to content

AppOpenOrderReturn

POST
/apps/orders/{id}/returns
curl --request POST \
--url https://your-store.myciqra.com/apps/orders/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/returns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "amount": 1, "reason": "example", "reasonId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Required scope: write_returns — an installation token without it receives 403.

id
required
string format: uuid
Media typeapplication/json
One of:
null
Examplegenerated
{
"amount": 1,
"reason": "example",
"reasonId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

OK

Media typeapplication/json
object
id
required
string format: uuid
orderId
required
string format: uuid
status
required
Allowed values: Requested Approved Rejected Refunded Received Disputed Withdrawn Exchanged
Example
{
"status": "Requested"
}