removeVoucher Mutation
Description
Removes a voucher from a checkout.
mutation removeVoucher($id: String!) {
removeVoucher(id: $id) {
_id
id
configRef
origin
created
shipping {
status
date
method
freeShippingThreshold
tracking
shopCollection
weight
}
billing {
status
paymentDate
refundDate
}
orderId
note {
date
content
}
items {
_id
id
quantity
added
total
unavailable
}
buyer {
_id
email
firstName
id
lastName
name
telephone
organisation
taxNumber
isGuest
}
seller {
_id
id
firstName
lastName
name
email
telephone
taxNumber
}
updated
expires
status
message
totals {
grand
leftToPay
discount
itemsQuantity
itemQuantity
subtotal
subtotalBeforeTaxes
shipping
tax
}
urls {
checkout
storefront
}
useSingleAddress
}
}
Variables
{
"id": "08a16b83-9094-4e89-8c05-2ccadd5c1c7e"
}
Response
{
"removeVoucher": {
"_id": "b2dbb70730982e143644b76a",
"id": "example",
"configRef": "59afc25f3a75b9584c6ed4c7",
"origin": "example",
"created": 1771500061204,
"shipping": {
"status": "example",
"date": 1734875732623,
"method": "example",
"freeShippingThreshold": 1.23,
"tracking": "example",
"shopCollection": true,
"weight": "example"
},
"billing": {
"status": "example",
"paymentDate": 1764660254434,
"refundDate": 1780268887254
},
"orderId": "example",
"note": {
"date": 1761839136073,
"content": "example"
},
"items": [
{
"_id": "fa192435f6c45cda22b50ab3",
"id": "e8931aa0c0b42fe430a6b09e",
"quantity": 1.23,
"added": 1787003117999,
"total": 29.99,
"unavailable": true
}
],
"buyer": {
"_id": "37ff01026fb8b1a4e9419cc1",
"email": "email@example.com",
"firstName": "example",
"id": 1.23,
"lastName": "example",
"name": "example",
"telephone": "example",
"organisation": "example",
"taxNumber": "example",
"isGuest": true
},
"seller": {
"_id": "bfaa39d16993eb477617d1ad",
"id": "example",
"firstName": "example",
"lastName": "example",
"name": "example",
"email": "email@example.com",
"telephone": "example",
"taxNumber": "example"
},
"updated": 1763874366894,
"expires": 1755287184289,
"status": "example",
"message": "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
},
"urls": {
"checkout": "example",
"storefront": "example"
},
"useSingleAddress": true
}
}
Arguments
| Name | Type | Description |
|---|---|---|
id | String! | Checkout identifier string. |