Skip to content
/Brand Contents

Apiera REST API (1.0.0)

The Apiera REST API provides programmatic access to the Apiera platform, enabling seamless integration with your existing systems and workflows.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://docs.apiera.io/_mock/openapi
http://localhost:5281

Tag Contents

Operations

Tags

Operations

Skus

Operations

Sku Dimensions

Operations

Sku Weights

Operations

Family Asset Types

Operations

Family Attributes

Operations

Family Categories

Operations

Families

Operations

Family Relation Types

Operations

Product Assets

Operations

Product Asset Types

Operations

Product Attributes

Operations

Product Categories

Operations

Product Contents

Operations

Products

Operations

Product Metadata

Operations

Product Relations

Operations

Product Relation Types

Operations

Product Tags

Operations

Product Terms

Operations

Organization Members

Operations

Organizations

Operations

Organization Roles

Operations

Locales

Operations

Category Contents

Operations

Categories

Operations

Brand Contents

Operations

List brand contents

Request

Retrieves a paginated list of localized content for a brand.

Security
Bearer
Path
brandUuidstring(uuid)required

Unique identifier of the brand.

Query
uuids[eq]Array of strings(uuid)

Filter by one or more content UUIDs. Accepts multiple values.

localeUuids[eq]Array of strings(uuid)

Filter by one or more locale UUIDs. Accepts multiple values.

createdAt[eq]string(date-time)

Filter by exact creation timestamp.

Example: createdAt[eq]=2025-11-23T14:15:22.123456Z
createdAt[min]string(date-time)

Filter by minimum creation timestamp.

Example: createdAt[min]=2025-11-23T14:15:22.123456Z
createdAt[max]string(date-time)

Filter by maximum creation timestamp.

Example: createdAt[max]=2025-11-23T14:15:22.123456Z
createdAt[order]string

Sort order for creation timestamp. Values: asc, desc.

updatedAt[eq]string(date-time)

Filter by exact update timestamp.

Example: updatedAt[eq]=2025-11-23T14:15:22.123456Z
updatedAt[min]string(date-time)

Filter by minimum update timestamp.

Example: updatedAt[min]=2025-11-23T14:15:22.123456Z
updatedAt[max]string(date-time)

Filter by maximum update timestamp.

Example: updatedAt[max]=2025-11-23T14:15:22.123456Z
updatedAt[order]string

Sort order for update timestamp. Values: asc, desc.

pageinteger(int32)

Page number for pagination. Default is 1.

sizeinteger(int32)

Page size for pagination. Default is 20.

curl -i -X GET \
  'https://docs.apiera.io/_mock/openapi/v1/brands/{brandUuid}/contents?uuids%5Beq%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&localeUuids%5Beq%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&createdAt%5Beq%5D=2025-11-23T14%3A15%3A22.123456Z&createdAt%5Bmin%5D=2025-11-23T14%3A15%3A22.123456Z&createdAt%5Bmax%5D=2025-11-23T14%3A15%3A22.123456Z&createdAt%5Border%5D=string&updatedAt%5Beq%5D=2025-11-23T14%3A15%3A22.123456Z&updatedAt%5Bmin%5D=2025-11-23T14%3A15%3A22.123456Z&updatedAt%5Bmax%5D=2025-11-23T14%3A15%3A22.123456Z&updatedAt%5Border%5D=string&page=0&size=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successfully retrieved brand content.

Bodyapplication/json
itemsArray of objects(BrandContentResponse)required
items[].​uuidstring(uuid)required

Unique identifier for this brand content.

items[].​brandUuidstring(uuid)required

Identifier of the brand this content belongs to.

items[].​localeUuidstring(uuid)required

Identifier of the locale this content is localized for.

items[].​createdAtstring(date-time)required

Timestamp when this brand content was created.

Example: "2025-11-23T14:15:22.123456Z"
items[].​updatedAtstring(date-time)required

Timestamp when this brand content was last modified.

Example: "2025-11-23T14:15:22.123456Z"
items[].​labelstringrequired

Localized display label for the brand.

items[].​descriptionstring or null

Localized description of the brand.

paginationobject(PaginationResult)required
pagination.​pageinteger(int32)required
pagination.​sizeinteger(int32)required
pagination.​totalItemsinteger(int32)required
pagination.​totalPagesinteger(int32)required
Response
application/json
[
  {
    "uuid": "aaa11111-e89b-12d3-a456-426614174001",
    "brandUuid": "123e4567-e89b-12d3-a456-426614174001",
    "localeUuid": "bbb22222-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "label": "Outdoor Gear Co.",
    "description": "Adventure awaits"
  },
  {
    "uuid": "aaa11111-e89b-12d3-a456-426614174001",
    "brandUuid": "123e4567-e89b-12d3-a456-426614174001",
    "localeUuid": "bbb22222-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "label": "Outdoor Gear Co.",
    "description": "Abenteuer wartet"
  },
  {
    "uuid": "aaa11111-e89b-12d3-a456-426614174001",
    "brandUuid": "123e4567-e89b-12d3-a456-426614174001",
    "localeUuid": "bbb22222-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "label": "Outdoor Gear Co.",
    "description": "L'aventure vous attend"
  }
]

