checkoutRemoveEntry Mutation
Description
Removes an entry from the checkout items.
mutation checkoutRemoveEntry($id: String!, $entryRef: ID!, $version: Int) {
checkoutRemoveEntry(id: $id, entryRef: $entryRef, 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": "wSF-KXfB8",
"entryRef": "3b03a5b8350579da590394db",
"version": 42
}
Response
{
"checkoutRemoveEntry": {
"_id": "28bbe4f5a7f3ff18238b9e1e",
"id": "Tbo-s8IXO",
"version": 42,
"origin": "example",
"created": 1748622333700,
"shipping": {
"status": "Pending",
"fulfilled": true,
"date": 1734436467850,
"method": "example",
"freeShippingThreshold": 1.23,
"tracking": "example",
"shopCollection": true,
"weight": 1.23,
"packingSlip": "example"
},
"billing": {
"status": "example",
"fulfilled": true,
"paymentDate": 1776576480209,
"refundDate": 1764728072672
},
"orderId": "example",
"note": {
"date": 1734014182267,
"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": "494d453c4a191017d0f5f933",
"quantity": 1,
"unavailable": true,
"added": 1768254763738
}
],
"buyer": {
"_id": "ffc246739fbdaa9deeb1f486",
"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": "84ba6051b0788bbd55d50e0f"
},
"updated": 1780739848446,
"expires": 1793410634921,
"status": "open",
"urls": {
"checkout": "example",
"storefront": "example"
},
"useSingleAddress": true,
"taxProfile": {
"isNationalShipping": true
},
"locationRef": "d6e022895f1db440d78561a3"
}
}
Arguments
| Name | Type | Description |
|---|---|---|
id | String! | String identifier of the checkout. |
entryRef | ID! | Reference ID of the entry to remove from the checkout. |
version | Int | Current version number of the checkout for optimistic locking. Prevents conflicts when multiple users edit simultaneously. |