Storefront content

Published merchant content for a storefront: blog posts, content blocks and pages. Read-only, authenticated with the sales-channel id (vc_*) in the path and the browser Origin header. Only published rows are returned; drafts are never exposed.

List PUBLISHED content for a sales channel

Lists the published content entries (pages, FAQs and other content types) visible to this channel. A row restricted to other channels is left out. Sent with Cache-Control: public, max-age=300, stale-while-revalidate=60. Limited to 120 requests per minute per IP. Checks no scope.

Path Parameters

connectionIdstring

Sales channel ID (vc_*), the canonical salesChannelId. connectionId is the deprecated name of the same value and is still the literal path segment.

Query Parameters

type?string

Content type to keep, case-insensitive, with - for _ (for example faq). An unknown type answers 400.

locale?string

Language code, for example he. Used only when no Accept-Language header is sent. A language the store does not support, or the store's default language, returns the default text.

Header Parameters

originstring

Origin of the storefront page making the call, for example https://shop.example.com. Required: a request with no Origin header is refused with 403. On a LIVE channel its host must equal the channel's registered domain (or one of its subdomains) or match an allowed origin. A TEST channel with no domain accepts any origin; once a domain is set it is matched as on LIVE.

accept-language?string

Preferred language, for example he. Its first tag is used when it is one of the store's supported languages other than the default; translated fields are then returned in that language. Falls back to the locale query parameter.

X-SDK-Version?string

Version of the calling SDK (the Brainerce SDK sends it automatically). Informational: it is recorded on the channel and never changes the response.

curl -X GET "https://api.brainerce.com/api/vc/string/content?type=faq&locale=string" \
  -H "origin: string" \
  -H "accept-language: string" \
  -H "X-SDK-Version: string"

curl -X GET "https://api.brainerce.com/api/vc/string/content?type=faq&locale=string" \  -H "origin: string" \  -H "accept-language: string" \  -H "X-SDK-Version: string"

