Commercelayercommercelayer.io
Commercelayer's API program shows strong discoverability fundamentals, but partner and agent outcomes are held back by two critical gaps: agents and coding assistants cannot reliably parse your APIs because errors lack machine-readable structure, docs lack AI-consumable formats, and no agent instruction file exists to guide automated tooling. Separately, partners have no self-service portal to onboard independently, and no runnable collection with tests to validate integrations before they hit production.
API DesignA clean, typed, well-governed API contract agents can reason about5 pass0 warn0 fail100A+
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Machine-readable, versioned contractvia spec | 25/25 | OpenAPI 3.0.1 declared (3.0.x; 3.1 adds JSON Schema 2020-12 alignment but is not required for full credit). Investigated: spec 100%, docs 100%. | A current OpenAPI version with a declared versioning scheme lets agents reason about the contract. |
| pass | Schema coverage & depthvia sdk | 25/25 | 2/2 enums are named types (not bare strings). Investigated: sdk 100%, spec 61%. | Typed, complete request/response schemas are what make agent function-calling possible. |
| pass | Auth declared & discoverablevia spec | 25/25 | Authentication required (global or on every operation). Investigated: spec 100%, docs 100%. | Agents can only authenticate when auth is declared, scoped, and discoverable. |
| pass | Security & governance hygienevia spec | 15/15 | No credential-shaped strings detected in spec. Investigated: spec 100%, wellknown 0%. | No leaked secrets, no critical lint violations, no OWASP API Top-10 spec smells, and a published vulnerability-disclosure channel. |
| pass | Example coveragevia docs | 10/10 | Code samples present on 6/20 pages across 1 language(s); broader multi-language coverage missing. Investigated: docs 100%, sdk 100%, spec 0%. | Examples carry shape semantics schemas under-specify — for humans and agents alike. |
Developer ExperienceThe context both developers and agents need to integrate fast — onboarding, code samples, complete descriptions and worked examples4 pass0 warn1 fail76B
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Quickstart presentvia docs | 25/25 | Quickstart at https://docs.commercelayer.io/core has a runnable sample in the .md variant (https://docs.commercelayer.io/core.md). Investigated: docs 100%. | A quickstart is the fastest path from landing page to first successful call. |
| pass | Code samples in docsvia docs | 18/18 | Code samples present on 6/20 pages across 1 language(s); broader multi-language coverage missing. Investigated: docs 100%. | Multi-language samples shorten time-to-first-call. |
| pass | Description completenessvia spec | 15/15 | 74% description completeness (target 90%+). Investigated: spec 100%. | Complete descriptions are the context humans and agents need to use endpoints. |
| pass | Changelog publishedvia spec | 13/13 | changelog documented in the docs site at https://docs.commercelayer.io/changelog/archive/2025. Investigated: spec 100%, docs 100%, sdk 100%. | A published changelog lets partners track changes without surprise. |
| fail | Self-service developer portalvia docs | 0/29 | No signup page detected across conventional paths (/signup, /sign-up, /register, /get-started, /console/signup, /dashboard/signup, /try, /try-free, /free, /free-trial, /start, /start-free). Investigated: docs 0%. | Self-serve key/account creation is the fast first call for partners, with no sales gate. |
Agent DiscoveryPartners and their agents can find your APIs — llms.txt, registries, crawlable and reachable docs2 pass1 warn0 fail96A+
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | llms.txt present, valid & comprehensivevia docs | 30/30 | llms-full.txt reachable at https://docs.commercelayer.io/llms-full.txt. Investigated: docs 100%, sdk 0%. | A valid, comprehensive llms.txt is the machine-readable entry point for agents. |
| pass | Registry & SDK presencevia cli | 28/28 | Official CLI at commercelayer/commercelayer-cli with published releases (installable). Investigated: cli 100%, sdk 50%, docs 0%, mcp 0%, wellknown 0%. | Listing in MCP registries and publishing SDKs puts the API where agents and their tooling look. |
| warn | Crawlable / AEOvia wellknown | 9/12 | Sitemap present (11 entries) but carries no lastmod values. Investigated: wellknown 75%. | Bots allowed plus a fresh sitemap make docs findable by agent crawlers. |
| na | Docs reachable, not hard auth-gated | —/30 | No surface produced evidence for this capability in this run. | Agents can only index and fetch docs they can reach — past auth gates and over correct HTTP semantics. |
Agent UnderstandingAgents can correctly interpret your APIs — machine-readable errors, consistent descriptions, structured data, parseable docs1 pass0 warn4 fail51D
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Operation purpose clarityvia spec | 25/25 | 100% of operations have a clear summary + operationId an agent can select on. Investigated: spec 100%. | Agents select the right endpoint from its summary + operationId; clear, named operations make tool-selection reliable — the strongest driver of correct tool choice. |
| fail | Machine-readable errors (RFC 9457)via spec | 0/28 | No 4xx/5xx response codes (or default error response) documented anywhere in the spec. Investigated: spec 0%, docs 0%. | RFC 9457 problem details and a documented error-code inventory let agents parse failures without burning tokens. |
| fail | Agent instructions file (AGENTS.md)via wellknown | 0/10 | No AGENTS.md at the site root or /.well-known/. Investigated: wellknown 0%. | An AGENTS.md gives coding agents explicit setup, auth, and usage instructions to interpret and operate the API — beyond llms.txt's link index. |
| fail | Docs structured datavia docs | 0/8 | Neither JSON-LD nor OpenGraph/meta tags detected across 1 assessed pages (1 JS-rendered). Investigated: docs 0%. | Structured data (JSON-LD/schema.org) on docs pages gives agents an unambiguous parse target and is what answer engines cite. Detected on the JS-rendered head (Firecrawl) for a bounded page budget, so JS-injected JSON-LD is now caught; pages we can't render are excluded rather than failed. |
| fail | Description consistency across surfaces | 0/7 | Mean pairwise description similarity across 2 surfaces (spec, sdk) is 0% (threshold 35% for full credit). | Every surface tells the same story about what the product is. |
| na | Agent-navigable, token-efficient docs | —/22 | No surface produced evidence for this capability in this run. | Server-rendered, clean, small-footprint docs are what an agent can cheaply fetch and parse correctly. |
Agent UsabilityAgents have the context to use your APIs reliably, not just find them2 pass1 warn1 fail79B
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Idempotency documentedvia sdk | 27/27 | Built-in retry machinery is present (grep-derived). Investigated: sdk 100%, spec 0%, docs 0%. | Documented idempotency lets agents retry safely. |
| pass | Rate-limit signalingvia spec | 22/22 | rate-limit behavior documented in the docs site at https://docs.commercelayer.io/core/rate-limits. Investigated: spec 100%, docs 100%. | Machine-readable rate-limit headers let agents throttle adaptively. |
| warn | Sandbox separationvia sdk | 10/20 | No test-mode flag or sandbox environment is exposed. Investigated: sdk 50%, spec 0%, docs 0%. | An isolated environment lets agents exercise destructive operations safely. |
| fail | Runnable collection with test scriptsvia platform | 0/9 | No public Postman workspace discovered for the org. Investigated: platform 0%. | A public, maintained collection with assertions is runnable truth agents validate against. |
| na | Pagination documented & consistent | —/22 | No surface produced evidence for this capability in this run. | Consistent, documented pagination lets agents traverse collections. |
Resources Discovered
The public resources we found for Commercelayer — the evidence behind the score. All discovered from public sources; nothing here requires access to your systems.
| APIs analyzed | 3 — Commerce Layer API, Commerce Layer Provisioning API, Commerce Layer Metrics API |
|---|