Endpoint catalog
Get the published Storefront decoration
GET /api/v1/storefront-decorations/merchants/{slug}
GET /api/v1/storefront-decorations/merchants/{slug}
- operationId:
getPublicStorefrontDecoration - Stability: stable
- Authentication: None
- Idempotency: none
Parameters
| Name | In | Required | Type |
|---|---|---|---|
slug | path | Yes | string |
Request body
This operation declares no request body.
Responses and errors
| Status | Description | Schema |
|---|---|---|
200 | Successful response | #/components/schemas/PublicStorefrontDecorationResponse |
400 | Request does not match the public contract | #/components/schemas/PublicErrorResponse |
401 | Authentication failed | #/components/schemas/PublicErrorResponse |
403 | Insufficient authorization scope | #/components/schemas/PublicErrorResponse |
404 | Public resource not found | #/components/schemas/PublicErrorResponse |
409 | Idempotency or state conflict | #/components/schemas/PublicErrorResponse |
429 | Rate limited | #/components/schemas/PublicErrorResponse |
Rate limiting
The spec declares a 429 response.
The Retry-After header is not declared by the spec.
- Top-level shape:
{ data: object }
Success response schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"versionId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"tenant": {
"type": "object",
"properties": {
"slug": {
"type": "string"
},
"displayName": {
"type": "string"
}
},
"required": [
"slug",
"displayName"
],
"additionalProperties": false
},
"locale": {
"type": "string",
"enum": [
"zh-CN",
"en-US"
]
},
"market": {
"type": "string",
"enum": [
"CN",
"US"
]
},
"blocks": {
"maxItems": 32,
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"enabled": {
"default": true,
"type": "boolean"
},
"responsive": {
"default": {
"desktop": true,
"mobile": true
},
"type": "object",
"properties": {
"desktop": {
"default": true,
"type": "boolean"
},
"mobile": {
"default": true,
"type": "boolean"
}
},
"required": [
"desktop",
"mobile"
],
"additionalProperties": false
},
"theme": {
"default": {
"surface": "default",
"accent": "primary",
"density": "comfortable"
},
"type": "object",
"properties": {
"surface": {
"default": "default",
"type": "string",
"enum": [
"default",
"muted",
"elevated"
]
},
"accent": {
"default": "primary",
"type": "string",
"enum": [
"primary",
"neutral"
]
},
"density": {
"default": "comfortable",
"type": "string",
"enum": [
"compact",
"comfortable"
]
}
},
"required": [
"surface",
"accent",
"density"
],
"additionalProperties": false
},
"type": {
"type": "string",
"const": "brand_hero"
},
"title": {
"type": "object",
"properties": {
"zh-CN": {
"default": "",
"type": "string",
"maxLength": 1000
},
"en-US": {
"default": "",
"type": "string",
"maxLength": 1000
}
},
"required": [
"zh-CN",
"en-US"
],
"additionalProperties": false
},
"description": {
"type": "object",
"properties": {
"zh-CN": {
"default": "",
"type": "string",
"maxLength": 1000
},
"en-US": {
"default": "",
"type": "string",
"maxLength": 1000
}
},
"required": [
"zh-CN",
"en-US"
],
"additionalProperties": false
},
"media": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"kind": {
"type": "string",
"enum": [
"image",
"video"
]
},
"url": {
"type": "string",
"format": "uri"
},
"thumbnailUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"alt": {
"type": "string",
"maxLength": 500
},
"width": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"height": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"durationSeconds": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"kind",
"url",
"thumbnailUrl",
"alt",
"width",
"height",
"durationSeconds"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"enabled",
"responsive",
"theme",
"type",
"title",
"media"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"enabled": {
"default": true,
"type": "boolean"
},
"responsive": {
"default": {
"desktop": true,
"mobile": true
},
"type": "object",
"properties": {
"desktop": {
"default": true,
"type": "boolean"
},
"mobile": {
"default": true,
"type": "boolean"
}
},
"required": [
"desktop",
"mobile"
],
"additionalProperties": false
},
"theme": {
"default": {
"surface": "default",
"accent": "primary",
"density": "comfortable"
},
"type": "object",
"properties": {
"surface": {
"default": "default",
"type": "string",
"enum": [
"default",
"muted",
"elevated"
]
},
"accent": {
"default": "primary",
"type": "string",
"enum": [
"primary",
"neutral"
]
},
"density": {
"default": "comfortable",
"type": "string",
"enum": [
"compact",
"comfortable"
]
}
},
"required": [
"surface",
"accent",
"density"
],
"additionalProperties": false
},
"type": {
"type": "string",
"const": "notice"
},
"text": {
"type": "object",
"properties": {
"zh-CN": {
"default": "",
"type": "string",
"maxLength": 1000
},
"en-US": {
"default": "",
"type": "string",
"maxLength": 1000
}
},
"required": [
"zh-CN",
"en-US"
],
"additionalProperties": false
},
"path": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 300
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"enabled",
"responsive",
"theme",
"type",
"text"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"enabled": {
"default": true,
"type": "boolean"
},
"responsive": {
"default": {
"desktop": true,
"mobile": true
},
"type": "object",
"properties": {
"desktop": {
"default": true,
"type": "boolean"
},
"mobile": {
"default": true,
"type": "boolean"
}
},
"required": [
"desktop",
"mobile"
],
"additionalProperties": false
},
"theme": {
"default": {
"surface": "default",
"accent": "primary",
"density": "comfortable"
},
"type": "object",
"properties": {
"surface": {
"default": "default",
"type": "string",
"enum": [
"default",
"muted",
"elevated"
]
},
"accent": {
"default": "primary",
"type": "string",
"enum": [
"primary",
"neutral"
]
},
"density": {
"default": "comfortable",
"type": "string",
"enum": [
"compact",
"comfortable"
]
}
},
"required": [
"surface",
"accent",
"density"
],
"additionalProperties": false
},
"type": {
"type": "string",
"const": "image_banner"
},
"alt": {
"type": "object",
"properties": {
"zh-CN": {
"default": "",
"type": "string",
"maxLength": 1000
},
"en-US": {
"default": "",
"type": "string",
"maxLength": 1000
}
},
"required": [
"zh-CN",
"en-US"
],
"additionalProperties": false
},
"path": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 300
},
{
"type": "null"
}
]
},
"media": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"kind": {
"type": "string",
"enum": [
"image",
"video"
]
},
"url": {
"type": "string",
"format": "uri"
},
"thumbnailUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"alt": {
"type": "string",
"maxLength": 500
},
"width": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"height": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"durationSeconds": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"kind",
"url",
"thumbnailUrl",
"alt",
"width",
"height",
"durationSeconds"
],
"additionalProperties": false
}
},
"required": [
"id",
"enabled",
"responsive",
"theme",
"type",
"alt",
"media"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"enabled": {
"default": true,
"type": "boolean"
},
"responsive": {
"default": {
"desktop": true,
"mobile": true
},
"type": "object",
"properties": {
"desktop": {
"default": true,
"type": "boolean"
},
"mobile": {
"default": true,
"type": "boolean"
}
},
"required": [
"desktop",
"mobile"
],
"additionalProperties": false
},
"theme": {
"default": {
"surface": "default",
"accent": "primary",
"density": "comfortable"
},
"type": "object",
"properties": {
"surface": {
"default": "default",
"type": "string",
"enum": [
"default",
"muted",
"elevated"
]
},
"accent": {
"default": "primary",
"type": "string",
"enum": [
"primary",
"neutral"
]
},
"density": {
"default": "comfortable",
"type": "string",
"enum": [
"compact",
"comfortable"
]
}
},
"required": [
"surface",
"accent",
"density"
],
"additionalProperties": false
},
"type": {
"type": "string",
"const": "product_collection"
},
"title": {
"type": "object",
"properties": {
"zh-CN": {
"default": "",
"type": "string",
"maxLength": 1000
},
"en-US": {
"default": "",
"type": "string",
"maxLength": 1000
}
},
"required": [
"zh-CN",
"en-US"
],
"additionalProperties": false
},
"products": {
"maxItems": 24,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 300
},
"imageUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"kind": {
"type": "string",
"enum": [
"physical",
"digital"
]
},
"price": {
"anyOf": [
{
"type": "object",
"properties": {
"amount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"currency": {
"type": "string",
"enum": [
"CNY",
"USD"
]
}
},
"required": [
"amount",
"currency"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"slug",
"title",
"imageUrl",
"kind",
"price"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"enabled",
"responsive",
"theme",
"type",
"title",
"products"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"enabled": {
"default": true,
"type": "boolean"
},
"responsive": {
"default": {
"desktop": true,
"mobile": true
},
"type": "object",
"properties": {
"desktop": {
"default": true,
"type": "boolean"
},
"mobile": {
"default": true,
"type": "boolean"
}
},
"required": [
"desktop",
"mobile"
],
"additionalProperties": false
},
"theme": {
"default": {
"surface": "default",
"accent": "primary",
"density": "comfortable"
},
"type": "object",
"properties": {
"surface": {
"default": "default",
"type": "string",
"enum": [
"default",
"muted",
"elevated"
]
},
"accent": {
"default": "primary",
"type": "string",
"enum": [
"primary",
"neutral"
]
},
"density": {
"default": "comfortable",
"type": "string",
"enum": [
"compact",
"comfortable"
]
}
},
"required": [
"surface",
"accent",
"density"
],
"additionalProperties": false
},
"type": {
"type": "string",
"const": "category_navigation"
},
"title": {
"type": "object",
"properties": {
"zh-CN": {
"default": "",
"type": "string",
"maxLength": 1000
},
"en-US": {
"default": "",
"type": "string",
"maxLength": 1000
}
},
"required": [
"zh-CN",
"en-US"
],
"additionalProperties": false
},
"categories": {
"maxItems": 16,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"id",
"slug",
"title"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"enabled",
"responsive",
"theme",
"type",
"categories"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"enabled": {
"default": true,
"type": "boolean"
},
"responsive": {
"default": {
"desktop": true,
"mobile": true
},
"type": "object",
"properties": {
"desktop": {
"default": true,
"type": "boolean"
},
"mobile": {
"default": true,
"type": "boolean"
}
},
"required": [
"desktop",
"mobile"
],
"additionalProperties": false
},
"theme": {
"default": {
"surface": "default",
"accent": "primary",
"density": "comfortable"
},
"type": "object",
"properties": {
"surface": {
"default": "default",
"type": "string",
"enum": [
"default",
"muted",
"elevated"
]
},
"accent": {
"default": "primary",
"type": "string",
"enum": [
"primary",
"neutral"
]
},
"density": {
"default": "comfortable",
"type": "string",
"enum": [
"compact",
"comfortable"
]
}
},
"required": [
"surface",
"accent",
"density"
],
"additionalProperties": false
},
"type": {
"type": "string",
"const": "rich_content"
},
"items": {
"minItems": 1,
"maxItems": 80,
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "heading"
},
"text": {
"type": "object",
"properties": {
"zh-CN": {
"default": "",
"type": "string",
"maxLength": 1000
},
"en-US": {
"default": "",
"type": "string",
"maxLength": 1000
}
},
"required": [
"zh-CN",
"en-US"
],
"additionalProperties": false
},
"level": {
"type": "string",
"enum": [
"2",
"3"
]
}
},
"required": [
"type",
"text",
"level"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "paragraph"
},
"text": {
"type": "object",
"properties": {
"zh-CN": {
"default": "",
"type": "string",
"maxLength": 1000
},
"en-US": {
"default": "",
"type": "string",
"maxLength": 1000
}
},
"required": [
"zh-CN",
"en-US"
],
"additionalProperties": false
}
},
"required": [
"type",
"text"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "list"
},
"items": {
"minItems": 1,
"maxItems": 20,
"type": "array",
"items": {
"type": "object",
"properties": {
"zh-CN": {
"default": "",
"type": "string",
"maxLength": 1000
},
"en-US": {
"default": "",
"type": "string",
"maxLength": 1000
}
},
"required": [
"zh-CN",
"en-US"
],
"additionalProperties": false
}
},
"ordered": {
"default": false,
"type": "boolean"
}
},
"required": [
"type",
"items",
"ordered"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "link"
},
"label": {
"type": "object",
"properties": {
"zh-CN": {
"default": "",
"type": "string",
"maxLength": 1000
},
"en-US": {
"default": "",
"type": "string",
"maxLength": 1000
}
},
"required": [
"zh-CN",
"en-US"
],
"additionalProperties": false
},
"path": {
"type": "string",
"minLength": 1,
"maxLength": 300
}
},
"required": [
"type",
"label",
"path"
],
"additionalProperties": false
}
]
}
}
},
"required": [
"id",
"enabled",
"responsive",
"theme",
"type",
"items"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"enabled": {
"default": true,
"type": "boolean"
},
"responsive": {
"default": {
"desktop": true,
"mobile": true
},
"type": "object",
"properties": {
"desktop": {
"default": true,
"type": "boolean"
},
"mobile": {
"default": true,
"type": "boolean"
}
},
"required": [
"desktop",
"mobile"
],
"additionalProperties": false
},
"theme": {
"default": {
"surface": "default",
"accent": "primary",
"density": "comfortable"
},
"type": "object",
"properties": {
"surface": {
"default": "default",
"type": "string",
"enum": [
"default",
"muted",
"elevated"
]
},
"accent": {
"default": "primary",
"type": "string",
"enum": [
"primary",
"neutral"
]
},
"density": {
"default": "comfortable",
"type": "string",
"enum": [
"compact",
"comfortable"
]
}
},
"required": [
"surface",
"accent",
"density"
],
"additionalProperties": false
},
"type": {
"type": "string",
"const": "video"
},
"title": {
"type": "object",
"properties": {
"zh-CN": {
"default": "",
"type": "string",
"maxLength": 1000
},
"en-US": {
"default": "",
"type": "string",
"maxLength": 1000
}
},
"required": [
"zh-CN",
"en-US"
],
"additionalProperties": false
},
"description": {
"type": "object",
"properties": {
"zh-CN": {
"default": "",
"type": "string",
"maxLength": 1000
},
"en-US": {
"default": "",
"type": "string",
"maxLength": 1000
}
},
"required": [
"zh-CN",
"en-US"
],
"additionalProperties": false
},
"media": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"kind": {
"type": "string",
"enum": [
"image",
"video"
]
},
"url": {
"type": "string",
"format": "uri"
},
"thumbnailUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"alt": {
"type": "string",
"maxLength": 500
},
"width": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"height": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"durationSeconds": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"kind",
"url",
"thumbnailUrl",
"alt",
"width",
"height",
"durationSeconds"
],
"additionalProperties": false
},
"poster": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"kind": {
"type": "string",
"enum": [
"image",
"video"
]
},
"url": {
"type": "string",
"format": "uri"
},
"thumbnailUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"alt": {
"type": "string",
"maxLength": 500
},
"width": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"height": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"durationSeconds": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"kind",
"url",
"thumbnailUrl",
"alt",
"width",
"height",
"durationSeconds"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"enabled",
"responsive",
"theme",
"type",
"title",
"media",
"poster"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"enabled": {
"default": true,
"type": "boolean"
},
"responsive": {
"default": {
"desktop": true,
"mobile": true
},
"type": "object",
"properties": {
"desktop": {
"default": true,
"type": "boolean"
},
"mobile": {
"default": true,
"type": "boolean"
}
},
"required": [
"desktop",
"mobile"
],
"additionalProperties": false
},
"theme": {
"default": {
"surface": "default",
"accent": "primary",
"density": "comfortable"
},
"type": "object",
"properties": {
"surface": {
"default": "default",
"type": "string",
"enum": [
"default",
"muted",
"elevated"
]
},
"accent": {
"default": "primary",
"type": "string",
"enum": [
"primary",
"neutral"
]
},
"density": {
"default": "comfortable",
"type": "string",
"enum": [
"compact",
"comfortable"
]
}
},
"required": [
"surface",
"accent",
"density"
],
"additionalProperties": false
},
"type": {
"type": "string",
"const": "campaign_entry"
},
"title": {
"type": "object",
"properties": {
"zh-CN": {
"default": "",
"type": "string",
"maxLength": 1000
},
"en-US": {
"default": "",
"type": "string",
"maxLength": 1000
}
},
"required": [
"zh-CN",
"en-US"
],
"additionalProperties": false
},
"description": {
"type": "object",
"properties": {
"zh-CN": {
"default": "",
"type": "string",
"maxLength": 1000
},
"en-US": {
"default": "",
"type": "string",
"maxLength": 1000
}
},
"required": [
"zh-CN",
"en-US"
],
"additionalProperties": false
},
"actionLabel": {
"type": "object",
"properties": {
"zh-CN": {
"default": "",
"type": "string",
"maxLength": 1000
},
"en-US": {
"default": "",
"type": "string",
"maxLength": 1000
}
},
"required": [
"zh-CN",
"en-US"
],
"additionalProperties": false
},
"path": {
"type": "string",
"minLength": 1,
"maxLength": 300
}
},
"required": [
"id",
"enabled",
"responsive",
"theme",
"type",
"title",
"actionLabel",
"path"
],
"additionalProperties": false
}
]
}
},
"publishedAt": {
"type": "string",
"format": "date-time",
"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))$"
}
},
"required": [
"versionId",
"version",
"tenant",
"locale",
"market",
"blocks",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
Error response schema
{
"$ref": "#/components/schemas/PublicErrorResponse"
}
Generated from the verified public-only OpenAPI artifact; no speculative request example is provided.