Skip to main content

checkoutCreate Mutation

Description​

Creates a new checkout session.

mutation checkoutCreate {
  checkoutCreate {
    _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​

{}

Response​

{
    "checkoutCreate": {
        "_id": "ebeada4a6a7e1d01316806bb",
        "id": "82J-RM83s",
        "configRef": "06202637f355a215eb61efa6",
        "origin": "example",
        "created": 1721398413408,
        "shipping": {
            "status": "example",
            "date": 1739377022589,
            "method": "example",
            "freeShippingThreshold": 1.23,
            "tracking": "example",
            "shopCollection": true,
            "weight": "example"
        },
        "billing": {
            "status": "example",
            "paymentDate": 1717532325330,
            "refundDate": 1727485812943
        },
        "orderId": "example",
        "note": {
            "date": 1764947683892,
            "content": "example"
        },
        "items": [
            {
                "_id": "2aad92fedd57987fcc56304e",
                "id": "FUW-oDaX8",
                "quantity": 1.23,
                "added": 1764085297234,
                "total": 29.99,
                "unavailable": true
            }
        ],
        "buyer": {
            "_id": "7b995d06980de901c0bfd5e6",
            "email": "email@example.com",
            "firstName": "example",
            "id": 1.23,
            "lastName": "example",
            "name": "example",
            "telephone": "example",
            "organisation": "example",
            "taxNumber": "example",
            "isGuest": true
        },
        "seller": {
            "_id": "9b1427a11267bb05e48dd76f",
            "id": "IND-pNpan",
            "firstName": "example",
            "lastName": "example",
            "name": "example",
            "email": "email@example.com",
            "telephone": "example",
            "taxNumber": "example"
        },
        "updated": 1748923315515,
        "expires": 1721220536099,
        "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​

No arguments

Returns​

Checkout