CMS Tool API

API changelog

Public changes to versioned API behaviour.

Version 1.4.51

Released: 2026-10-21

The directoryListing and directoryClassification endpoints each have their own scopes, directoryListing:read and directoryListing:write, and directoryClassification:read and directoryClassification:write. The shared directory scope is removed. Updating a classification still needs the configuration permission.

Version 1.4.50

Released: 2026-10-21

The configuration scopes are removed: scopes are named after endpoints, and configuration is a user permission. Categories are updated with category:write and directory classifications with directory:write, and both also need the user to hold the configuration permission. A request that is only authorised to read can no longer change data by sending a body.

Version 1.4.49

Released: 2026-10-21

Categories and directory classifications can also be read with the new configuration:read scope, which goes with the configuration permission as configuration:write does.

Version 1.4.48

Released: 2026-10-21

Categories can now be read with the product:read scope. Creating or updating a category, or a directory classification, now needs the configuration:write scope. Directory classifications can be read with directory:read.

Version 1.4.47

Released: 2026-10-21

An endpoint scope now covers the whole endpoint: product:read also covers /api/products and /api/product/123, and category:read covers /api/categories. Endpoints that share a start, such as member and membernotes, keep separate scopes.

Version 1.4.46

Released: 2026-10-21

Added the directoryListing and directoryClassification endpoints to read and update directory listings and the classifications they are filed under. A listing can be filtered by classification, status, keywords and dates.

Version 1.4.45

Released: 2026-10-21

The eventAttendee, membernotes and memberpoints schemas now include their field definitions.

Version 1.4.44

Released: 2026-10-21

Added the shopconfig endpoint to read and update the shop configuration of each shopping page as one flat object.

Version 1.4.43

Released: 2026-10-18

Security updates only.

Version 1.4.42

Released: 2026-10-15

The descriptive MCP tools now return text stored with HTML entities as readable characters. Markup, embedded JSON and the results of read_api, call_api and the product update tools are unchanged.

Version 1.4.41

Released: 2026-10-15

Security updates only.

Version 1.4.40

Released: 2026-10-14

Security updates only.

Version 1.4.38

Released: 2026-10-14

The MCP ecommerce settings tool now returns the definition of every setting and marks the ones that are not set. A rejected product update plan lists the valid product columns, and call_api explains how to find the right field names when the API does not accept a request.

Version 1.4.37

Released: 2026-10-14

The MCP call_api tool takes one record as body or several as records, and accepts JSON given as text. The product update tool descriptions now point to call_api for a single product.

Version 1.4.36

Released: 2026-10-14

The MCP content-object investigation now applies the user's current permissions.

Version 1.4.35

Released: 2026-10-14

Added an MCP tool, call_api, that makes one REST API request for an agent. get_api_guidance now lists endpoints by the user's permissions.

Version 1.4.34

Released: 2026-10-14

Added a read-only MCP tool, get_api_guidance, that lists the REST API endpoints a connection may use for a task and describes one endpoint's methods, parameters and body fields. It shows only what the connection's scopes and the user's permissions allow.

Version 1.4.33

Released: 2026-10-14

The OAuth consent page now lists the MCP tool scopes an application requests, so MCP clients can be approved.

Version 1.4.32

Released: 2026-10-13

Added MCP tools to list your websites, search for a website (resellers and administrators can search every website in their channels), and switch the active website of a connection.

Version 1.4.31

Released: 2026-10-13

OAuth authorization errors now state the actual problem, instead of always reporting an expired request.

Security updates.

Version 1.4.30

Released: 2026-10-12

OAuth discovery now follows RFC 8414 and RFC 9728: authorization server metadata is also published at https://www.cms-tool.net/.well-known/oauth-authorization-server/api/auth, and protected resource metadata uses absolute URLs and states the resource it was requested for.

Version 1.4.29

Released: 2026-10-11

Added a read-only MCP ecommerce settings tool with shopping cart settings such as tax rate, shipping rules, discount rules, and up to 200 categories, with field definitions for the returned data.

