Commerce — OmniRetailConnect Docs

Getting started

Overview What the Commerce MCP server and REST API are, what they can and cannot do, and who sets them up.
Authentication and tokens How bearer tokens work: format, scopes, channels, expiry, storage, creation, rotation and revocation.
Errors and status codes HTTP status codes, REST error codes, MCP transport errors and tool errors.
Rate limits, pagination and request limits Per-token and per-IP rate limits, cursor pagination, result limits and request size caps for both interfaces.
Versioning and changelog How the REST API and the MCP server are versioned, and what counts as a compatible change.

MCP overview The endpoint, the transport, the fifteen read tools and the forty-five write tools of the Commerce MCP server.
Connect with an AI agent A checklist, connection config, verification procedure and decision table for AI agents and the people who hand them this task.
Connect Claude Code Add the Commerce MCP server to Claude Code with one command.
Connect other clients A generic MCP client configuration, a curl smoke test, and what is not supported.
Tool reference The fifteen read tools and the first write tools (product content, price, stock, images, categories) with their inputs, limits, required scope, output and errors.
Catalogue write tools Write tools for product SEO, web address, variants, properties, labels, sale prices, price breaks, brands, the label set and featured products.
Discount tools Read discounts and create, change, end and delete discount codes, including when a code is hidden.
Order tools Confirm an offline payment, cancel an unpaid order, add internal notes and record shipments with tracking, without moving money.
Content tools List, read, create, change and delete CMS pages: blocks, images, version check, search-engine fields, the home page and size limits.
Privacy and security What personal data is masked, what is never exposed, and how to handle tokens, write tokens and untrusted text.

REST API overview The Commerce REST API: base URL, authentication, the full endpoint list, response envelope and the OpenAPI description.
Products Search products, get one product by id and look up a product by variant SKU, with sales, price breaks, SEO, labels and properties.
Product writes Create products and change content, SEO, web address, properties, labels, variants, price, sales, price breaks, stock and images with a write token.
Catalogue structure Reference lists (brands, labels, tax classes, properties) and writes for brands, labels, categories and featured products.
Discounts Read discount codes and create, change, end and delete them with a write token; when a code is hidden.
Availability Check stock and purchasability of up to 50 SKUs in one request.
Orders Search orders and get one order by reference or id, with masked or full customer data and internal notes depending on the token scope.
Order writes Confirm an offline payment, cancel an unpaid order, add internal notes and record shipments with tracking, without moving money.
Categories Read the product category tree.
Sales summary Operational sales metrics for a date range, optionally grouped by day, week or month.
Pages Read, create, change and delete CMS pages with blocks, images, search-engine fields and a version check.

Scopes and masking Which scope gives what, and which fields are masked or withheld without the pii scope.
Error codes Every error code and status of the REST API and the MCP server in one table.
Limits All default limits of the REST API and the MCP server in one table.