# Kentro.io Documentation > Kentro developer center: guides, API references and AI tooling for building on Kentro. The Channel API connects sales channels to Kentro; the Store API powers custom storefronts on Kentro's buyer accounts, catalog, cart and checkout; Kentro Pixel collects first-party events with consent; Kentro MCP connects AI assistants to a workspace. ## Guides: Overview - [Kentro developer center](https://docs.kentro.io/docs/developer-center.md): Build on Kentro: connect sales channels, ERPs, warehouses, retailers and storefronts, measure with Kentro Pixel, and get help. ## Guides: Get started - [Core concepts](https://docs.kentro.io/docs/start-concepts.md): The ideas every Kentro integration relies on: tenants, sales channels, warehouses, documents and ids, environments and events. - [Environments](https://docs.kentro.io/docs/start-environments.md): Production and the sandbox: hosts, portals, what each environment holds, test data and what differs between them. - [API keys and scopes](https://docs.kentro.io/docs/start-api-keys.md): Create an API key in Kentro OS, give it only the scopes it needs, bind it to sales channels, and rotate or disable it safely. - [Authentication](https://docs.kentro.io/docs/start-authentication.md): Every way to authenticate to Kentro in one place: API key headers, bearer tokens, buyer and guest tokens, Pixel keys and OAuth for Kentro MCP. - [Make your first request](https://docs.kentro.io/docs/start-first-request.md): A first Channel API call, a dry-run write and a first Store API call against the sandbox, in cURL and Node. - [Errors, retries and rate limits](https://docs.kentro.io/docs/start-errors-limits.md): The error envelopes of both APIs side by side, which errors to retry, idempotency, rate limits and their headers. - [Security](https://docs.kentro.io/docs/start-security.md): How to handle Kentro credentials and data: secret storage, server-side rules, least privilege, tenant isolation and data protection. - [Go-live checklist](https://docs.kentro.io/docs/start-go-live.md): What to check before an integration or a custom storefront moves from the sandbox to production, and what to watch after. ## Guides: Integration guides - [Connect a sales channel](https://docs.kentro.io/docs/guide-sales-channel.md): Build a connector that keeps a marketplace, cart or B2B portal in step with Kentro: catalog, stock, orders, shipments, invoices and payments. - [Sync an ERP or accounting system](https://docs.kentro.io/docs/guide-erp-accounting.md): Keep an ERP or accounting system in step with Kentro: customers, products and costs, stock, invoices, payments and vendors. - [Fulfill as a warehouse or 3PL](https://docs.kentro.io/docs/guide-warehouse-3pl.md): Connect a WMS or 3PL to Kentro: receive fulfillment orders, report what shipped with tracking, and keep stock levels true. - [Handle retailer purchase orders](https://docs.kentro.io/docs/guide-retailer-edi.md): Bring retailer purchase orders into Kentro from EDI or a retailer portal, accept or reject them, then follow the sales order to shipment and invoice. - [Build a custom storefront](https://docs.kentro.io/docs/guide-custom-storefront.md): Run your own storefront UI on Kentro's storefront infrastructure: buyer sign-in, catalog, cart, quote, checkout, orders and account. - [Measure with Kentro Pixel](https://docs.kentro.io/docs/guide-measurement.md): Plan a Kentro Pixel rollout: browser events with consent, revenue from the server, signed-in identity, verification and destinations. ## Guides: Build with AI - [Build with AI](https://docs.kentro.io/docs/ai-overview.md): Use AI coding agents to build Kentro integrations, with docs, prompts, skills and MCP servers made for them. - [Prompt library](https://docs.kentro.io/docs/ai-prompts.md): Prompts to paste into an AI coding agent, one per Kentro project, each with the docs to read, the inputs, the rules and the acceptance checks. - [Instructions for AI agents](https://docs.kentro.io/docs/ai-agent-instructions.md): The rules an AI agent follows when it builds on Kentro: which API for which job, credentials, writes, money, pagination, errors and retries. - [Agent skills](https://docs.kentro.io/docs/ai-agent-skills.md): Install Kentro agent skills in Claude Code, Codex and Cursor so agents follow Kentro's rules when they write integration code. - [Docs for agents](https://docs.kentro.io/docs/ai-docs-for-agents.md): Give an AI agent current Kentro docs through llms.txt, Markdown versions of every page and the AI menu on guide pages. ## Guides: Kentro MCP - [Kentro MCP](https://docs.kentro.io/docs/mcp-overview.md): Connect Claude, Claude Code or Codex to Kentro Assistant so an AI client can work with your workspace's data, with your permissions. - [Connect Claude](https://docs.kentro.io/docs/mcp-connect-claude.md): Add Kentro MCP to Claude on the web or Claude desktop as a custom connector, then approve the connection in Kentro. - [Connect Claude Code, Codex and other clients](https://docs.kentro.io/docs/mcp-connect-coding-agents.md): Add Kentro MCP to Claude Code or Codex with one command, and check whether another MCP client can connect. - [Tools and permissions](https://docs.kentro.io/docs/mcp-tools-permissions.md): The tools Kentro MCP exposes, how they follow your role and permissions, the built-in prompts and example requests. - [Security and data](https://docs.kentro.io/docs/mcp-security.md): How Kentro MCP signs clients in, how its tokens work, how to revoke a connection, what data leaves Kentro and the limits. ## Guides: Resources - [Support](https://docs.kentro.io/docs/resources-support.md): Where to get help with Kentro's APIs, what to include so a request can be traced, and where notices come from. - [Developer changelog](https://docs.kentro.io/docs/resources-changelog.md): Developer-facing changes across Kentro's APIs and documentation, dated and newest first, with what an integration has to do. - [Glossary](https://docs.kentro.io/docs/resources-glossary.md): The terms used across Kentro's developer center and API references, each defined in a sentence, with where to read more. ## API Reference: Overview - [Kentro API reference](https://docs.kentro.io/reference/kentro-api-overview.md): The Channel API, the Store API and Kentro Pixel: what each one is for, how authentication works and where to get help. ## API Reference: Channel API - [Getting started](https://docs.kentro.io/reference/channel-api-getting-started.md): Create an API key, pick the base URL, make the first call. - [Authentication and scopes](https://docs.kentro.io/reference/channel-api-authentication.md): API key headers, the bearer token flow, scopes and channel bindings. - [Requests and responses](https://docs.kentro.io/reference/channel-api-conventions.md): Ids, money, dates, envelopes, duplicates, pagination, idempotency, errors, rate limits, dry runs and historical imports. - [Common flows](https://docs.kentro.io/reference/channel-api-flows.md): An order from import to payment, step by step, with bodies. - [Changelog](https://docs.kentro.io/reference/channel-api-changelog.md): What changed on the Channel API and its reference. - service - [Reachability check, no credentials](https://docs.kentro.io/reference/service-ping.md): Answers `{ "ok": true, "service": "channel-api" }`. The only route that needs no API key. - channels - [List the sales channels the caller may write into, newest first](https://docs.kentro.io/reference/channels-list.md): **Scope:** `channel:read`, `channel:write`, `orders:write`, `customers:write`, `products:write`, `shipments:write`, `invoices:write`, `payments:write`, `fulfillment:write`, `purchase-orders:write` or… - customers - [Create a customer, or update / skip the one it duplicates](https://docs.kentro.io/reference/customers-create.md): Duplicates are looked up in the sales channel by id, externalId, email, then phone digits. onDuplicate (default 'update') decides: 201 created, 200 updated or skipped, 409 duplicate; an inactive… - [List customers, newest first (cursor pagination)](https://docs.kentro.io/reference/customers-list.md): **Scope:** `channel:read`, `channel:write`, `customers:write` or `admin`. **Idempotency:** not keyed; the request itself is safe to repeat. **Rate limit:** read class, 6,000 requests per minute per… - [Read one customer by uuid, 24-hex id, or ext::](https://docs.kentro.io/reference/customers-get.md): **Scope:** `channel:read`, `channel:write`, `customers:write` or `admin`. **Idempotency:** not keyed; the request itself is safe to repeat. **Rate limit:** read class, 6,000 requests per minute per… - [Update a customer (only the fields sent; optimistic version); 200 unchanged when nothing differs](https://docs.kentro.io/reference/customers-update.md): **Scope:** `customers:write`, `channel:write` or `admin`. **Idempotency:** send `Idempotency-Key`; a retry with the same key replays the first answer. **Rate limit:** write class, 1,200 requests… - [Delete a customer; answers the document as it was](https://docs.kentro.io/reference/customers-delete.md): **Scope:** `customers:write`, `channel:write` or `admin`. **Idempotency:** send `Idempotency-Key`; a retry with the same key replays the first answer. **Rate limit:** write class, 1,200 requests… - [Add a credit to the customer's balance (a referral payout or store credit); Kentro services only](https://docs.kentro.io/reference/customers-credits-create.md): Writes one customer_credits row and its customer_payments row of type credit (method referral-credit or store-credit, the negative amount), then the customer-credit.created and credit-added events.… - products - [Create a product, or update / skip the one it duplicates](https://docs.kentro.io/reference/products-create.md): The duplicate is the body id, else the channel identity (externalId: the variant id order lines carry for a simple product, the channel product id for a product with variants), else the SKU of a… - [List products and group containers, newest first (cursor pagination)](https://docs.kentro.io/reference/products-list.md): **Scope:** `channel:read`, `channel:write`, `products:write` or `admin`. **Idempotency:** not keyed; the request itself is safe to repeat. **Rate limit:** read class, 6,000 requests per minute per… - [Read one product by uuid, 24-hex id, or ext::](https://docs.kentro.io/reference/products-get.md): Without include the whole document (variants, identifiers, listings); include= narrows the expansions. **Scope:** `channel:read`, `channel:write`, `products:write` or `admin`. **Idempotency:** not… - [Update a product (only the fields sent; optimistic version); 200 unchanged when nothing differs](https://docs.kentro.io/reference/products-update.md): **Scope:** `products:write`, `channel:write` or `admin`. **Idempotency:** send `Idempotency-Key`; a retry with the same key replays the first answer. **Rate limit:** write class, 1,200 requests per… - [Delete a product, or retire it when history references it; answers the document as it was](https://docs.kentro.io/reference/products-delete.md): A product with stock is refused (409 state_conflict). A product (or variant) that order, fulfillment, shipment, invoice, purchase-order or stock history references is RETIRED instead of deleted: its… - [Set a product's SKU, barcode, external identifiers and channel identities](https://docs.kentro.io/reference/products-identifiers.md): A channel named in channels has its identities replaced by the list sent ([] removes them); other channels keep theirs. **Scope:** `products:write`, `channel:write` or `admin`. **Idempotency:**… - [Upsert or remove a product's listings per sales channel (a group container fans out to its variants)](https://docs.kentro.io/reference/products-listings.md): **Scope:** `products:write`, `channel:write` or `admin`. **Idempotency:** send `Idempotency-Key`; a retry with the same key replays the first answer. **Rate limit:** write class, 1,200 requests per… - [Apply prices and a price list to a product's listings, synchronously](https://docs.kentro.io/reference/products-price-list.md): Each channel's price is the one sent, else the listing's stored price, adjusted by the price list when one is named. At most 500 listings (variants x channels) per request; more is 400… - [Set a product's units on hand per location and lot, absolutely, through the inventory kernel](https://docs.kentro.io/reference/products-inventory-levels.md): Each level sets onHand (available + allocated + on hold) at a location (a warehouseId addresses its floor location) for one lot (lotNumber or lotId; neither: the stock without a lot). The whole… - catalog - [The sellable products listed on a sales channel, priced (cursor pagination)](https://docs.kentro.io/reference/catalog-list.md): **Scope:** `channel:read`, `channel:write`, `products:write` or `admin`. **Idempotency:** not keyed; the request itself is safe to repeat. **Rate limit:** read class, 6,000 requests per minute per… - inventory - [Append historical stock ledger rows (stock_logs) in a batch; no counter moves, no event](https://docs.kentro.io/reference/inventory-history.md): Up to 500 entries, ONE insert in one transaction. Each entry is a movement that already happened in the source system: a ledger row is written with the entry's occurredAt as its timestamp, its… - orders - [Create an order (or update, skip or refuse the one it duplicates)](https://docs.kentro.io/reference/orders-create.md): Customer by { id }, { externalId } or an inline document (upserted like POST /v1/customers). Lines resolve their product by id, externalId in the channel, sku, barcode; compositions expand into their… - [List orders, newest first (cursor pagination)](https://docs.kentro.io/reference/orders-list.md): **Scope:** `channel:read`, `channel:write`, `orders:write` or `admin`. A permission group made before the Channel API scopes existed grants it as `orders:manage`. **Idempotency:** not keyed; the… - [Read one order by uuid, 24-hex id, or ext::](https://docs.kentro.io/reference/orders-get.md): **Scope:** `channel:read`, `channel:write`, `orders:write` or `admin`. A permission group made before the Channel API scopes existed grants it as `orders:manage`. **Idempotency:** not keyed; the… - [Update an order: absent fields keep their value; send `version` for optimistic concurrency](https://docs.kentro.io/reference/orders-update.md): Only what differs is written (outcome unchanged when nothing does: nothing written, nothing emitted). `items` is the whole line set with `totals` (checked as on create: 422 totals_mismatch); a line… - [Delete an order and everything that belongs to it (amendment 23)](https://docs.kentro.io/reference/orders-delete.md): Refused (409 state_conflict) when shipments or captured payments exist, or a purchase order was accepted into it: cancel it instead. Otherwise one unit removes its fulfillment orders (open… - [Cancel an order: its open fulfillment orders, unpaid invoices and unapplied payments with it](https://docs.kentro.io/reference/orders-cancel.md): One unit: every open fulfillment order canceled (its open reservation released), every unpaid invoice and unapplied payment canceled, the order canceled. Paid invoices and applied payments stay as… - [Accept a stock-review order: it continues as received (KNT-42)](https://docs.kentro.io/reference/orders-stock-review-accept.md): One unit: status received, order.created and order-created, the fulfillment orders a create would have generated (their reservations), and with invoicing.generateInvoice the order invoice with the… - [Reject a stock-review order: status stock-rejected (KNT-42)](https://docs.kentro.io/reference/orders-stock-review-reject.md): Status stock-rejected and order-stock-rejected; no invoice, fulfillment order or payment changes (a charge is refunded as a refund payment). Refused (409 state_conflict) unless the order is in stock… - fulfillment-orders - [Route the order's open lines into fulfillment orders](https://docs.kentro.io/reference/fulfillment-orders-generate.md): Routes every open order line that no open fulfillment order covers (manual warehouse pin, the channel routing rules, the channel's own fulfillment orders in the body, else default routing), one… - [Read one fulfillment order by uuid, 24-hex id, or ext::](https://docs.kentro.io/reference/fulfillment-orders-get.md): **Scope:** `channel:read`, `channel:write`, `fulfillment:write` or `admin`. A permission group made before the Channel API scopes existed grants it as `fulfillment-orders:manage`. **Idempotency:**… - [Delete an open fulfillment order nothing was fulfilled from](https://docs.kentro.io/reference/fulfillment-orders-delete.md): Releases its open reservation and removes it; answers the fulfillment order as it was. Closed, canceled or anything shipped: 409. **Scope:** `fulfillment:write`, `channel:write` or `admin`. A… - [Update a fulfillment order: dates, holds, carrier preselection, warehouse, line quantities](https://docs.kentro.io/reference/fulfillment-orders-update.md): Send `version` for optimistic concurrency (409 version_conflict on a stale one). Line quantities are totals and stay within the order line's open quantity and at or above what was fulfilled; the… - [List fulfillment orders, newest first (cursor pagination)](https://docs.kentro.io/reference/fulfillment-orders-list.md): **Scope:** `channel:read`, `channel:write`, `fulfillment:write` or `admin`. A permission group made before the Channel API scopes existed grants it as `fulfillment-orders:manage`. **Idempotency:**… - [Create a channel's or a 3PL's fulfillment order for an order's open lines](https://docs.kentro.io/reference/fulfillment-orders-create.md): Creates one fulfillment order for the named open order lines (each quantity at most what no open fulfillment order covers; 409 exceeds_open_quantity otherwise) and reserves its open quantity at its… - [Cancel a fulfillment order; its open reservation is released](https://docs.kentro.io/reference/fulfillment-orders-cancel.md): Releases exactly the open quantity the fulfillment order holds (a smaller reservation is released as far as it goes, with a reservation_short warning) and never what was shipped. Already canceled:… - [Move a fulfillment order to another warehouse (and location); its reservation moves with it](https://docs.kentro.io/reference/fulfillment-orders-reroute.md): Releases the open reservation at the old queue and reserves it at the new warehouse queue in one transaction. An external, tenant-portal or 3PL fulfillment order takes the routing of the new… - [Credit shipped units to a fulfillment order (the credit step: bin to queue)](https://docs.kentro.io/reference/fulfillment-orders-fulfill.md): Credits each line by the shipped quantity (at most its open quantity), rolls the fulfillment order and order statuses up, credits the order lines, and moves the stock from the source bin (the item's,… - [Reconcile the fulfillment orders of this fulfillment order's order with the order's routing, in place](https://docs.kentro.io/reference/fulfillment-orders-refresh.md): Routes the open order lines again and reconciles every open fulfillment order by route key (fulfill by, type, warehouse, vendor, adapter): matched ones are adjusted to the open quantities, unmatched… - [Re-send a pending, adapter-routed fulfillment order to its 3PL](https://docs.kentro.io/reference/fulfillment-orders-resubmit.md): Marks the submission pending and queues the 3PL adapters' fulfillment-order-created message (delayed export bypassed), published after the commit. Refused (409) when the fulfillment order or its… - [Reconcile an order's fulfillment orders with the order's routing, in place (addressed by the order)](https://docs.kentro.io/reference/fulfillment-orders-order-refresh.md): The refresh of POST /v1/fulfillment-orders/:id/refresh addressed by the order itself: routes the open order lines again and reconciles every open fulfillment order by route key (matched ones adjusted… - [Cancel an order's fulfillment orders without canceling the order](https://docs.kentro.io/reference/fulfillment-orders-order-cancel.md): Selects the order's fulfillment orders oldest first (created, then id), at most `limit` (default every one), and cancels the open ones: each releases exactly its open reservation (reservation_short… - [Delete an order's untouched open fulfillment orders without deleting the order](https://docs.kentro.io/reference/fulfillment-orders-order-delete.md): Selects the order's fulfillment orders oldest first (created, then id), at most `limit` (default every one), and deletes them in one transaction by the delete rules: a selected one that is closed,… - [Credit shipped units to the order's only fulfillment order](https://docs.kentro.io/reference/fulfillment-orders-order-fulfill.md): The credit step of POST /v1/fulfillment-orders/:id/fulfill addressed by the order: its only fulfillment order (404 when it has none, 409 multiple_fulfillment_orders when it has several: address one… - [Move the order's only fulfillment order to another warehouse (and location)](https://docs.kentro.io/reference/fulfillment-orders-order-reroute.md): The reroute of POST /v1/fulfillment-orders/:id/reroute addressed by the order: its only fulfillment order (404 when it has none, 409 multiple_fulfillment_orders when it has several: address one by… - fulfillment-queue - [The orders waiting to ship, with their shippable fulfillment orders (cursor; never a count)](https://docs.kentro.io/reference/fulfillment-queue-list.md): An order is in the queue when it is pending or partly fulfilled, not canceled, not hidden from the queue, not escalated, has no shipment confirmation in flight and was created within a year, and when… - [Bounded counts of the queue: pending, partly fulfilled, total, shipped today](https://docs.kentro.io/reference/fulfillment-queue-stats.md): Every count stops at 10000 and says so (capped: true). The filters are the list's. shippedToday counts the shipments recorded on the caller day (timezone, default UTC), canceled ones excluded. No… - [One order's queue detail: the queue document (order, fulfillment orders, the lines to pack)](https://docs.kentro.io/reference/fulfillment-queue-detail.md): The fulfillment-queue detail document of the order named by uuid, 24-hex id or ext:: (the channel's sales order): the populated order, every fulfillment order (oldest first, at… - [Record shipments of queue fulfillment orders (batch, one result per entry)](https://docs.kentro.io/reference/fulfillment-queue-ship.md): Up to 100 entries, each a shipment the caller already made of one shippable fulfillment order, recorded through the shipments create unit (rows, credits, stock move, facts and messages in one… - shipments - [Record a shipment the channel or the 3PL made (create, or update by externalId)](https://docs.kentro.io/reference/shipments-create.md): Records what shipped for an order (orderId) or one of its fulfillment orders (fulfillmentOrderId), in one transaction: the shipping log and its lines, the fulfillment-order and order credits, and the… - [List shipments, newest first (cursor pagination)](https://docs.kentro.io/reference/shipments-list.md): **Scope:** `channel:read`, `channel:write`, `shipments:write` or `admin`. **Idempotency:** not keyed; the request itself is safe to repeat. **Rate limit:** read class, 6,000 requests per minute per… - [Read one shipment by uuid, 24-hex id, or ext::](https://docs.kentro.io/reference/shipments-get.md): **Scope:** `channel:read`, `channel:write`, `shipments:write` or `admin`. **Idempotency:** not keyed; the request itself is safe to repeat. **Rate limit:** read class, 6,000 requests per minute per… - [Update a shipment: carrier, tracking, package, money, notes; increased item quantities are shipped](https://docs.kentro.io/reference/shipments-update.md): Absent fields are kept. Send `version` for optimistic concurrency (409 version_conflict on a stale one). `items`, when sent, is the full list: an increase is credited and its stock moved in the same… - [Delete a shipment: cancel's reversal, then the row is removed](https://docs.kentro.io/reference/shipments-delete.md): Answers the shipment as it was. An already canceled shipment is removed without reversing anything again. **Scope:** `shipments:write`, `channel:write` or `admin`. **Idempotency:** send… - [The shipment's stored tracking (never fetched from a carrier)](https://docs.kentro.io/reference/shipments-tracking.md): **Scope:** `channel:read`, `channel:write`, `shipments:write` or `admin`. **Idempotency:** not keyed; the request itself is safe to repeat. **Rate limit:** read class, 6,000 requests per minute per… - [Cancel a shipment: reverses exactly what it recorded](https://docs.kentro.io/reference/shipments-cancel.md): Lowers the fulfillment-order and order credits the shipment wrote, returns to the source location exactly what its stock movements took (never more), and reserves again at most what they released… - invoices - [Create an invoice, or update the one with the same externalId (or displayId) in the channel](https://docs.kentro.io/reference/invoices-create.md): type charge or refund (amounts are magnitudes either way). order and customer by { id } or { externalId } in the channel; a line names the order line it bills (orderLineId, externalLineId, product)… - [List invoices, newest first (cursor pagination)](https://docs.kentro.io/reference/invoices-list.md): **Scope:** `channel:read`, `channel:write`, `invoices:write` or `admin`. A permission group made before the Channel API scopes existed grants it as `invoices:manage`. **Idempotency:** not keyed; the… - [Read one invoice by uuid, 24-hex id, or ext::](https://docs.kentro.io/reference/invoices-get.md): **Scope:** `channel:read`, `channel:write`, `invoices:write` or `admin`. A permission group made before the Channel API scopes existed grants it as `invoices:manage`. **Idempotency:** not keyed; the… - [Update an invoice (absent fields keep their value; send version for optimistic concurrency)](https://docs.kentro.io/reference/invoices-update.md): A money change (items, discounts, totals) sends totals and is refused on an invoice with payments. Order, customer of an order invoice, type and display id never change. **Scope:** `invoices:write`,… - [Delete an invoice (refused with payments, when paid, or for a refund of an order); answers the invoice as it was](https://docs.kentro.io/reference/invoices-delete.md): **Scope:** `invoices:write`, `channel:write` or `admin`. A permission group made before the Channel API scopes existed grants it as `invoices:manage`. **Idempotency:** send `Idempotency-Key`; a… - [Cancel an invoice (refused with payments or a live provider payment request)](https://docs.kentro.io/reference/invoices-cancel.md): **Scope:** `invoices:write`, `channel:write` or `admin`. A permission group made before the Channel API scopes existed grants it as `invoices:manage`. **Idempotency:** send `Idempotency-Key`; a… - [Invoice an order's lines (charge or refund)](https://docs.kentro.io/reference/invoices-from-order.md): Without items: every line's remaining quantity (refund: every invoiced and not yet refunded quantity), with what remains of the order's charges. With items: those lines, never beyond what remains… - payments - [Record a payment and apply it, or update the one with the same externalId in the channel](https://docs.kentro.io/reference/payments-create.md): method and amount (a magnitude; type refund for money out). order and/or invoice by { id } or { externalId } in the channel. application (default auto) applies what fits: the named invoice, the… - [List payments, newest first (cursor pagination)](https://docs.kentro.io/reference/payments-list.md): **Scope:** `channel:read`, `channel:write`, `payments:write` or `admin`. A permission group made before the Channel API scopes existed grants it as `payments:manage`. **Idempotency:** not keyed; the… - [Read one payment with its applications by uuid, 24-hex id, or ext::](https://docs.kentro.io/reference/payments-get.md): **Scope:** `channel:read`, `channel:write`, `payments:write` or `admin`. A permission group made before the Channel API scopes existed grants it as `payments:manage`. **Idempotency:** not keyed; the… - [Update a payment (absent fields keep their value; send version for optimistic concurrency)](https://docs.kentro.io/reference/payments-update.md): The amount may change down to what is applied; the method only while nothing is applied. Type, currency and order never change. **Scope:** `payments:write`, `channel:write` or `admin`. A permission… - [Unapply everything and delete the payment; answers the payment as it was](https://docs.kentro.io/reference/payments-delete.md): **Scope:** `payments:write`, `channel:write` or `admin`. A permission group made before the Channel API scopes existed grants it as `payments:manage`. **Idempotency:** send `Idempotency-Key`; a… - [Apply what the payment has unapplied (auto by default, or manual invoice amounts)](https://docs.kentro.io/reference/payments-apply.md): **Scope:** `payments:write`, `channel:write` or `admin`. A permission group made before the Channel API scopes existed grants it as `payments:manage`. **Idempotency:** send `Idempotency-Key`; a… - [Remove applications of the payment (every one, or by application or invoice id)](https://docs.kentro.io/reference/payments-unapply.md): **Scope:** `payments:write`, `channel:write` or `admin`. A permission group made before the Channel API scopes existed grants it as `payments:manage`. **Idempotency:** send `Idempotency-Key`; a… - [Remove ONE application, addressed by its own id](https://docs.kentro.io/reference/payments-unapply-application.md): The application's payment is unapplied by exactly that application (POST /v1/payments/:id/unapply with applicationIds [id]): the order and invoice it paid roll back by its amount. An application that… - [Unapply everything and cancel the payment (refused for a payment Kentro charged)](https://docs.kentro.io/reference/payments-cancel.md): **Scope:** `payments:write`, `channel:write` or `admin`. A permission group made before the Channel API scopes existed grants it as `payments:manage`. **Idempotency:** send `Idempotency-Key`; a… - [The provider declined a bank debit Kentro charged: unapply everything, cancel with no refund, re-pause the order](https://docs.kentro.io/reference/payments-decline.md): Kentro services only (403 otherwise). Only an applied internal bank charge with a provider transaction (createdSource internally); any other payment is 409 state_conflict. The order and its open… - purchase-orders - [Record a retailer's purchase order, or apply onDuplicate to the one with its externalId in the channel](https://docs.kentro.io/reference/purchase-orders-create.md): The retailer's PO identity is externalId within the channel: a transaction advisory lock on it is taken before the lookup, so concurrent deliveries resolve to one purchase order. onDuplicate update… - [List purchase orders, newest first (cursor pagination)](https://docs.kentro.io/reference/purchase-orders-list.md): **Scope:** `channel:read`, `channel:write`, `purchase-orders:write` or `admin`. **Idempotency:** not keyed; the request itself is safe to repeat. **Rate limit:** read class, 6,000 requests per… - [Read one purchase order by uuid, 24-hex id, or ext::](https://docs.kentro.io/reference/purchase-orders-get.md): **Scope:** `channel:read`, `channel:write`, `purchase-orders:write` or `admin`. **Idempotency:** not keyed; the request itself is safe to repeat. **Rate limit:** read class, 6,000 requests per… - [Update a purchase order (only the fields sent; optimistic version); 200 unchanged when nothing differs](https://docs.kentro.io/reference/purchase-orders-update.md): **Scope:** `purchase-orders:write`, `channel:write` or `admin`. **Idempotency:** send `Idempotency-Key`; a retry with the same key replays the first answer. **Rate limit:** write class, 1,200… - [Delete a purchase order and its lines; answers the document as it was; an accepted one is 409](https://docs.kentro.io/reference/purchase-orders-delete.md): **Scope:** `purchase-orders:write`, `channel:write` or `admin`. **Idempotency:** send `Idempotency-Key`; a retry with the same key replays the first answer. **Rate limit:** write class, 1,200… - [Accept a purchase order: its sales order is created in the same transaction; a second accept answers the same order](https://docs.kentro.io/reference/purchase-orders-accept.md): Every line must name a product (422 unresolved_reference otherwise). The order is created through the orders create unit (lines, totals, tagging rules), then the purchase order is marked accepted… - [Reject a purchase order (the 855 reject follows); unchanged when already rejected](https://docs.kentro.io/reference/purchase-orders-reject.md): **Scope:** `purchase-orders:write`, `channel:write` or `admin`. **Idempotency:** send `Idempotency-Key`; a retry with the same key replays the first answer. **Rate limit:** write class, 1,200… - [Cancel a purchase order; unchanged when already cancelled; an accepted one is 409 (cancel its sales order)](https://docs.kentro.io/reference/purchase-orders-cancel.md): **Scope:** `purchase-orders:write`, `channel:write` or `admin`. **Idempotency:** send `Idempotency-Key`; a retry with the same key replays the first answer. **Rate limit:** write class, 1,200… - outgoing-purchase-orders - [List the purchase orders sent to vendors (stage, vendor, warehouse, search; cursor pagination)](https://docs.kentro.io/reference/outgoing-purchase-orders-list.md): One card per purchase order: its stage, vendor, ship-to warehouse, ETA, whether it is late, units ordered, shipped, received and still to come (`openUnits`), its total, what it costs in the end… - [Create a draft purchase order for a vendor; `send: true` creates and sends it](https://docs.kentro.io/reference/outgoing-purchase-orders-create.md): Defaults: the PO number is the generated PO id, the currency is the one of the internal channel, the ship-to address is the warehouse's, the bill-to address is the company's, the payment terms are… - [Count purchase orders per stage, with what is open, on the way, arriving soon, late and owed](https://docs.kentro.io/reference/outgoing-purchase-orders-summary.md): The same stage, ETA and late rules as the list. `arrivingSoon` counts the purchase orders the list answers for `arrivingWithinDays=14`: open, with an ETA between now and 14 days from now.… - [Read one purchase order: every line, shipments, payments, receipts and the actions allowed now](https://docs.kentro.io/reference/outgoing-purchase-orders-get.md): All lines are answered (never capped). `allowedActions` is decided by the server from the stage, what was received, what was paid, the limits and whether the purchase order was exported to… - [Update a purchase order (only the fields sent; `items` replaces the line set); 200 unchanged when nothing differs](https://docs.kentro.io/reference/outgoing-purchase-orders-update.md): A line of `items` with an `id` keeps that line; a line without one is new; a stored line that is not sent is removed. A line cannot be removed, change product or go below what was received or shipped… - [Delete a draft that was never sent; answers the document as it was](https://docs.kentro.io/reference/outgoing-purchase-orders-delete.md): A purchase order that was sent is cancelled instead (409 here), also one that is a draft again after it was sent: its `allowedActions` offer `cancel`, never `delete`. **Scope:**… - [Send a draft (or approve and send one waiting for approval) to the vendor](https://docs.kentro.io/reference/outgoing-purchase-orders-send.md): Needs a ship-to warehouse with a queue location and at least one line (409 otherwise). The purchase order becomes ordered, incoming stock is reserved at the warehouse queue per product line (a charge… - [Submit a draft for approval: it is assigned to the approver, who is emailed](https://docs.kentro.io/reference/outgoing-purchase-orders-submit.md): **Scope:** `outgoing-purchase-orders:write`, `channel:write` or `admin`. A permission group made before the Channel API scopes existed grants it as `inventory:manage` or `supply-chain:manage`.… - [Send a purchase order waiting for approval back to draft: its owner is emailed the reason](https://docs.kentro.io/reference/outgoing-purchase-orders-reject.md): **Scope:** `outgoing-purchase-orders:write`, `channel:write` or `admin`. A permission group made before the Channel API scopes existed grants it as `inventory:manage` or `supply-chain:manage`.… - [Record that the vendor confirmed the order (when, the ready-to-ship date, the vendor reference)](https://docs.kentro.io/reference/outgoing-purchase-orders-confirm.md): For a purchase order that was sent and is not fully received. `confirmedAt` defaults to now the first time; a second call updates the dates; 200 unchanged when nothing differs. **Scope:**… - [Record a payment to the vendor (deposit, balance, payment or refund)](https://docs.kentro.io/reference/outgoing-purchase-orders-add-payment.md): The balance due is what the purchase order costs in the end (`payableTotal`: its total; what was received plus its charges once it is closed short; 0 once it is cancelled) minus what was paid (a… - [Remove a recorded payment; the balance due and the financial status are recomputed](https://docs.kentro.io/reference/outgoing-purchase-orders-remove-payment.md): For an entry recorded by mistake, also on a cancelled purchase order (the record has to say what really happened to the money). The balance due is counted again as `payableTotal` minus what is still… - [Close a partly received purchase order short: the rest will not come](https://docs.kentro.io/reference/outgoing-purchase-orders-close.md): The incoming stock still reserved for the units that will not come is released and the purchase order is received. From then on it owes for what it received, not for what it ordered: `payableTotal`… - [Cancel a purchase order nothing was received against](https://docs.kentro.io/reference/outgoing-purchase-orders-cancel.md): A sent purchase order releases its incoming stock reservations and its vendor contacts are emailed unless `notifyVendor` is false. A draft is cancelled without an email; one that was sent before can… - [Add a vendor shipment: what left the vendor, when, how, and when it is expected](https://docs.kentro.io/reference/outgoing-purchase-orders-add-shipment.md): For a purchase order that was sent and is not fully received. Without `items` every quantity that has not shipped yet ships (ordered minus already shipped, product lines only); with `items` the lines… - [Update a vendor shipment (only the fields sent; null clears; `arrivedAt` marks its arrival); 200 unchanged when nothing differs](https://docs.kentro.io/reference/outgoing-purchase-orders-update-shipment.md): For any purchase order that is not cancelled. `items`, when sent, replaces the lines of the shipment. The shipped quantities and statuses of the lines, the vendor shipping status and the expected… - [Remove a vendor shipment; shipped quantities, the vendor shipping status and the expected date are recomputed](https://docs.kentro.io/reference/outgoing-purchase-orders-remove-shipment.md): For any purchase order that is not cancelled. With its last shipment removed a purchase order is pending again. **Scope:** `outgoing-purchase-orders:write`, `channel:write` or `admin`. A permission… - [Receive units of a purchase order into locations; the `Idempotency-Key` header is required](https://docs.kentro.io/reference/outgoing-purchase-orders-receive.md): For a purchase order that was sent (also one that is already received: receiving more than ordered is allowed). Each item names its line (`lineId`), its product (`productId`) or both; a product is… - vendors - [Create a vendor, or update / skip the one with the same externalId](https://docs.kentro.io/reference/vendors-create.md): A vendor belongs to the tenant (no sales channel); its identity is externalId. Without one a POST always creates. onDuplicate (default 'update') decides: 201 created, 200 updated, unchanged or… - [List vendors, newest first (cursor pagination)](https://docs.kentro.io/reference/vendors-list.md): Filters: externalId (exact), type, isActive, q (a case-insensitive name prefix), updatedSince. **Scope:** `channel:read`, `channel:write`, `products:write` or `admin`. **Idempotency:** not keyed;… - [Read one vendor by uuid or 24-hex id](https://docs.kentro.io/reference/vendors-get.md): Vendors have no channel, so there is no ext: form: look a vendor up by external id with GET /v1/vendors?externalId=. **Scope:** `channel:read`, `channel:write`, `products:write` or `admin`.… - [Update a vendor (only the fields sent; optimistic version); 200 unchanged when nothing differs](https://docs.kentro.io/reference/vendors-update.md): **Scope:** `products:write`, `channel:write` or `admin`. **Idempotency:** send `Idempotency-Key`; a retry with the same key replays the first answer. **Rate limit:** write class, 1,200 requests per… - [Delete a vendor and its contacts; answers the document as it was](https://docs.kentro.io/reference/vendors-delete.md): A vendor a warehouse or a location still references is not deleted: 409 state_conflict. **Scope:** `products:write`, `channel:write` or `admin`. **Idempotency:** send `Idempotency-Key`; a retry… - operations - [Read the status of an async operation](https://docs.kentro.io/reference/operations-get.md): **Scope:** `channel:read`, `channel:write`, `orders:write`, `customers:write`, `products:write`, `shipments:write`, `invoices:write`, `payments:write`, `fulfillment:write`, `purchase-orders:write` or… - [Read one chunk of the documents an import operation was given](https://docs.kentro.io/reference/operations-input.md): **Scope:** `channel:read`, `channel:write`, `orders:write`, `customers:write`, `products:write`, `shipments:write`, `invoices:write`, `payments:write`, `fulfillment:write`, `purchase-orders:write` or… - [Import orders asynchronously (202; poll GET /v1/operations/:id)](https://docs.kentro.io/reference/orders-import.md): **Scope:** `orders:write`, `channel:write` or `admin`. A permission group made before the Channel API scopes existed grants it as `orders:manage`. **Idempotency:** send `Idempotency-Key`; a retry… - [Import products asynchronously (202; poll GET /v1/operations/:id)](https://docs.kentro.io/reference/products-import.md): **Scope:** `products:write`, `channel:write` or `admin`. **Idempotency:** send `Idempotency-Key`; a retry with the same key replays the first answer. **Rate limit:** write class, 1,200 requests per… - batch - [Run up to 100 v1 operations as one request (non-atomic)](https://docs.kentro.io/reference/batch-execute.md): Each operation is dispatched to its own route with the caller identity, so scopes, rate limits (every operation counts), idempotency keys, kill switches and transactions apply per operation. One… ## API Reference: Store API - [Getting started](https://docs.kentro.io/reference/store-api-getting-started.md): Which API is which, what a custom storefront is, the prerequisites in Kentro OS, the base URLs and the first call. - [Authentication](https://docs.kentro.io/reference/store-api-authentication.md): The API key, the buyer token, the guest token, the headers, token lifetimes, password reset, sign-up and the tenant guard. - [Requests and responses](https://docs.kentro.io/reference/store-api-conventions.md): Operations and bodies, answer shapes, cart revisions, guest and buyer carts, money, the error envelope and its codes, caching and rate limits. - [A buyer's journey](https://docs.kentro.io/reference/store-api-flows.md): Store, catalog, sign-in, cart, quote, checkout, orders, invoices, account, applications and subscriptions, step by step, with bodies. - [Changelog](https://docs.kentro.io/reference/store-api-changelog.md): What changed on the Store API and its reference. - store - [Read the published store](https://docs.kentro.io/reference/store-get.md): The store the host resolves to: name, branding and theme, access rules (public, invite or approval; guest checkout and visible prices), fulfillment methods and locations, currency and minimum order,… - session - [Read who the request acts for](https://docs.kentro.io/reference/session-get.md): The identity behind the tokens sent: the signed-in buyer (id, email, name, whether the account is confirmed) or a guest or anonymous visitor (`authenticated: false`). Use it to render the account… - [Start a guest session](https://docs.kentro.io/reference/session-guest.md): Issues a guest token for an anonymous visitor. Store it with the visitor (a cookie your storefront owns) and send it as `X-Storefront-Guest` on every later call: it identifies the guest cart and a… - [Sign a new buyer up](https://docs.kentro.io/reference/session-signup.md): Creates a buyer account on the store, by email or by phone, following the store's sign-up policy (`store.get` answers `acquisition`: the methods, the required fields, whether an invite code is… - catalog - [List catalog products](https://docs.kentro.io/reference/catalog-list-1.md): A page of the products this buyer can see, with the buyer's prices (null when the store hides prices from signed-out visitors). Filter by search text, category (by name or handle), sort by featured,… - [Read one product](https://docs.kentro.io/reference/catalog-get.md): One product by handle (`selector: "handle"`) or by id, with its variants, options, images, pack sizes, stock level and lead time as the store shows them, and the buyer's price. Name a variant with… - [Read the category navigation tree](https://docs.kentro.io/reference/catalog-categories.md): The categories this buyer can see, as a flat list with `parentId` and `position`, with visible product counts rolled up to parents. No prices, so it answers for an unconfirmed buyer too; cached for a… - [Search typeahead](https://docs.kentro.io/reference/catalog-suggest.md): The products and categories this buyer can see that match a short query, ranked and capped, for a search box. Limited per buyer, guest or visitor address (send `X-Storefront-Client-Ip`); past the… - cart - [List the carts to choose from at sign-in](https://docs.kentro.io/reference/cart-choices.md): When a visitor with a guest cart signs in, the guest cart and the account cart both exist; until the buyer chooses, cart writes are refused with `CART_CHOICE_REQUIRED`. Lists both (items, whether a… - [Discard a retained cart](https://docs.kentro.io/reference/cart-discard.md): Discards a cart (`id`, pinned with its `ownershipVersion`) the buyer or guest no longer wants. Idempotent per `idempotencyKey`. **Who may call it:** A guest (`X-Storefront-Guest`) or a signed-in… - [Restore a retained guest cart](https://docs.kentro.io/reference/cart-restore.md): Makes a retained guest cart (`id`, pinned with its `ownershipVersion`) the current guest cart again; other guest carts are retained. Idempotent per `idempotencyKey`. **Who may call it:** A guest… - [Choose the cart to continue with](https://docs.kentro.io/reference/cart-choose.md): Settles the choice of `cart.choices`: `selectedId` becomes the cart the buyer continues with; the other is retained (`retainedIds`) and can be restored or discarded later. Pin both carts with their… - [Save the guest contact and addresses](https://docs.kentro.io/reference/cart-contact.md): Saves a guest's email and shipping and billing addresses on the guest cart, for a guest checkout. `ownershipVersion` is required. A signed-in buyer uses the address book (`addresses.save`) and… - [Read the cart, or quote it](https://docs.kentro.io/reference/cart-get.md): The persistent cart of the buyer or guest: lines, settings (fulfillment, addresses, payment method, shipping rate, coupon, notes), totals, and whether checkout may proceed. With `quote: true` the… - [Add a product to the cart](https://docs.kentro.io/reference/cart-add.md): Adds `quantity` of a product (`productId`; `variantId` for a grouped product's variant; `purchase.packageName` for a pack) to the cart, through the store's rules (minimum and step quantities, stock,… - [Set the quantity of a cart line](https://docs.kentro.io/reference/cart-set.md): Sets a line (`lineId`) to `quantity`, through the same rules as `cart.add`. **Who may call it:** A guest (`X-Storefront-Guest`), or a signed-in buyer (`X-Storefront-Buyer`) whose account is… - [Remove a cart line](https://docs.kentro.io/reference/cart-remove.md): Removes a line (`lineId`) from the cart. **Who may call it:** A guest (`X-Storefront-Guest`), or a signed-in buyer (`X-Storefront-Buyer`) whose account is confirmed; an unconfirmed buyer is refused… - [Change cart settings](https://docs.kentro.io/reference/cart-update.md): Changes the cart's settings: fulfillment method and location, shipping and billing addresses (`shipToId`, `billToId`), payment method (`paymentId`; `"new-card"` to enter one at checkout), carrier… - [Add up to 100 lines at once](https://docs.kentro.io/reference/cart-addmany.md): Adds up to 100 lines in one revision (a quick-order form, a reorder), each through the cart rules, and answers the cart with a result per line (`batch.results`: added, adjusted or refused, and why).… - [Apply a referral code to the cart](https://docs.kentro.io/reference/cart-referral-code-apply.md): Sets the cart's referral code (`code`); the next quote applies the referral credit it grants. **Who may call it:** A guest (`X-Storefront-Guest`), or a signed-in buyer (`X-Storefront-Buyer`) whose… - [Remove the referral code from the cart](https://docs.kentro.io/reference/cart-referral-code-remove.md): Clears the cart's referral code. **Who may call it:** A guest (`X-Storefront-Guest`), or a signed-in buyer (`X-Storefront-Buyer`) whose account is confirmed; an unconfirmed buyer is refused with 403… - checkout - [Submit the reviewed quote as a checkout attempt](https://docs.kentro.io/reference/checkout-start.md): Places the order from the quote the buyer reviewed: `quoteFingerprint` from `cart.get { quote: true }` and `expectedRevision` of that cart; a quote that changed since is refused (409) and the buyer… - [Read a checkout attempt](https://docs.kentro.io/reference/checkout-status.md): Where an attempt stands: by `attemptId`, or, when the answer to `checkout.start` was lost, by the `idempotencyKey` and `quoteFingerprint` you sent. Poll it after a hosted payment page redirects back,… - [Confirm a pending attempt with the payment provider](https://docs.kentro.io/reference/checkout-confirm.md): Asks the payment provider what happened to the attempt (`attemptId`) and completes the order when the payment succeeded, for example when the buyer returns from the hosted payment page. Safe to… - [Cancel an unpaid attempt](https://docs.kentro.io/reference/checkout-cancel.md): Cancels the attempt (`attemptId`) and releases its reservations, only after the provider confirms that no payment can complete; an attempt whose payment is deciding is refused with `PAYMENT_PENDING`.… - orders - [List the buyer's orders](https://docs.kentro.io/reference/orders-list-1.md): A page (20 orders, newest first) of the buyer's orders on the store's channel, including orders from before the storefront. Filter by `status` (`open`, `completed`, `canceled`: together they cover… - [Read one order](https://docs.kentro.io/reference/orders-get-1.md): One of the buyer's orders (`id`) in detail: lines, totals, addresses, how it was paid, balance due, shipments with tracking, the buyer's note and the store's note, and the order-review documents… - [Re-quote an order for Reorder](https://docs.kentro.io/reference/orders-reorder.md): One of the buyer's orders (`id`) re-quoted against the current catalog, without writing: per line, whether it is ready, changed (price, quantity raised to the minimum or lowered to stock) or… - invoices - [List the buyer's invoices](https://docs.kentro.io/reference/invoices-list-1.md): A page of the buyer's invoices with status (`unpaid`, `partly_paid`, `paid`, `canceled`), balance (`due`, `overdue`) and search filters, and `payment`: whether the store takes invoice payments online… - [Read one invoice](https://docs.kentro.io/reference/invoices-get-1.md): One of the buyer's invoices (`id`): lines, totals, payments recorded, and how it can be paid online (`payment`: the open balance, whether a new card may be entered on the hosted page, and the saved… - [Pay an invoice with a saved method](https://docs.kentro.io/reference/invoices-pay.md): Pays the open balance of an invoice (`id`) with a saved card or bank account (`paymentId`), once per `idempotencyKey`. `expectedAmount` is the total the buyer was shown (`invoices.get`… - [Open the hosted payment page for an invoice](https://docs.kentro.io/reference/invoices-paylink.md): Creates (or reuses) the hosted payment page for the open balance of an invoice (`id`), for a new card; send the buyer to `redirectUrl`. When the buyer comes back, read `invoices.paymentStatus`.… - [Read where an invoice payment stands](https://docs.kentro.io/reference/invoices-paymentstatus.md): Where a payment of an invoice (`id`) stands; with `idempotencyKey`, that payer attempt's. Records a payment that succeeded meanwhile and closes a stale hosted-page link, so read it after every… - account - [Read the buyer's account](https://docs.kentro.io/reference/account-get.md): The buyer's profile and terms: name, company, email, phone, price list, credit balance and limit, balance due, payment terms, order limits, referral code. `version` is what `account.update` sends as… - [Update the buyer's profile](https://docs.kentro.io/reference/account-update.md): Changes the buyer's name, first and last name, email or phone (send only what changes, with `expectedVersion` from `account.get`). Nothing else on the account is writable here; terms and limits… - [Change the buyer's password](https://docs.kentro.io/reference/account-changepassword.md): Changes the signed-in buyer's password (`currentPassword`, `password`). A wrong current password is 400 with `fieldErrors.currentPassword`. Every session of the buyer is signed out: sign in again at… - [Confirm the buyer account, or send a new code](https://docs.kentro.io/reference/account-confirm.md): For a store that requires confirmation (`session.get` answers `confirmed: false`): without `confirmationCode` a new 5-digit code is sent to the buyer's email or phone (`status:… - addresses - [List the buyer's addresses](https://docs.kentro.io/reference/addresses-list.md): The buyer's address book, default first. Each address carries a `version` for `addresses.save` and `addresses.remove`. The body is empty. **Who may call it:** A signed-in buyer… - [List countries and regions for address entry](https://docs.kentro.io/reference/addresses-options.md): The countries addresses may use and, for `country`, its regions (states or provinces) with their codes. **Who may call it:** A signed-in buyer (`X-Storefront-Buyer`); without one the answer is 401… - [Remove an address](https://docs.kentro.io/reference/addresses-remove.md): Removes an address (`id`, with its `expectedVersion`). Orders that used it keep their copy. **Who may call it:** A signed-in buyer (`X-Storefront-Buyer`); without one the answer is 401… - [Add or change an address](https://docs.kentro.io/reference/addresses-save.md): Adds an address (no `id`; an optional `createId` of your own makes the add idempotent) or changes one (`id` with its `expectedVersion`). `isDefault: true` makes it the default. `type` is `shipping`,… - payments - [List the buyer's payment methods](https://docs.kentro.io/reference/payments-list-1.md): The buyer's saved payment methods: cards (brand and last four), bank accounts, and the buyer's own net terms when usable. Each carries a `version` for `payments.remove` and `payments.default`, and… - [Read the card entry configuration](https://docs.kentro.io/reference/payments-cardconfig.md): For a store on Authorize.net: the public Accept.js configuration (`provider: "authorize-net"`, `apiLoginId`, `clientKey`, `sandbox`) your page uses to tokenize a card into `opaqueData` for… - [Add or change a payment method](https://docs.kentro.io/reference/payments-save.md): Starts saving a card: with `opaqueData` and `cardMetadata` (Authorize.net) the card is stored at once; on Stripe the answer is `state: "action"` with the hosted setup page in `redirectUrl`. `billing`… - [Remove a payment method](https://docs.kentro.io/reference/payments-remove.md): Starts removing a saved method (`id` with its `expectedVersion`); the provider is told to forget it. Idempotent per `idempotencyKey`; the method shows `pendingRemoval` until the change is `complete`.… - [Confirm a payment change with the provider](https://docs.kentro.io/reference/payments-confirm.md): Asks the provider what happened to a change (`operationId`), for example when the buyer returns from the hosted setup page, and applies it when it succeeded. **Who may call it:** A signed-in buyer… - [Abandon a hosted setup](https://docs.kentro.io/reference/payments-cancel-1.md): The buyer came back through the cancel link of the hosted setup page: expires the open session and settles the change (`operationId`) as abandoned, or as saved when the buyer completed it meanwhile.… - [Read where a payment change stands](https://docs.kentro.io/reference/payments-status.md): Where a change stands: by `operationId`, or, without one, the buyer's pending change if any (`state: "idle"` when there is none). A change still deciding is checked with the provider; `complete` or… - [Make a payment method the default](https://docs.kentro.io/reference/payments-default.md): Makes a saved method (`id` with its `expectedVersion`) the default; the previous default becomes general. **Who may call it:** A signed-in buyer (`X-Storefront-Buyer`); without one the answer is 401… - carriers - [List the buyer's carrier accounts](https://docs.kentro.io/reference/carriers-list.md): The buyer's own carrier accounts (carrier, account number, country and postal code), for shipping on the buyer's account. The body is empty. **Who may call it:** A signed-in buyer… - [Read the carrier book](https://docs.kentro.io/reference/carriers-book.md): The carrier accounts with the book's `version` (sent as `expectedVersion` on every carrier write) and `options`: the carriers the store accepts accounts for and whether a new account may be added for… - [Add or change a carrier account](https://docs.kentro.io/reference/carriers-save.md): Adds a carrier account (no `id`; an optional `createId` of your own makes the add idempotent) or changes one (`id`). `carrier` is an option id from `carriers.book`; `expectedVersion` is the book's… - [Remove a carrier account](https://docs.kentro.io/reference/carriers-remove.md): Removes a carrier account (`id`, with the book's `expectedVersion`); a cart quote that used it is cleared. **Who may call it:** A signed-in buyer (`X-Storefront-Buyer`); without one the answer is… - [Make a carrier account the default](https://docs.kentro.io/reference/carriers-default.md): Makes a carrier account (`id`, with the book's `expectedVersion`) the default. **Who may call it:** A signed-in buyer (`X-Storefront-Buyer`); without one the answer is 401 `UNAUTHORIZED`. - applications - [Start a buyer application](https://docs.kentro.io/reference/application-start.md): On an approval store (`store.get` answers `applicationEnabled: true`), starts an application for a buyer account under a `requestId` of your own, and answers the form to show: the fields, the… - [Read an application](https://docs.kentro.io/reference/application-get.md): The current state of an application: its form and what has been entered or uploaded so far. Pin the application with its owner fields from `application.start`. **Who may call it:** Anyone with the… - [Permit an attachment upload](https://docs.kentro.io/reference/application-upload-permit.md): Reserves an upload slot for an attachment (name, size, type) of the application and answers the `uploadId` to send the content under with `application.upload.put`. **Who may call it:** Anyone with… - [Upload an attachment](https://docs.kentro.io/reference/application-upload-put.md): Sends the content of a permitted upload (`uploadId`, base64 `content`, up to 10 MiB) to storage. **Who may call it:** Anyone with the API key and the storefront host; no buyer or guest token is… - [Confirm an uploaded attachment](https://docs.kentro.io/reference/application-upload-confirm.md): Checks that the uploaded content (`uploadId`) is what was permitted and attaches it to the application. **Who may call it:** Anyone with the API key and the storefront host; no buyer or guest token… - [Submit an application](https://docs.kentro.io/reference/application-submit.md): Submits the application with the applicant's details, the accepted documents and the confirmed attachments. The store's staff is notified and reviews it; the applicant is told by email. A field the… - subscriptions - [List subscription plans](https://docs.kentro.io/reference/subscription-list-plans.md): The subscription plans the store offers this buyer: cycle, allowed frequencies, discount and whether each is available now. The body is empty. **Who may call it:** A guest (`X-Storefront-Guest`) or… - [Read one subscription plan](https://docs.kentro.io/reference/subscription-plan-details.md): One plan (`id`) in detail. **Who may call it:** A guest (`X-Storefront-Guest`) or a signed-in buyer (`X-Storefront-Buyer`); without either the answer is 401 `UNAUTHORIZED`. - [Read the buyer's subscription](https://docs.kentro.io/reference/subscription-active.md): The buyer's current subscription with its plan, frequency, next cycle date, items and `revision`, or null when there is none. The body is empty. **Who may call it:** A signed-in buyer… - [Read the buyer's subscription history](https://docs.kentro.io/reference/subscription-history.md): The cycles of the buyer's subscription: each with its status, amount, the order it produced and any error. The body is empty. **Who may call it:** A signed-in buyer (`X-Storefront-Buyer`); without… - [Subscribe to a plan](https://docs.kentro.io/reference/subscription-subscribe.md): Creates the buyer's subscription on a plan (`planId`) with a `selectedFrequency` the plan allows; the first cycle is the current cart or the plan's fixed items. Send `expectedRevision` (the… - [Activate a subscription](https://docs.kentro.io/reference/subscription-activate.md): Activates a subscription that is not active yet. Send `expectedRevision` (the subscription's `revision`, 0 before one exists) and a `requestId` of your own; the same `requestId` never applies twice.… - [Pause a subscription](https://docs.kentro.io/reference/subscription-pause.md): Pauses the subscription; no cycle runs until it is resumed. Send `expectedRevision` (the subscription's `revision`, 0 before one exists) and a `requestId` of your own; the same `requestId` never… - [Resume a subscription](https://docs.kentro.io/reference/subscription-resume.md): Resumes a paused subscription; `nextCycleDate` sets when the next cycle runs. Send `expectedRevision` (the subscription's `revision`, 0 before one exists) and a `requestId` of your own; the same… - [Skip the next cycle](https://docs.kentro.io/reference/subscription-skip.md): Skips the next cycle of the subscription. Send `expectedRevision` (the subscription's `revision`, 0 before one exists) and a `requestId` of your own; the same `requestId` never applies twice. **Who… - [Cancel a subscription](https://docs.kentro.io/reference/subscription-cancel.md): Cancels the subscription at the end of the current cycle. Send `expectedRevision` (the subscription's `revision`, 0 before one exists) and a `requestId` of your own; the same `requestId` never… - [Change the plan, frequency or next cycle](https://docs.kentro.io/reference/subscription-update.md): Changes the subscription's plan (`planId`), `selectedFrequency` or `nextCycleDate`. Send `expectedRevision` (the subscription's `revision`, 0 before one exists) and a `requestId` of your own; the… - [Change the subscription items](https://docs.kentro.io/reference/subscription-update-items.md): Changes what each cycle orders: `action` is `sync-from-cart` (take the current cart), `update-quantity` (`lineId`, `quantity`), `add-item` (`productId`, `quantity`, `purchase`) or `remove-item`… - fulfillment - [Find delivery and pickup locations](https://docs.kentro.io/reference/fulfillment-locations.md): The store's delivery and pickup locations near a point (`searchLocation`) or an address (`postalCode` and `country`), or matching a `query` by name, with opening hours and pickup instructions; empty… - pixel - [Read the storefront's pixel public key](https://docs.kentro.io/reference/pixel-get.md): The Kentro Pixel public key of the storefront, for the browser snippet that reports page views and conversions; null when the store has no pixel property. The body is empty. **Who may call it:**… ## API Reference: Kentro Pixel - [Kentro Pixel](https://docs.kentro.io/reference/kentro-pixel.md): Kentro's first-party, consent-aware event collector for your websites, Kentro GO landing pages and your own servers. - [Pixel quickstart](https://docs.kentro.io/reference/pixel-quickstart.md): Create a property, install the snippet, report consent and confirm your first events in about fifteen minutes. - [Domains and verification](https://docs.kentro.io/reference/pixel-domains.md): Control which websites may send events with a property's public keys, and prove that you own a domain. - [Browser SDK](https://docs.kentro.io/reference/pixel-browser-sdk.md): Reference for the Kentro Pixel browser SDK v1.3.0: methods, options, storage, transport, consent integration and signup forms. - [Events and taxonomy](https://docs.kentro.io/reference/pixel-events.md): The event envelope, money and identifier rules, the standard taxonomy, reserved names, custom schemas and validation. - [Server API](https://docs.kentro.io/reference/pixel-server-api.md): Send authoritative orders, refunds, subscriptions and leads from your backend with HMAC-signed requests. - [Identity tokens for signed-in visitors](https://docs.kentro.io/reference/pixel-identity.md): Bind a signed-in visitor to your login or customer id with a short-lived token your server signs with a Pixel server key. - [Consent and privacy](https://docs.kentro.io/reference/pixel-consent-privacy.md): How Kentro Pixel applies consent, quarantines sensitive data, redacts sensitive paths and handles privacy requests. - [Destinations](https://docs.kentro.io/reference/pixel-destinations.md): Forward conversion events to Meta, Google Ads and GA4, and events or audience membership to your own signed webhooks. - [Limits, errors and troubleshooting](https://docs.kentro.io/reference/pixel-limits-errors.md): Kentro Pixel limits, CORS behavior, reason codes, request errors, troubleshooting, background processing and retention. - [Pixel changelog](https://docs.kentro.io/reference/pixel-changelog.md): Dated changes to Kentro Pixel, its browser SDK and this documentation since the first public page on 2026-10-15.