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.

An order captures what was bought, by whom, and for how much.

​
How to use

Orders are a standalone primitive. You can use them as part of the Colossal platform — created automatically from a checkout, linked to a customer, and referencing the products that were purchased — or sync them to and from third-party systems like ERPs, fulfillment providers, or accounting tools to keep order data consistent across platforms.

​
Where to use

Actions

Actions for fetching, updating, and managing orders.

Tools

LLM-callable tools for reading and updating orders.

Storefront API

GraphQL queries for fetching orders on your storefront.

​
Order status

Order created. Payment not yet authorized.
Payment authorized and order accepted.
Order shipped or delivered.
Refund issued after confirmation. Can apply in full or in part.

​
Line items

Each order contains one or more line items, capturing the variant, SKU, quantity, unit price, and total at the time of purchase. Variant properties and product images are snapshotted on the line item, so the order remains accurate even if the product is later edited or archived.