checkoutUpdate Mutation

Description

Updates checkout information including billing, shipping, and buyer details.

mutation checkoutUpdate(
  $id: String!
  $billing: CheckoutBillingInput
  $shipping: CheckoutShippingInput
  $buyer: CheckoutBuyerInput
  $createAccount: Boolean
  $useSingleAddress: Boolean
) {
  checkoutUpdate(
    id: $id
    billing: $billing
    shipping: $shipping
    buyer: $buyer
    createAccount: $createAccount
    useSingleAddress: $useSingleAddress
  ) {
    _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": "h9r-YS0MT",
    "billing": {
        "address": {
            "_id": "f7dd1c9448605f7239c15d26",
            "description": "A description",
            "firstName": "John",
            "lastName": "Doe",
            "addressLine1": "addressLine1",
            "addressLine2": "addressLine2",
            "streetNumber": "streetNumber",
            "city": "Montreal",
            "state": "Quebec",
            "stateCode": "stateCode",
            "postCode": "postCode",
            "country": "Canada",
            "alpha2": "alpha2",
            "type": "type"
        },
        "voucher": {
            "id": "FME-0u8ZU",
            "value": "value",
            "redeemType": "redeemType"
        }
    },
    "shipping": {
        "method": "method",
        "address": {
            "_id": "04e43017103a0fb04b59ff5a",
            "description": "A description",
            "firstName": "John",
            "lastName": "Doe",
            "addressLine1": "addressLine1",
            "addressLine2": "addressLine2",
            "streetNumber": "streetNumber",
            "city": "Montreal",
            "state": "Quebec",
            "stateCode": "stateCode",
            "postCode": "postCode",
            "country": "Canada",
            "alpha2": "alpha2",
            "type": "type"
        },
        "tracking": "tracking",
        "confirmationEmail": {
            "recipient": "recipient"
        },
        "shopCollection": true
    },
    "buyer": {
        "_id": "818d1473b2d7f7918fa17843",
        "email": "email@example.com",
        "firstName": "John",
        "id": 30.7,
        "lastName": "Doe",
        "name": "A name",
        "telephone": "telephone",
        "organisation": "organisation",
        "taxNumber": "taxNumber",
        "isGuest": true
    },
    "createAccount": true,
    "useSingleAddress": true
}

Response

{
    "checkoutUpdate": {
        "_id": "40b7af4b0d3760e0b89832f7",
        "id": "eUX-i3oqE",
        "configRef": "21f7625f66291080a3d54753",
        "origin": "example",
        "created": 1705769103332,
        "shipping": {
            "status": "example",
            "date": 1713235275419,
            "method": "example",
            "freeShippingThreshold": 1.23,
            "tracking": "example",
            "shopCollection": true,
            "weight": "example"
        },
        "billing": {
            "status": "example",
            "paymentDate": 1754881920117,
            "refundDate": 1723471436316
        },
        "orderId": "example",
        "note": {
            "date": 1744641374311,
            "content": "example"
        },
        "items": [
            {
                "_id": "1e7e58cd89ff77683be93c06",
                "id": "mGH-Zc7d9",
                "quantity": 1.23,
                "added": 1734640114776,
                "total": 29.99,
                "unavailable": true
            }
        ],
        "buyer": {
            "_id": "5e4b6033473bb387f0596d87",
            "email": "email@example.com",
            "firstName": "example",
            "id": 1.23,
            "lastName": "example",
            "name": "example",
            "telephone": "example",
            "organisation": "example",
            "taxNumber": "example",
            "isGuest": true
        },
        "seller": {
            "_id": "a37d5d952dd30d337d1cd210",
            "id": "cW4-p4X6k",
            "firstName": "example",
            "lastName": "example",
            "name": "example",
            "email": "email@example.com",
            "telephone": "example",
            "taxNumber": "example"
        },
        "updated": 1746790495983,
        "expires": 1710450627674,
        "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.
billing	CheckoutBillingInput	Billing address and voucher information.
shipping	CheckoutShippingInput	Shipping address and method information.
buyer	CheckoutBuyerInput	Buyer information.
createAccount	Boolean	Whether to create a user account for the buyer.
useSingleAddress	Boolean	Whether to use the same address for billing and shipping.

Returns

Checkout