{
  "data": [
    {
      "id": "string",
      "storeId": "string",
      "type": "FAQ",
      "key": "main",
      "name": "string",
      "description": "string",
      "salesChannelIds": [
        "string"
      ],
      "data": {},
      "customFields": {},
      "translations": {},
      "status": "PUBLISHED",
      "position": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ]
}

{
  "statusCode": 400,
  "code": "VALIDATION_FAILED",
  "message": "name should not be empty, price must be a positive number",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/vc/{connectionId}/content"
}

{
  "statusCode": 403,
  "code": "INSUFFICIENT_SCOPE",
  "message": "API key does not have the required scope: products:write",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/vc/{connectionId}/content"
}

{
  "statusCode": 404,
  "code": "RESOURCE_NOT_FOUND",
  "message": "Resource not found",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/vc/{connectionId}/content"
}

{
  "statusCode": 429,
  "code": "RATE_LIMITED",
  "message": "Too many requests",
  "details": {
    "retryAfterSeconds": 12
  },
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/vc/{connectionId}/content"
}

Fetch one PUBLISHED content row by (type, key) for a sales channel

Returns one published content entry by type and key. Sent with Cache-Control: public, max-age=300, stale-while-revalidate=60. Limited to 120 requests per minute per IP. Checks no scope.

Path Parameters

connectionIdstring

Sales channel ID (vc_*), the canonical salesChannelId. connectionId is the deprecated name of the same value and is still the literal path segment.

typestring

Content type, case-insensitive, with - for _ (for example faq).

keystring

Content key within the type.

Query Parameters

locale?string

Language code, for example he. Used only when no Accept-Language header is sent. A language the store does not support, or the store's default language, returns the default text.

Header Parameters

originstring

accept-language?string

X-SDK-Version?string

Version of the calling SDK (the Brainerce SDK sends it automatically). Informational: it is recorded on the channel and never changes the response.

curl -X GET "https://api.brainerce.com/api/vc/string/content/string/string?locale=string" \
  -H "origin: string" \
  -H "accept-language: string" \
  -H "X-SDK-Version: string"

curl -X GET "https://api.brainerce.com/api/vc/string/content/string/string?locale=string" \  -H "origin: string" \  -H "accept-language: string" \  -H "X-SDK-Version: string"

{
  "id": "string",
  "storeId": "string",
  "type": "FAQ",
  "key": "main",
  "name": "string",
  "description": "string",
  "salesChannelIds": [
    "string"
  ],
  "data": {},
  "customFields": {},
  "translations": {},
  "status": "PUBLISHED",
  "position": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{
  "statusCode": 400,
  "code": "VALIDATION_FAILED",
  "message": "name should not be empty, price must be a positive number",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/vc/{connectionId}/content/{type}/{key}"
}

{
  "statusCode": 403,
  "code": "INSUFFICIENT_SCOPE",
  "message": "API key does not have the required scope: products:write",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/vc/{connectionId}/content/{type}/{key}"
}

{
  "statusCode": 404,
  "code": "RESOURCE_NOT_FOUND",
  "message": "Resource not found",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/vc/{connectionId}/content/{type}/{key}"
}

{
  "statusCode": 429,
  "code": "RATE_LIMITED",
  "message": "Too many requests",
  "details": {
    "retryAfterSeconds": 12
  },
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/vc/{connectionId}/content/{type}/{key}"
}

Fetch one PUBLISHED PAGE by `data.slug` for a sales channel

Returns one published page by its data.slug. Sent with Cache-Control: public, max-age=300, stale-while-revalidate=60. Limited to 120 requests per minute per IP. Checks no scope.

Path Parameters

connectionIdstring

Sales channel ID (vc_*), the canonical salesChannelId. connectionId is the deprecated name of the same value and is still the literal path segment.

slugstring

Page slug (data.slug of the page content).

Query Parameters

locale?string

Language code, for example he. Used only when no Accept-Language header is sent. A language the store does not support, or the store's default language, returns the default text.

Header Parameters

originstring

accept-language?string

X-SDK-Version?string

Version of the calling SDK (the Brainerce SDK sends it automatically). Informational: it is recorded on the channel and never changes the response.

curl -X GET "https://api.brainerce.com/api/vc/string/content/pages/by-slug/string?locale=string" \
  -H "origin: string" \
  -H "accept-language: string" \
  -H "X-SDK-Version: string"

curl -X GET "https://api.brainerce.com/api/vc/string/content/pages/by-slug/string?locale=string" \  -H "origin: string" \  -H "accept-language: string" \  -H "X-SDK-Version: string"

{
  "id": "string",
  "storeId": "string",
  "type": "FAQ",
  "key": "main",
  "name": "string",
  "description": "string",
  "salesChannelIds": [
    "string"
  ],
  "data": {},
  "customFields": {},
  "translations": {},
  "status": "PUBLISHED",
  "position": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{
  "statusCode": 403,
  "code": "INSUFFICIENT_SCOPE",
  "message": "API key does not have the required scope: products:write",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/vc/{connectionId}/content/pages/by-slug/{slug}"
}

{
  "statusCode": 404,
  "code": "RESOURCE_NOT_FOUND",
  "message": "Resource not found",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/vc/{connectionId}/content/pages/by-slug/{slug}"
}

{
  "statusCode": 429,
  "code": "RATE_LIMITED",
  "message": "Too many requests",
  "details": {
    "retryAfterSeconds": 12
  },
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/vc/{connectionId}/content/pages/by-slug/{slug}"
}

List published blog posts for a sales channel

Lists the published blog posts visible to this channel (publish date passed; a post with no channel restriction shows on every channel), most recently published first. Filter with category and tag; status, search and storeId are ignored here. Sent with Cache-Control: public, max-age=300, stale-while-revalidate=60. Limited to 120 requests per minute per IP. Checks no scope.

Path Parameters

connectionIdstring

Sales channel ID (vc_*), the canonical salesChannelId. connectionId is the deprecated name of the same value and is still the literal path segment.

Query Parameters

storeId?string

Ignored on the public routes: the store comes from the path.

page?number

Page number, starting at 1.

Default1

Range1 <= value

limit?number

Page size. The public routes cap it at 100.

Default20

Range1 <= value

status?string

Filter by status. Dashboard list only: the public routes return PUBLISHED posts whose publish date has passed, whatever is sent.

Value in"DRAFT" | "SCHEDULED" | "PUBLISHED"

category?string

Keep posts of exactly this category.

tag?string

Keep posts carrying this tag.

search?string

Case-insensitive match on the title. Dashboard list only: the public routes ignore it.

locale?string

Language code, for example he. Used only when no Accept-Language header is sent. A language the store does not support, or the store's default language, returns the default text.

Header Parameters

originstring

accept-language?string

X-SDK-Version?string

Version of the calling SDK (the Brainerce SDK sends it automatically). Informational: it is recorded on the channel and never changes the response.

curl -X GET "https://api.brainerce.com/api/vc/string/blog/posts?storeId=clstore_abc123&page=1&limit=20&status=DRAFT&category=news&tag=summer&search=sale&locale=string" \
  -H "origin: string" \
  -H "accept-language: string" \
  -H "X-SDK-Version: string"

curl -X GET "https://api.brainerce.com/api/vc/string/blog/posts?storeId=clstore_abc123&page=1&limit=20&status=DRAFT&category=news&tag=summer&search=sale&locale=string" \  -H "origin: string" \  -H "accept-language: string" \  -H "X-SDK-Version: string"

{
  "data": [
    {
      "id": "string",
      "storeId": "string",
      "title": "string",
      "slug": "summer-sale",
      "category": "string",
      "content": "string",
      "excerpt": "string",
      "coverImageUrl": "string",
      "coverImageAlt": "string",
      "author": "string",
      "tags": [
        "string"
      ],
      "metadata": {},
      "status": "PUBLISHED",
      "publishedAt": "2019-08-24T14:15:22Z",
      "seoTitle": "string",
      "seoDescription": "string",
      "ogImageUrl": "string",
      "translations": {},
      "salesChannelIds": [
        "string"
      ],
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 42,
    "totalPages": 3
  }
}

{
  "statusCode": 403,
  "code": "INSUFFICIENT_SCOPE",
  "message": "API key does not have the required scope: products:write",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/vc/{connectionId}/blog/posts"
}

{
  "statusCode": 404,
  "code": "RESOURCE_NOT_FOUND",
  "message": "Resource not found",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/vc/{connectionId}/blog/posts"
}

{
  "statusCode": 429,
  "code": "RATE_LIMITED",
  "message": "Too many requests",
  "details": {
    "retryAfterSeconds": 12
  },
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/vc/{connectionId}/blog/posts"
}

Get a published blog post by slug for a sales channel

Returns one published blog post by slug. Sent with Cache-Control: public, max-age=300, stale-while-revalidate=60. Limited to 120 requests per minute per IP. Checks no scope.

Path Parameters

connectionIdstring

Sales channel ID (vc_*), the canonical salesChannelId. connectionId is the deprecated name of the same value and is still the literal path segment.

slugstring

Blog post slug.

Query Parameters

locale?string

Language code, for example he. Used only when no Accept-Language header is sent. A language the store does not support, or the store's default language, returns the default text.

Header Parameters

originstring

accept-language?string

X-SDK-Version?string

Version of the calling SDK (the Brainerce SDK sends it automatically). Informational: it is recorded on the channel and never changes the response.

curl -X GET "https://api.brainerce.com/api/vc/string/blog/posts/string?locale=string" \
  -H "origin: string" \
  -H "accept-language: string" \
  -H "X-SDK-Version: string"

curl -X GET "https://api.brainerce.com/api/vc/string/blog/posts/string?locale=string" \  -H "origin: string" \  -H "accept-language: string" \  -H "X-SDK-Version: string"

{
  "id": "string",
  "storeId": "string",
  "title": "string",
  "slug": "summer-sale",
  "category": "string",
  "content": "string",
  "excerpt": "string",
  "coverImageUrl": "string",
  "coverImageAlt": "string",
  "author": "string",
  "tags": [
    "string"
  ],
  "metadata": {},
  "status": "PUBLISHED",
  "publishedAt": "2019-08-24T14:15:22Z",
  "seoTitle": "string",
  "seoDescription": "string",
  "ogImageUrl": "string",
  "translations": {},
  "salesChannelIds": [
    "string"
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{
  "statusCode": 403,
  "code": "INSUFFICIENT_SCOPE",
  "message": "API key does not have the required scope: products:write",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/vc/{connectionId}/blog/posts/{slug}"
}

{
  "statusCode": 404,
  "code": "RESOURCE_NOT_FOUND",
  "message": "Resource not found",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/vc/{connectionId}/blog/posts/{slug}"
}

{
  "statusCode": 429,
  "code": "RATE_LIMITED",
  "message": "Too many requests",
  "details": {
    "retryAfterSeconds": 12
  },
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/vc/{connectionId}/blog/posts/{slug}"
}

Example default

Example default

Example default

Example default

Example default

Example default

Example default

Example default

Example default

Example default

Example default

Example default

Example default

Example default

Example default

Example default

Example default