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": "2794adb7603262fd5cb9d93f",
        "id": "kAV-ncZOH",
        "configRef": "53a7d5f13399aa2ae9f3fd2c",
        "origin": "example",
        "created": 1760633945800,
        "shipping": {
            "status": "example",
            "date": 1754680742452,
            "method": "example",
            "freeShippingThreshold": 1.23,
            "tracking": "example",
            "shopCollection": true,
            "weight": "example"
        },
        "billing": {
            "status": "example",
            "paymentDate": 1726083223008,
            "refundDate": 1764283483967
        },
        "orderId": "example",
        "note": {
            "date": 1704918531448,
            "content": "example"
        },
        "items": [
            {
                "_id": "8aa568c819e0419f26ff93b9",
                "id": "TCb-VDR3o",
                "quantity": 1.23,
                "added": 1723895961930,
                "total": 29.99,
                "unavailable": true
            }
        ],
        "buyer": {
            "_id": "849c60b059af13376c23a1a5",
            "email": "email@example.com",
            "firstName": "example",
            "id": 1.23,
            "lastName": "example",
            "name": "example",
            "telephone": "example",
            "organisation": "example",
            "taxNumber": "example",
            "isGuest": true
        },
        "seller": {
            "_id": "bd53e759e10124f20ab05598",
            "id": "iBW-ZJ0v7",
            "firstName": "example",
            "lastName": "example",
            "name": "example",
            "email": "email@example.com",
            "telephone": "example",
            "taxNumber": "example"
        },
        "updated": 1731454100482,
        "expires": 1751677650649,
        "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