checkoutVerifyAndThrow Mutation

Description

Verifies checkout validity and throws an error if invalid.

mutation checkoutVerifyAndThrow($id: String!) {
  checkoutVerifyAndThrow(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": "OhP-EZuDM"
}

Response

{
    "checkoutVerifyAndThrow": {
        "_id": "b55463c0c05ba1df2cf3ff36",
        "id": "JZs-Mc8CU",
        "configRef": "b2ddf2ad2ae5f6639fa0d9c6",
        "origin": "example",
        "created": 1720040073205,
        "shipping": {
            "status": "example",
            "date": 1733351695039,
            "method": "example",
            "freeShippingThreshold": 1.23,
            "tracking": "example",
            "shopCollection": true,
            "weight": "example"
        },
        "billing": {
            "status": "example",
            "paymentDate": 1748269770800,
            "refundDate": 1727334076893
        },
        "orderId": "example",
        "note": {
            "date": 1765983143584,
            "content": "example"
        },
        "items": [
            {
                "_id": "37b5693c5776dcbcdefc5445",
                "id": "5Ey-vsvnj",
                "quantity": 1.23,
                "added": 1745908039762,
                "total": 29.99,
                "unavailable": true
            }
        ],
        "buyer": {
            "_id": "818cafede130abb678941dd9",
            "email": "email@example.com",
            "firstName": "example",
            "id": 1.23,
            "lastName": "example",
            "name": "example",
            "telephone": "example",
            "organisation": "example",
            "taxNumber": "example",
            "isGuest": true
        },
        "seller": {
            "_id": "214c07fc9b253ad8bf51bad9",
            "id": "LZs-h1eqg",
            "firstName": "example",
            "lastName": "example",
            "name": "example",
            "email": "email@example.com",
            "telephone": "example",
            "taxNumber": "example"
        },
        "updated": 1717080495335,
        "expires": 1736777118794,
        "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.

Returns

Checkout