Skip to main content

checkoutAddNote Mutation

Description​

Adds a note to the checkout.

mutation checkoutAddNote($id: String!, $content: String!, $version: Int) {
checkoutAddNote(id: $id, content: $content, version: $version) {
_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​

{
"id": "h0d-cXgYK",
"content": "content",
"version": 42
}

Response​

{
"checkoutAddNote": {
"_id": "4932f097237d681d48033ac3",
"id": "v6U-Q7C5Q",
"version": 42,
"origin": "example",
"created": 1739822290991,
"shipping": {
"status": "Pending",
"fulfilled": true,
"date": 1772293112059,
"method": "example",
"freeShippingThreshold": 1.23,
"tracking": "example",
"shopCollection": true,
"weight": 1.23,
"packingSlip": "example"
},
"billing": {
"status": "example",
"fulfilled": true,
"paymentDate": 1749943924302,
"refundDate": 1756841777864
},
"orderId": "example",
"note": {
"date": 1789859298052,
"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": "a4dc09cad59adbba6a87e439",
"quantity": 1,
"unavailable": true,
"added": 1746974834972
}
],
"buyer": {
"_id": "90fcb9ea8c9b1bb4037030fd",
"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": "c8034422c26a84e10916555b"
},
"updated": 1736244645473,
"expires": 1752154420926,
"status": "open",
"urls": {
"checkout": "example",
"storefront": "example"
},
"useSingleAddress": true,
"taxProfile": {
"isNationalShipping": true
},
"locationRef": "09f3f3fb8fa03aab61cf0295"
}
}

Arguments​

NameTypeDescription
idString!String identifier of the checkout.
contentString!Content of the note to add.
versionIntCurrent version number of the checkout for optimistic locking. Prevents conflicts when multiple users edit simultaneously.

Returns​

Checkout!