addVoucher Mutation

Description

Applies a voucher to a checkout.

mutation addVoucher($id: String!, $voucherId: String!) {
  addVoucher(id: $id, voucherId: $voucherId) {
    _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",
    "voucherId": "voucherId"
}

Response

{
    "addVoucher": {
        "_id": "1adedeb25f6bdfe12d075bbc",
        "id": "example",
        "configRef": "4023d83ea9031bbbb79a51d1",
        "origin": "example",
        "created": 1718525387754,
        "shipping": {
            "status": "example",
            "date": 1758296798836,
            "method": "example",
            "freeShippingThreshold": 1.23,
            "tracking": "example",
            "shopCollection": true,
            "weight": "example"
        },
        "billing": {
            "status": "example",
            "paymentDate": 1728105058453,
            "refundDate": 1752131955274
        },
        "orderId": "example",
        "note": {
            "date": 1712781936482,
            "content": "example"
        },
        "items": [
            {
                "_id": "0be2646e52412df0f3fb1027",
                "id": "d39dc82760ec4ca1b0819d11",
                "quantity": 1.23,
                "added": 1712595735170,
                "total": 29.99,
                "unavailable": true
            }
        ],
        "buyer": {
            "_id": "f0a19cb70d870a8af0b15bcd",
            "email": "email@example.com",
            "firstName": "example",
            "id": 1.23,
            "lastName": "example",
            "name": "example",
            "telephone": "example",
            "organisation": "example",
            "taxNumber": "example",
            "isGuest": true
        },
        "seller": {
            "_id": "6b4ae6ddcfcd8e65c2a17f9c",
            "id": "example",
            "firstName": "example",
            "lastName": "example",
            "name": "example",
            "email": "email@example.com",
            "telephone": "example",
            "taxNumber": "example"
        },
        "updated": 1715200900189,
        "expires": 1768338689295,
        "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.
voucherId	String!	Voucher identifier or code.

Returns

Checkout!