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.

A customer is a buyer record in a project. Each customer has an email, a name, and a stable UUID.

​
How to use

Customers are a standalone primitive. You can use them as part of the Colossal platform — where carts, checkout, and invoices reference the same customer record — or sync them to and from third-party systems like your CRM or marketing tools to keep buyer data consistent across platforms.

​
Where to use

Actions

For App Action steps in your agent.

Tools

For the LLM inside an AI Reasoning step or the chat agent.

Storefront API

GraphQL queries and mutations for your storefront.

​
Addresses

Customers can have one or more saved addresses, each with an optional label like “Home” or “Office”, plus an is_default flag. A dedicated billing address can sit separately from the address list. The Customers API reference has the full address schema.

​
Guest vs registered customers

Not every buyer needs an account up front.
  • Registered. A customer record exists and is linked to the cart, checkout session, and resulting order.
  • Guest. A checkout session can be created with guest_email and guest_name instead of a customer ID. When a guest completes checkout, the system looks up or creates a customer record automatically using the provided email.
This means you can accept payments without requiring account creation first. See the checkout guide for implementation details.