Skip to main content
← API reference

Endpoints

Every route of the merchant API, from the OpenAPI document. Shop-page routes take the publishable key in ?key=; the two server routes take the secret key in Authorization: Bearer.

Base URL https://cfg.cutoptim.com · Contract version v1 · OpenAPI 3.1 document

Paths, field names, error codes, header names and code samples stay in English: they are the contract.

All routes

The table is generated from the OpenAPI document; the interactive reference below renders the same document with every schema and code samples. Point your client generator at the document itself.

MethodPathKeyWhat it does
GET/cfg/v1/config/publicpublishableThe shop's published configuration (public projection)
GET/cfg/v1/catalog/searchpublishableSearch the shop's catalogue
POST/cfg/v1/previewpublishableLive plan and price (not billable, no token)
POST/cfg/v1/quotepublishableSigned quote (billable)
POST/cfg/v1/orderpublishableRedeem a quote once and store the signed order.v1
POST/cfg/v1/projectspublishableSave a project
GET/cfg/v1/projectspublishable + project tokenThe shopper's projects (newest first, without data)
GET/cfg/v1/projects/{id}publishable + project tokenOpen one project (with data)
POST/cfg/v1/projects/{id}publishable + project tokenRe-save a project (name and/or data)
POST/cfg/v1/projects/{id}/duplicatepublishable + project tokenCopy a project (new id, same data, same owner)
POST/cfg/v1/projects/{id}/reorderpublishable + project tokenA new quote from a saved project, at today's prices
POST/cfg/v1/quote/verifysecretVerify a quote token before the cart (read-only)
GET/cfg/v1/orders/{id}secretCheck a stored order (no personal data)

The interactive reference loads below. Without JavaScript, read the table above or the OpenAPI document. /configurator/openapi.json

There is no "try it" button here on purpose: the secret key belongs on your server, never in a browser. The demo shop shows the embed and the order hand-off working end to end.

LegalConfigurator terms ·Data processing agreement ·Shopper privacy notice ·Third-party licences