Create brand content

Request

Creates localized content for a brand.

Security
Bearer
Path
brandUuidstring(uuid)required

Unique identifier of the brand.

Bodyapplication/jsonrequired
localeUuidstring(uuid)required

Identifier of the locale for this content.

labelstring[ 1 .. 100 ] charactersrequired

Localized display label for the brand.

descriptionstring or null[ 1 .. 500 ] characters

Localized description of the brand.

curl -i -X POST \
  'https://docs.apiera.io/_mock/openapi/v1/brands/{brandUuid}/contents' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "localeUuid": "e9531088-cebd-4160-a71a-7d6c2df110a2",
    "label": "string",
    "description": "string"
  }'

Responses

Brand content created successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this brand content.

brandUuidstring(uuid)required

Identifier of the brand this content belongs to.

localeUuidstring(uuid)required

Identifier of the locale this content is localized for.

createdAtstring(date-time)required

Timestamp when this brand content was created.

Example: "2025-11-23T14:15:22.123456Z"
updatedAtstring(date-time)required

Timestamp when this brand content was last modified.

Example: "2025-11-23T14:15:22.123456Z"
labelstringrequired

Localized display label for the brand.

descriptionstring or null

Localized description of the brand.

Response
application/json
{
  "uuid": "aaa11111-e89b-12d3-a456-426614174001",
  "brandUuid": "123e4567-e89b-12d3-a456-426614174001",
  "localeUuid": "bbb22222-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-20T08:15:00.000000Z",
  "label": "Outdoor Gear Co.",
  "description": "Premium outdoor equipment and apparel"
}

Bulk create brand contents

Request

Creates multiple localized content entries for a brand in a single operation.

Security
Bearer
Path
brandUuidstring(uuid)required

Unique identifier of the brand.

Bodyapplication/jsonrequiredArray [
localeUuidstring(uuid)required

Identifier of the locale for this content.

labelstring[ 1 .. 100 ] charactersrequired

Localized display label for the brand.

descriptionstring or null[ 1 .. 500 ] characters

Localized description of the brand.

]
curl -i -X POST \
  'https://docs.apiera.io/_mock/openapi/v1/brands/{brandUuid}/contents/bulk' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "localeUuid": "e9531088-cebd-4160-a71a-7d6c2df110a2",
      "label": "string",
      "description": "string"
    }
  ]'

Responses

Brand contents created successfully.

Bodyapplication/jsonArray [
uuidstring(uuid)required

Unique identifier for this brand content.

brandUuidstring(uuid)required

Identifier of the brand this content belongs to.

localeUuidstring(uuid)required

Identifier of the locale this content is localized for.

createdAtstring(date-time)required

Timestamp when this brand content was created.

Example: "2025-11-23T14:15:22.123456Z"
updatedAtstring(date-time)required

Timestamp when this brand content was last modified.

Example: "2025-11-23T14:15:22.123456Z"
labelstringrequired

Localized display label for the brand.

descriptionstring or null

Localized description of the brand.

]
Response
application/json
[
  {
    "uuid": "aaa11111-e89b-12d3-a456-426614174001",
    "brandUuid": "123e4567-e89b-12d3-a456-426614174001",
    "localeUuid": "bbb22222-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "label": "Outdoor Gear Co.",
    "description": "Adventure awaits"
  },
  {
    "uuid": "aaa11111-e89b-12d3-a456-426614174001",
    "brandUuid": "123e4567-e89b-12d3-a456-426614174001",
    "localeUuid": "bbb22222-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "label": "Outdoor Gear Co.",
    "description": "Abenteuer wartet"
  },
  {
    "uuid": "aaa11111-e89b-12d3-a456-426614174001",
    "brandUuid": "123e4567-e89b-12d3-a456-426614174001",
    "localeUuid": "bbb22222-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "label": "Outdoor Gear Co.",
    "description": "L'aventure vous attend"
  }
]

Bulk update brand contents

Request

Updates multiple localized content entries in a single operation.

Security
Bearer
Path
brandUuidstring(uuid)required

Unique identifier of the brand.

Bodyapplication/jsonrequiredArray [
uuidstring(uuid)required

Identifier of the brand content to update.

labelstring or null[ 1 .. 100 ] characters

Updated localized display label.

descriptionstring or null[ 1 .. 500 ] characters

Updated localized description.

]
curl -i -X PATCH \
  'https://docs.apiera.io/_mock/openapi/v1/brands/{brandUuid}/contents/bulk' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "label": "string",
      "description": "string"
    }
  ]'

