The examples below use
https://www.merchkit.com as the base URL.The mental model
A few concepts carry the whole API. Internalize these and the rest follows.A product is the core object
The product is the central resource. (Assets, vendors, and categories are modeled the same
way and live alongside it.) When you talk to a person about a product, identify it by its primary
attribute — usually its SKU. When you call the API, identify it by its UUID
id.Attributes are dynamic
A product’s fields are attributes, defined per workspace rather than hard-coded. Attribute
definitions describe what a product can hold; attribute values are what a given product holds.
To enrich a product you set attribute values — you never recreate the product to change a field.
Channels are read-only and global in the API — you read the available channel catalog, but you
cannot create channels through the API.
Base URL and spec
https://www.merchkit.com/api/v1 — all REST endpoints live under the /api/v1 prefix.https://www.merchkit.com/api/v1/openapi — the machine-readable contract. Field and enum
descriptions are rich enough for an agent to route by semantic search, and the spec backs the
API Reference in these docs.https://www.merchkit.com/llms.txt — a curated, instruction-bearing guide written for agents. It
lists the preferred endpoints, the filter DSL, and the common footguns. If you are pointing an
agent at Merchkit, give it this URL.Authentication, in one line
Every request carries your workspace API key as a bearer token:Where to go next
Authentication
API keys, scopes, and read vs write access.
Conventions
Pagination, the filter DSL, the error envelope, and async jobs.
MCP server
Operate your catalog from Claude and other agents.
API Reference
The full endpoint reference, generated from the OpenAPI spec.