Skip to content

AppListReturns

GET
/apps/returns
curl --request GET \
--url https://your-store.myciqra.com/apps/returns \
--header 'Authorization: Bearer <token>'

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

skip
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
take
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
statuses
string
search
string
source
string

OK

Media typeapplication/json
object
hasMore
required
boolean
items
required
Array<object>
object
createdAt
required
string format: date-time
currency
required
string
customerEmail
required
null | string
id
required
string format: uuid
isExchange
required
boolean
isImported
required
boolean
orderId
required
string format: uuid
orderNumber
required
string
orderTotal
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
personalDataRedacted
required
boolean
reason
required
string
requestedAmount
required
null | number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
status
required
Allowed values: Requested Approved Rejected Refunded Received Disputed Withdrawn Exchanged
skip
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
take
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
total
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
Example
{
"items": [
{
"status": "Requested"
}
]
}