Workflows
A workflow is the ordered sequence of Bagisto API calls a client fires to complete a feature — and which call depends on which. Each page shows the dependency flow as a diagram, then links the endpoint page backing every step. Bagisto has no server-side workflow primitive; "workflow" here means the client call-sequence, framework-agnostic.
How to read a workflow page
Every flow page uses the same blocks:
- Agent-ask inputs — values the agent must ask you for. Today that is the server URL and the storefront key.
- Prerequisites — what must exist first (key, cart token, auth).
- Dependency diagram — a Mermaid flow you can follow top to bottom.
- Ordered call table — step, endpoint (linked), what it depends on.
- End-to-end example — the happy path, REST and GraphQL.
- Customize — link to extend the flow.
Shop
| Workflow | What it builds |
|---|---|
| Build a Storefront | Catalog, cart, and checkout end to end |
| Cart | Guest/customer cart, add/update items, coupons, merge on login |
| Checkout | Addresses, shipping, payment methods, place order |
Admin
| Workflow | What it builds |
|---|---|
| Build an Admin Dashboard | The complete blueprint — every admin menu mapped to its API |
| Create-Order Flow | Placing an order for a customer (sequential draft-cart state machine) |
| Product Management | Create/edit products — 7 types, two-step create, image/inventory/price panels |
| Order Fulfillment Actions | Invoice, ship, refund, cancel — per-order eligibility guards |
| Customers (Impersonate & GDPR) | Impersonation token and GDPR delete/download flows |
| Marketing | Promotions, communications, search & SEO — rule reindex, campaigns, coupons, sitemaps |
| Configuration | Slug-scoped store settings via three generic endpoints |
Customization
Extending the API itself (adding or changing endpoints) — see Customization.
Every call below links to its REST endpoint page for concreteness. The sequence is transport-agnostic — the same flow works over GraphQL with the equivalent query or mutation, and each REST page cross-links to its GraphQL twin. Pick whichever transport your client uses; only the request shape changes, never the order of steps.
Building with an AI agent?
See Build with AI for the llms.txt index, the agent skills, and the optional docs MCP server.