Skip to main content
GET
/
operating-instructions
/
active
Get the active operating-instructions version
curl --request GET \
  --url https://api.interchange.io/api/v2/storefront/operating-instructions/active \
  --header 'Authorization: Bearer <token>'
{
  "id": "42",
  "storefrontId": "1234",
  "version": 3,
  "content": "<string>",
  "notes": "<string>",
  "isActive": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "createdBy": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.interchange.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key or access token

Response

Get the active operating-instructions version

A single operating-instructions version for a storefront. Versions are immutable; updates produce a new row.

​
id
string
required

Surrogate id of the version row (BIGINT serialized as string).

Example:

"42"

​
storefrontId
string
required

Storefront the version belongs to (BIGINT serialized as string).

Example:

"1234"

​
version
integer
required

Per-storefront version number. Monotone, never reused. The first version a storefront authors is 1.

Required range: 1 <= x <= 9007199254740991
Example:

3

​
content
string
required

Markdown body consumed by the Chef agent.

​
notes
string | null
required

Operator note about why this version was authored.

​
isActive
boolean
required

Whether this version is the storefront's active operating instructions (the version Chef will consume on the next composition).

​
createdAt
string<date-time>
required

Creation timestamp (ISO 8601). Rows are immutable so there is no updatedAt.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
createdBy
string | null
required

User id of the operator who authored the version (BIGINT serialized as string). Null when authored by a system or service-token caller.