/

    Search

    Close search
    Change color mode. Active mode is light.Open search

    CheckoutSession

    • Object

    Data required to display the hosted checkout page.

    #

    Fields


    companyNameRequirement
    •CheckoutFieldRequirement!
    companyVatNumberRequirement
    •CheckoutFieldRequirement!
    favicon
    •Media
    logo
    •Media
    marketingConsent
    •Boolean!
    nameRequirement
    •CheckoutNameRequirement!
    redirectUri
    •String
    shippingPhoneNumberRequirement
    •CheckoutFieldRequirement!
    token
    •String!

    The token of the checkout session.

    #

    Queries


    checkoutSession
    • Introduction
    • Project routing
    • Request context
    • Media delivery
    • Authentication
    • IDs and pagination
    • Errors
    • Cart and checkout
    • Customer authentication
    • Error handling
    • Storefront API quickstart
    • Storefront request context
    • Carts
      • Queries
      • Mutations
      • Objects
        • Cart
        • CartAddDiscountCodeNotFoundError
        • CartAddress
        • CartAuthenticationFailedError
        • CartAuthorizationFailedError
        • CartAvailableShippingMethod
        • CartCompletePayload
        • CartCompletionDiscountCodeAlreadyUsedError
        • CartCompletionDiscrepancyError
        • CartCreatePayload
        • CartDiscountCodeAddPayload
        • CartDiscountCodeMaxApplicationsReachedError
        • CartDiscountCodeRemovePayload
        • CartLineItem
        • CartLineItemConnection
        • CartLineItemEdge
        • CartLineItemPriceNotFoundError
        • CartLineItemsAddPayload
        • CartLineItemsInsufficientStockError
        • CartLineItemsNotFoundError
        • CartLineItemsRemovePayload
        • CartLineItemsUpdatePayload
        • CartLineItemUnavailableForPurchase
        • CartNotFoundError
        • CartPaymentSessionInitializePayload
        • CartReplicatePayload
        • CartReplicateStockChangeError
        • CartReplicateStrictValidationFailedError
        • CartReplicateVariantNotFoundError
        • CartShippingLine
        • CartShippingLineAddPayload
        • CartShippingLineNotFoundError
        • CartShippingLineRemovePayload
        • CartShippingLinesSetPayload
        • CartUpdatePayload
        • CartUpdatePriceChannelNotFoundError
        • CheckoutSession
        • CountryInfo
        • CreateCartAddressDoesNotHaveCountryCodeError
        • CreateCartAuthenticationFailedError
        • CreateCartAuthorizationFailedError
        • CreateCartChannelDoesNotSupportCountryError
        • CreateCartChannelDoesNotSupportCurrencyError
        • CreateCartChannelHasNoCountriesError
        • CreateCartChannelNotFoundError
        • CreateCartPriceChannelNotFoundError
        • CreateCartShippingAddressDoesNotHaveShippingZonesError
        • CreateCartStoreNotFoundError
        • DiscountApplication
        • DiscountApplicationConnection
        • DiscountApplicationEdge
        • DiscountCode
        • Facet
        • FacetValue
        • LineItemAttribute
        • MetadataItem
        • Money
        • OrderLineItem
        • OrderLineItemConnection
        • OrderLineItemEdge
        • PageCursor
        • PageInfo
        • PaymentGatewaySessionInitializeFailedError
        • PostalCodeInfo
        • RelativeValue
        • Store
        • UpdateCartLineItemsInsufficientStockError
        • Weight
        • ZoneInfo
      • Interfaces
      • Inputs
    • Categories
    • Collections
    • Common
    • Customers
    • Payment gateways
    • Products
    • Shipping