Skip to content

AppGetReturn

GET
/apps/returns/{id}
curl --request GET \
--url https://your-store.myciqra.com/apps/returns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'Authorization: Bearer <token>'

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

id
required
string format: uuid

OK

Media typeapplication/json
object
createdAt
required
string format: date-time
currency
required
string
customerEmail
required
null | string
customerNote
required
null | string
freeReturns
required
boolean
hasPhoto
required
boolean
id
required
string format: uuid
isExchange
required
boolean
lines
required
Array<object>
object
name
required
string
orderLineId
required
string format: uuid
quantity
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
marketplace
required
One of:
null
orderId
required
string format: uuid
orderNumber
required
string
personalDataRedacted
required
boolean
reason
required
string
refundable
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
refundedOnReturn
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
requestedAmount
required
null | number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
returnLabel
required
One of:
null
status
required
string
Examplegenerated
{
"createdAt": "2026-04-15T12:00:00Z",
"currency": "example",
"customerEmail": "example",
"customerNote": "example",
"freeReturns": true,
"hasPhoto": true,
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"isExchange": true,
"lines": [
{
"name": "example",
"orderLineId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"quantity": 1
}
],
"marketplace": {
"channel": "example",
"decisionDueAt": "2026-04-15T12:00:00Z",
"decisionPending": true,
"sellerDecidesReturns": true
},
"orderId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"orderNumber": "example",
"personalDataRedacted": true,
"reason": "example",
"refundable": 1,
"refundedOnReturn": 1,
"requestedAmount": 1,
"returnLabel": {
"cost": 1,
"shipmentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"status": "example"
},
"status": "example"
}