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": "98eefc923ca9dd1f99263fdc"
}
Response
{
"checkout": {
"_id": "6352c3423a191c01cf545a17",
"id": "v9Y-IwXMw",
"version": 42,
"origin": "example",
"created": 1734574410098,
"shipping": {
"status": "Pending",
"fulfilled": true,
"date": 1744577499410,
"method": "example",
"freeShippingThreshold": 1.23,
"tracking": "example",
"shopCollection": true,
"weight": 1.23,
"packingSlip": "example"
},
"billing": {
"status": "example",
"fulfilled": true,
"paymentDate": 1735067611821,
"refundDate": 1761418868377
},
"orderId": "example",
"note": {
"date": 1743978484563,
"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": "7b3aabd68aa82f683b81f69a",
"quantity": 1,
"unavailable": true,
"added": 1732549578329
}
],
"buyer": {
"_id": "34e50be37ca9243459154ce9",
"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": "ed8d56b8b6995a95230599f3"
},
"updated": 1761058423448,
"expires": 1758281136527,
"status": "open",
"urls": {
"checkout": "example",
"storefront": "example"
},
"useSingleAddress": true,
"taxProfile": {
"isNationalShipping": true
},
"locationRef": "fc67c813d093e8c1a98d3649"
}
}
Arguments
| Name | Type | Description |
|---|---|---|
checkoutRef | ID! | Reference ID of the checkout to retrieve. |