Skip to main content
Operating instructions are the merchandising rulebook for your storefront — a Markdown body the Interchange Merchandising Engine consumes when it composes products for buyers. Each save creates a new immutable version; exactly one version is active at a time, and only the active version influences compositions. You author a new version, review it, then activate it to swap the storefront’s active pointer. Versions are numbered per storefront. The first version is 1, and numbers are monotone and never reused. Activating a version does not delete older ones — they stay in history so you can re-read or re-activate a prior version. All examples use the storefront base URL:
https://api.interchange.io/api/v2/storefront
Authenticate every request with Authorization: Bearer $SCOPE3_API_KEY.

Task reference

List versions

GET /operating-instructions — every version, newest first

Create version

POST /operating-instructions — author a new version

Get active version

GET /operating-instructions/active — the version in force now

Get a version

GET /operating-instructions/{version} — one version by number

Activate version

POST /operating-instructions/{version}/activate — swap the active pointer