Skip to main content

Documentation Index

Fetch the complete documentation index at: https://colossal.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Queries

checkoutSession

Fetch a checkout session with payment and order details.
query CheckoutSession($uid: UUID!) {
  checkoutSession(uid: $uid) {
    uid
    status
    checkoutUrl
    readyForPayment
    requiredFields
    checkoutValidationIssues
    selectedPaymentProvider
    shippingOptions {
      uid
      displayName
      amount
    }
    paymentSession {
      uid
      provider
      status
      amount
      currency
      providerRef
      clientToken
      paymentMethods
    }
    order {
      uid
      status
      totalAmount
    }
    invoice {
      uid
      total
      status
    }
    expiresAt
    completedAt
  }
}

Mutations

createCheckoutSession

Create a checkout session from a cart.
mutation CreateCheckoutSession(
  $cartUid: UUID!
  $guestEmail: String
  $guestName: String
) {
  createCheckoutSession(
    cartUid: $cartUid
    guestEmail: $guestEmail
    guestName: $guestName
  ) {
    success
    data {
      uid
      checkoutUrl
      status
    }
  }
}
Arguments:
FieldTypeRequiredDescription
cartUidUUIDYesCart to check out
guestEmailStringNoEmail for guest checkout
guestNameStringNoName for guest checkout

updateCheckoutSession

Update checkout details (address, payment provider, shipping).
mutation UpdateCheckoutSession(
  $sessionUid: UUID!
  $input: CheckoutSessionUpdateInput!
) {
  updateCheckoutSession(sessionUid: $sessionUid, input: $input) {
    success
    data {
      uid
      readyForPayment
      checkoutValidationIssues
    }
  }
}
Input:
FieldTypeDescription
selectedPaymentProviderString?Payment provider ID
customerCustomerInfoInput?Customer email, name, phone
billingAddressAddressInput?Billing address
shippingAddressAddressInput?Shipping address
selectedShippingOptionString?Shipping option UID

completeCheckoutSession

Complete payment and finalize the order.
mutation CompleteCheckoutSession(
  $sessionUid: UUID!
  $paymentMethodType: String
  $paymentMethodId: String
  $pspPayload: JSON
  $returnUrl: String
) {
  completeCheckoutSession(
    sessionUid: $sessionUid
    paymentMethodType: $paymentMethodType
    paymentMethodId: $paymentMethodId
    pspPayload: $pspPayload
    returnUrl: $returnUrl
  ) {
    success
    data {
      uid
      status
      order { uid status }
    }
  }
}

Types

CheckoutSession

FieldTypeDescription
uidUUIDSession ID
statusOPEN | COMPLETED | EXPIRED | ABANDONEDSession status
checkoutUrlStringHosted checkout URL
readyForPaymentBooleanWhether all required fields are set
requiredFields[String]BILLING_ADDRESS, SHIPPING_ADDRESS
checkoutValidationIssues[String]Validation errors preventing completion
selectedPaymentProviderString?Selected provider ID
shippingOptions[ShippingOption]Available shipping options
paymentSessionPaymentSession?Payment provider session
orderOrder?Associated order
invoiceInvoice?Associated invoice
expiresAtDateTimeSession expiry
completedAtDateTime?Completion timestamp

PaymentSession

FieldTypeDescription
uidUUIDSession ID
providerStringProvider ID (e.g. stripe-payment-gateway)
statusREADY | PENDING | FAILEDPayment status
amountIntAmount in minor currency units (cents)
currencyStringISO currency code
providerRefString?Provider reference (e.g. Stripe PaymentIntent ID)
clientTokenString?Client-side token for embedded payment flows
paymentMethods[String]CARD, APPLE_PAY, GOOGLE_PAY, PAYPAL, KLARNA, AMAZON_PAY, LINK

ShippingOption

FieldTypeDescription
uidStringOption ID
displayNameStringDisplay name
amountIntCost in minor currency units (cents)

AddressInput

FieldType
line1String?
line2String?
cityString?
stateString?
postalCodeString?
countryString?