Version 1.4.28

Released: 2026-10-08

Added a read-only MCP account report tool with account status, plan limits, usage in MB, domains, and billing context.

Email investigations now report mailbox sizes in MB and no longer describe per-mailbox limits.

Version 1.4.27

Released: 2026-10-08

Security updates only.

Version 1.4.26

Released: 2026-10-07

Added a read-only MCP content-object investigation tool with field definitions for the returned data.

Version 1.4.25

Released: 2026-10-06

Reduced order investigation metadata by returning definitions only for fields present in the result.

Version 1.4.24

Released: 2026-10-06

Renamed the MCP order investigation tool for consistency with the other investigation tools.

Version 1.4.23

Released: 2026-10-06

Added an MCP order investigation tool with pricing, discount, shipping, and tax context.

Version 1.4.22

Released: 2026-10-05

Added complete MCP product-update planning instructions, website metadata, previews, and validated execution.

Version 1.4.21

Released: 2026-10-05

Non-empty reports generated through MCP are recorded for later review, and report links now use the saved report reference.

Report link responses include the row count and omit the link when no rows were found.

Version 1.4.20

Released: 2026-10-05

Added a report plan option to return report data for analysis or a compact link for the user.

Version 1.4.18

Released: 2026-09-30

Reviewed API request limits with HTTP 429 responses and Retry-After guidance.

Array requests now stop immediately when an operation throws an exception.

Version 1.4.17

Released: 2026-09-26

Added category update matching by code or unique filename and normalized dynamic category paths.

Version 1.4.16

Released: 2026-09-26

Added product update matching by unique filename and normalized product route prefixes.

Version 1.4.15

Released: 2026-09-26

Limited JSON array POST requests to 100 objects per request.

Version 1.4.14

Released: 2026-09-26

Added repeat-safe image handling for product, category, and article migrations.

Product image imports now retain original offsite sources and exclude primary images from additional images.

Version 1.4.13

Released: 2026-09-25

Sorted public API endpoint catalogs alphabetically by endpoint path.

Version 1.4.12

Released: 2026-09-25

Displayed OAuth discovery URLs as visible references in the authentication guide.

Version 1.4.11

Released: 2026-09-25

Added an API usage guide covering pagination, filters, sorting, dates, and response types.

Clarified multipart image upload fields in product and article schemas.

Version 1.4.10

Released: 2026-09-25

Added public authentication and MCP instructions to the API schema documentation.

Added JSON and Markdown discovery instructions to HTML documentation pages.

Version 1.4.9

Released: 2026-09-24

Added multipart primary and additional image uploads for articles.

Version 1.4.8

Released: 2026-09-24

Security updates only.

Version 1.4.7

Released: 2026-09-24

Security updates only.

Version 1.4.5

Released: 2026-09-24

Security updates only.

Version 1.4.4

Released: 2026-09-24

Security updates only.

Version 1.4.3

Released: 2026-09-24

Security updates only.

Version 1.4.2

Released: 2026-09-24

Added curated endpoint guidance, examples, and nested object dictionaries to public schemas.

Version 1.4.1

Released: 2026-09-24

Expanded public parameter notes with filter purposes and available basket actions.

Version 1.4.0

Released: 2026-09-24

Added types and examples to public endpoint parameter definitions.

Documented that boolean parameters accept true or 1.

Added supported methods and POST availability to the endpoint catalog.

Version 1.3.0

Released: 2026-09-24

Added public /api/schema and /api/changelog endpoints.

Added the public API version to status and schema responses.

Version 1.2.0

Released: 2026-09-23

Added product image paths and multipart product image uploads.

Version 1.1.0

Released: 2026-09-23

Added binary file uploads and image metadata, editing, upload, and download operations.

Added the readyToPick basket search option.

Version 1.0.0

Released: 2026-09-23

Published versioned API endpoint and field documentation.

Machine-readable documentation

This documentation is also available as JSON or Markdown at the same URL. Request JSON with Accept: application/json or Markdown with Accept: text/markdown.