checkout Query
Description
Retrieves a single checkout by its reference ID.
query checkout($checkoutRef: ID!) {
checkout(checkoutRef: $checkoutRef) {
_id
id
version
origin
created
shipping {
status
fulfilled
date
method
freeShippingThreshold
tracking
shopCollection
weight
packingSlip
}
billing {
status
fulfilled
paymentDate
refundDate
}
orderId
note {
date
content
}
totals {
subtotal
subtotalBeforeTaxes
tax
grand
leftToPay
itemQuantity
discount
shipping
creditNote
balance
}
items {
_id
quantity
unavailable
added
}
buyer {
_id
firstName
lastName
email
name
path
telephone
organisation
taxNumber
}
seller {
type
name
email
ref
}
updated
expires
status
urls {
checkout
storefront
}
useSingleAddress
taxProfile {
isNationalShipping
}
locationRef
}
}
Variables
{
"checkoutRef": "6ecdc369f428a3f778c1606e"
}
Response
{
"checkout": {
"_id": "2ee7e4a4953481ba6207fee5",
"id": "Vqc-19I88",
"version": 42,
"origin": "example",
"created": 1776893825481,
"shipping": {
"status": "Pending",
"fulfilled": true,
"date": 1768461403537,
"method": "example",
"freeShippingThreshold": 1.23,
"tracking": "example",
"shopCollection": true,
"weight": 1.23,
"packingSlip": "example"
},
"billing": {
"status": "example",
"fulfilled": true,
"paymentDate": 1738318091011,
"refundDate": 1748305115408
},
"orderId": "example",
"note": {
"date": 1757154818572,
"content": "example"
},
"totals": {
"subtotal": 1.23,
"subtotalBeforeTaxes": 1.23,
"tax": 1.23,
"grand": 1.23,
"leftToPay": 1.23,
"itemQuantity": 1.23,
"discount": 0.1,
"shipping": 1.23,
"creditNote": 1.23,
"balance": 1.23
},
"items": [
{
"_id": "2bba322d5ffbd74c42be40b0",
"quantity": 1,
"unavailable": true,
"added": 1781553396327
}
],
"buyer": {
"_id": "8946ceffbca7b5c90826552d",
"firstName": "example",
"lastName": "example",
"email": "email@example.com",
"name": "example",
"path": "/release/1763553751/release-artist-release-name",
"telephone": "example",
"organisation": "example",
"taxNumber": "example"
},
"seller": {
"type": "example",
"name": "example",
"email": "email@example.com",
"ref": "8b765503e13baa8de2d7cfcf"
},
"updated": 1784242333006,
"expires": 1779005472891,
"status": "open",
"urls": {
"checkout": "example",
"storefront": "example"
},
"useSingleAddress": true,
"taxProfile": {
"isNationalShipping": true
},
"locationRef": "1f994affc2f4703edb22f07d"
}
}
Arguments
| Name | Type | Description |
|---|---|---|
checkoutRef | ID! | Reference ID of the checkout to retrieve. |