Skip to content

AppListOrders

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

Required scope: read_orders — 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
placedFrom
string format: date-time
placedTo
string format: date-time
updatedSince
string format: date-time
tag
string
archived
boolean

OK

Media typeapplication/json
object
hasMore
required
boolean
items
required
Array<object>
object
archivedAt
required
null | string format: date-time
b2bCompanyId
required
null | string format: uuid
createdAt
required
string format: date-time
currency
required
string
customerEmail
required
null | string
id
required
string format: uuid
itemCount
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
orderNumber
required
string
personalDataRedacted
required
boolean
returnStatus
required
null | string
status
required
Allowed values: PendingPayment AwaitingCollection Paid PaymentFailed Processing Shipped Delivered Completed Cancelled Refunded Returned AwaitingApproval Procurement ReadyForShipment PartiallyRefunded PartiallyCancelled PartiallyFulfilled
total
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
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": "PendingPayment"
}
]
}