# Borkol Docs

> Documentation for the Borkol multi-tenant commerce platform: API reference and guides for merchants and integrators.

This file indexes the storefront API reference. Human-oriented merchant guides live at https://docs.borkol.com/docs (raw markdown per page at https://docs.borkol.com/docs/md/{chapter}/{page}).

## Getting Started

- [Introduction](https://docs.borkol.com/api/md/getting-started/index): What the Borkol storefront API is, its base URL and versioning, and a three-step quickstart.
- [Authentication](https://docs.borkol.com/api/md/getting-started/authentication): Tenant API keys, the bearer header, scopes, the /v1/api/me endpoint, and tenant suspension.
- [Errors and Rate Limits](https://docs.borkol.com/api/md/getting-started/errors-and-rate-limits): Every error envelope the storefront API returns, the 422 validation shape, rate limiting, and the pagination envelope.
- [Redirects and sitemap](https://docs.borkol.com/api/md/getting-started/seo): Resolve renamed paths to their new address, and list every live path of the enabled modules for a sitemap.
- [Business profile](https://docs.borkol.com/api/md/getting-started/business): Read the store's public business details, social links and content languages.
- [Changelog](https://docs.borkol.com/api/md/getting-started/changelog): Dated, newest-first record of every change to the public storefront API. Read this before upgrading an integration.

## Webhooks

- [Webhooks](https://docs.borkol.com/api/md/webhooks/index): Event notifications Borkol POSTs to your server, with the event catalog, delivery semantics, HMAC signature verification, and retry behavior.

## Catalog

- [Products](https://docs.borkol.com/api/md/catalog/products): List and fetch active products, including variants, images, categories, stock status, and customer-contextual pricing.
- [Categories](https://docs.borkol.com/api/md/catalog/categories): Fetch the tenant's full category tree as nested JSON.
- [Redirects and sitemap](https://docs.borkol.com/api/md/catalog/seo): Moved to Getting started. Redirects and sitemap are served by the platform for every module.

## Configurator

- [How the configurator works](https://docs.borkol.com/api/md/configurator/index): Concepts behind configurable products, the schema, and the pricing model.
- [Configuration schema](https://docs.borkol.com/api/md/configurator/schema): Fetch the complete configuration schema of a configurable product.
- [Price quote](https://docs.borkol.com/api/md/configurator/quote): Price a specific configuration of a configurable product and get a line-item breakdown.

## Carts & Checkout

- [Carts](https://docs.borkol.com/api/md/carts-and-checkout/carts): Create, read, and update carts, including ownership token semantics and the full cart response shape.
- [Cart lines](https://docs.borkol.com/api/md/carts-and-checkout/cart-lines): Add products to a cart, change line quantities, and remove lines, including variant, made-to-measure and decimal quantity rules.
- [Discount codes](https://docs.borkol.com/api/md/carts-and-checkout/discounts): Attach a discount code to a cart, understand lazy evaluation and error codes, and remove the code.
- [Shipping methods](https://docs.borkol.com/api/md/carts-and-checkout/shipping-methods): List the store's active shipping methods with the effective price for a specific cart.
- [Checkout](https://docs.borkol.com/api/md/carts-and-checkout/checkout): Convert an active cart into an order, with cart policy enforcement, price drift and stock conflicts, quote triggers, and idempotent replay.
- [Claiming a cart](https://docs.borkol.com/api/md/carts-and-checkout/claim): Attach a guest cart to a logged-in customer, merging any existing cart the customer already had.

## Orders & Quotes

- [Orders](https://docs.borkol.com/api/md/orders-and-quotes/orders): Read a single order, list a customer's order history, and the order status machine.
- [Quote requests](https://docs.borkol.com/api/md/orders-and-quotes/quote-requests): Submit a cart as a B2B quote request (RFQ), the quote status flow, and the customer-facing quote shape.
- [Quote tokens](https://docs.borkol.com/api/md/orders-and-quotes/quote-tokens): Fetch, accept, or decline an offered quote using the tokenized link from the offer email.

## Contacts

- [Contact accounts](https://docs.borkol.com/api/md/customers/index): How storefront contact accounts, session tokens, and the guest lifecycle work.
- [Registration and sessions](https://docs.borkol.com/api/md/customers/accounts): Register a contact account, log in for a session token, and log out.
- [Password reset](https://docs.borkol.com/api/md/customers/passwords): Request a password reset email and complete the reset with the emailed token.
- [Profile](https://docs.borkol.com/api/md/customers/profile): Read and update the authenticated contact's profile.
- [Addresses](https://docs.borkol.com/api/md/customers/addresses): List, create, update, and delete the authenticated contact's shipping, billing, and work addresses.

## Stock

- [Availability](https://docs.borkol.com/api/md/stock/availability): Read-only product and variant stock availability for the storefront.

## Objects

- [Objects](https://docs.borkol.com/api/md/objects/index): The generic content model behind the Objects module, including property types, publishing, addresses, media, sections values, and localization.
- [Types](https://docs.borkol.com/api/md/objects/types): List the store's object types and their property definitions.
- [Records](https://docs.borkol.com/api/md/objects/records): List records of an object type with sorting, search, and filters, and fetch single records by id or by address.

## Build a Storefront

- [End-to-end walkthrough](https://docs.borkol.com/api/md/storefront-guide/index): Build a complete custom storefront against the Borkol API, from API key to catalog, cart, checkout, orders, B2B quotes, customer accounts, and webhooks.
- [Storefront architecture](https://docs.borkol.com/api/md/storefront-guide/architecture): Recommended architecture for a custom storefront: server-side API key handling, a Next.js proxy layer, caching, error mapping, and idempotency.

## Forms

- [Forms](https://docs.borkol.com/api/md/forms/index): How a site loads a merchant's form, renders its steps and rules, uploads files and sends submissions from its server, with field kinds, rule semantics, spam checks, keys and limits.
- [Load a form](https://docs.borkol.com/api/md/forms/forms): Fetch the published version of an active form by its key, with every text resolved to one language.
- [Uploads](https://docs.borkol.com/api/md/forms/uploads): Store a visitor's file for a form's file field from your server and get a single-use token to send with the submission.
- [Submissions](https://docs.borkol.com/api/md/forms/submissions): Send a visitor's answers and upload tokens to an active form from your server, with the visitor IP header, honeypot, hourly limit, Turnstile, validation errors and the thank-you response.