Responses

Brand contents updated successfully.

Bodyapplication/jsonArray [
uuidstring(uuid)required

Unique identifier for this brand content.

brandUuidstring(uuid)required

Identifier of the brand this content belongs to.

localeUuidstring(uuid)required

Identifier of the locale this content is localized for.

createdAtstring(date-time)required

Timestamp when this brand content was created.

Example: "2025-11-23T14:15:22.123456Z"
updatedAtstring(date-time)required

Timestamp when this brand content was last modified.

Example: "2025-11-23T14:15:22.123456Z"
labelstringrequired

Localized display label for the brand.

descriptionstring or null

Localized description of the brand.

]
Response
application/json
[
  {
    "uuid": "aaa11111-e89b-12d3-a456-426614174001",
    "brandUuid": "123e4567-e89b-12d3-a456-426614174001",
    "localeUuid": "bbb22222-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "label": "Outdoor Gear Company"
  },
  {
    "uuid": "aaa11111-e89b-12d3-a456-426614174001",
    "brandUuid": "123e4567-e89b-12d3-a456-426614174001",
    "localeUuid": "bbb22222-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "label": "Outdoor Gear GmbH"
  }
]

Get brand content

Request

Retrieves a single localized content entry for a brand.

Security
Bearer
Path
brandUuidstring(uuid)required

Unique identifier of the brand.

brandContentUuidstring(uuid)required

Unique identifier of the brand content.

curl -i -X GET \
  'https://docs.apiera.io/_mock/openapi/v1/brands/{brandUuid}/contents/{brandContentUuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successfully retrieved brand content.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this brand content.

brandUuidstring(uuid)required

Identifier of the brand this content belongs to.

localeUuidstring(uuid)required

Identifier of the locale this content is localized for.

createdAtstring(date-time)required

Timestamp when this brand content was created.

Example: "2025-11-23T14:15:22.123456Z"
updatedAtstring(date-time)required

Timestamp when this brand content was last modified.

Example: "2025-11-23T14:15:22.123456Z"
labelstringrequired

Localized display label for the brand.

descriptionstring or null

Localized description of the brand.

Response
application/json
{
  "uuid": "aaa11111-e89b-12d3-a456-426614174001",
  "brandUuid": "123e4567-e89b-12d3-a456-426614174001",
  "localeUuid": "bbb22222-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-20T08:15:00.000000Z",
  "label": "Outdoor Gear Co.",
  "description": "Adventure awaits"
}

Update brand content

Request

Updates localized content for a brand. Only provided fields are updated.

Security
Bearer
Path
brandUuidstring(uuid)required

Unique identifier of the brand.

brandContentUuidstring(uuid)required

Unique identifier of the brand content.

Bodyapplication/jsonrequired
labelstring or null[ 1 .. 100 ] characters

Updated localized display label.

descriptionstring or null[ 1 .. 500 ] characters

Updated localized description.

curl -i -X PATCH \
  'https://docs.apiera.io/_mock/openapi/v1/brands/{brandUuid}/contents/{brandContentUuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "label": "string",
    "description": "string"
  }'

Responses

Brand content updated successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this brand content.

brandUuidstring(uuid)required

Identifier of the brand this content belongs to.

localeUuidstring(uuid)required

Identifier of the locale this content is localized for.

createdAtstring(date-time)required

Timestamp when this brand content was created.

Example: "2025-11-23T14:15:22.123456Z"
updatedAtstring(date-time)required

Timestamp when this brand content was last modified.

Example: "2025-11-23T14:15:22.123456Z"
labelstringrequired

Localized display label for the brand.

descriptionstring or null

Localized description of the brand.

Response
application/json
{
  "uuid": "aaa11111-e89b-12d3-a456-426614174001",
  "brandUuid": "123e4567-e89b-12d3-a456-426614174001",
  "localeUuid": "bbb22222-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "label": "Outdoor Gear Company",
  "description": "Premium outdoor equipment for every adventure"
}

Delete brand content

Request

Permanently deletes localized content for a brand.

Security
Bearer
Path
brandUuidstring(uuid)required

Unique identifier of the brand.

brandContentUuidstring(uuid)required

Unique identifier of the brand content.

curl -i -X DELETE \
  'https://docs.apiera.io/_mock/openapi/v1/brands/{brandUuid}/contents/{brandContentUuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Brand content deleted successfully.

Response
No content

Brands

Operations

Attribute Contents

Operations

Attributes

Operations

Attribute Term Contents

Operations

Attribute Terms

Operations

Assets

Operations

Asset Files

Operations

Asset Metadata

Operations
© 2025 Apiera AS