Skip to main content

orders Query

Description​

Retrieves a paginated list of orders for the current user.

query orders($page: Int) {
orders(page: $page) {
_id
id
configRef
created
origin
status
totals {
grand
leftToPay
discount
itemsQuantity
itemQuantity
subtotal
subtotalBeforeTaxes
shipping
tax
}
buyer {
_id
id
firstName
lastName
name
email
telephone
taxNumber
organisation
isSubscribed
}
billing {
status
paymentDate
refundDate
}
shipping {
status
date
method
freeShippingThreshold
tracking
shopCollection
weight
}
items {
_id
id
quantity
added
total
unavailable
}
messages {
content
subject
created
fromBuyer
}
paymentUrl
}
}

Variables​

{
"page": 1
}

Response​

{
"orders": [
{
"_id": "496fa9522aec6e8fd736d06c",
"id": "example",
"configRef": "63fdc06d740aa46dd5149ba2",
"created": 1771490353415,
"origin": "example",
"status": "example",
"totals": {
"grand": 1.23,
"leftToPay": 1.23,
"discount": 0.1,
"itemsQuantity": 1.23,
"itemQuantity": 42,
"subtotal": 1.23,
"subtotalBeforeTaxes": 1.23,
"shipping": 1.23,
"tax": 1.23
},
"buyer": {
"_id": "06a7278b86e1f82243144366",
"id": 1.23,
"firstName": "example",
"lastName": "example",
"name": "example",
"email": "email@example.com",
"telephone": "example",
"taxNumber": "example",
"organisation": "example",
"isSubscribed": true
},
"billing": {
"status": "example",
"paymentDate": 1752528115165,
"refundDate": 1775910725856
},
"shipping": {
"status": "example",
"date": 1780652194026,
"method": "example",
"freeShippingThreshold": 1.23,
"tracking": "example",
"shopCollection": true,
"weight": "example"
},
"items": [
{
"_id": "a54c7bf60460175896188e77",
"id": "68fbc8b44ac8e80cf9984c94",
"quantity": 1.23,
"added": 1787947115878,
"total": 29.99,
"unavailable": true
}
],
"messages": [
{
"content": "example",
"subject": "example",
"created": 1780410294175,
"fromBuyer": true
}
],
"paymentUrl": "example"
}
]
}

Arguments​

NameTypeDescription
pageIntPage number to retrieve.

Returns​

[Order!]!