Skip to content
/Product 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

List product content

Request

Retrieves a paginated list of localized content entries for a product.

Security
Bearer
Path
productUuidstring(uuid)required

Unique identifier of the product.

Query
uuids[eq]Array of strings(uuid)

Filter by content UUIDs. Accepts multiple values.

localeUuids[eq]Array of strings(uuid)

Filter by locale UUIDs. Accepts multiple values.

label[eq]string

Filter by exact label match.

label[order]string

Sort order for label field. Values: asc, desc.

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/products/{productUuid}/contents?uuids%5Beq%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&localeUuids%5Beq%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&label%5Beq%5D=string&label%5Border%5D=string&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 product content.

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

Unique identifier for this content entry.

items[].​productUuidstring(uuid)required

Identifier of the product this content belongs to.

items[].​localeUuidstring(uuid)required

Identifier of the locale for this content.

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

Timestamp when this content was created.

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

Timestamp when this content was last modified.

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

Localized display label for the product.

items[].​descriptionstring or null

Localized detailed description for the product.

items[].​shortDescriptionstring or null

Localized short description for the product.

paginationobject(PaginationResult)required
pagination.​pageinteger(int32)required
pagination.​sizeinteger(int32)required
pagination.​totalItemsinteger(int32)required
pagination.​totalPagesinteger(int32)required
Response
application/json
[
  {
    "uuid": "ccc11111-e89b-12d3-a456-426614174001",
    "productUuid": "789e0123-e89b-12d3-a456-426614174001",
    "localeUuid": "456e7890-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "label": "Classic Cotton T-Shirt",
    "description": "A comfortable everyday essential made from 100% organic cotton.",
    "shortDescription": "Soft organic cotton tee"
  },
  {
    "uuid": "ccc11111-e89b-12d3-a456-426614174001",
    "productUuid": "789e0123-e89b-12d3-a456-426614174001",
    "localeUuid": "456e7890-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "label": "Klassisches Baumwoll-T-Shirt",
    "description": "Ein bequemes Alltagskleidungsstuck aus 100% Bio-Baumwolle.",
    "shortDescription": "Weiches Bio-Baumwoll-T-Shirt"
  },
  {
    "uuid": "ccc11111-e89b-12d3-a456-426614174001",
    "productUuid": "789e0123-e89b-12d3-a456-426614174001",
    "localeUuid": "456e7890-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "label": "T-shirt classique en coton",
    "description": "Un essentiel quotidien confortable en 100% coton biologique.",
    "shortDescription": "T-shirt doux en coton bio"
  }
]

Create product content

Request

Creates localized content for a product in a specific locale.

Security
Bearer
Path
productUuidstring(uuid)required

Unique identifier of the product.

Bodyapplication/jsonrequired
localeUuidstring(uuid)required

Identifier of the locale for this content.

labelstring[ 3 .. 150 ] charactersrequired

Localized display label for the product.

descriptionstring or null[ 3 .. 10000 ] characters

Localized detailed description for the product.

shortDescriptionstring or null[ 3 .. 1000 ] characters

Localized short description for the product.

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

Responses

Content created successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this content entry.

productUuidstring(uuid)required

Identifier of the product this content belongs to.

localeUuidstring(uuid)required

Identifier of the locale for this content.

createdAtstring(date-time)required

Timestamp when this content was created.

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

Timestamp when this content was last modified.

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

Localized display label for the product.

descriptionstring or null

Localized detailed description for the product.

shortDescriptionstring or null

Localized short description for the product.

Response
application/json
{
  "uuid": "ccc11111-e89b-12d3-a456-426614174001",
  "productUuid": "789e0123-e89b-12d3-a456-426614174001",
  "localeUuid": "456e7890-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-20T08:15:00.000000Z",
  "label": "Classic Cotton T-Shirt",
  "description": "A comfortable everyday essential made from 100% organic cotton.",
  "shortDescription": "Soft organic cotton tee"
}

Get product content

Request

Retrieves a single localized content entry for a product.

Security
Bearer
Path
productUuidstring(uuid)required

Unique identifier of the product.

productContentUuidstring(uuid)required

Unique identifier of the content entry.

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

Responses

Successfully retrieved product content.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this content entry.

productUuidstring(uuid)required

Identifier of the product this content belongs to.

localeUuidstring(uuid)required

Identifier of the locale for this content.

createdAtstring(date-time)required

Timestamp when this content was created.

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

Timestamp when this content was last modified.

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

Localized display label for the product.

descriptionstring or null

Localized detailed description for the product.

shortDescriptionstring or null

Localized short description for the product.

Response
application/json
{
  "uuid": "ccc11111-e89b-12d3-a456-426614174001",
  "productUuid": "789e0123-e89b-12d3-a456-426614174001",
  "localeUuid": "456e7890-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-20T08:15:00.000000Z",
  "label": "Classic Cotton T-Shirt",
  "description": "A comfortable everyday essential made from 100% organic cotton.",
  "shortDescription": "Soft organic cotton tee"
}

Update product content

Request

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

Security
Bearer
Path
productUuidstring(uuid)required

Unique identifier of the product.

productContentUuidstring(uuid)required

Unique identifier of the content entry.

Bodyapplication/jsonrequired
labelstring or null[ 3 .. 150 ] characters

Updated localized display label.

descriptionstring or null[ 3 .. 10000 ] characters

Updated localized detailed description.

shortDescriptionstring or null[ 3 .. 1000 ] characters

Updated localized short description.

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

Responses

Content updated successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this content entry.

productUuidstring(uuid)required

Identifier of the product this content belongs to.

localeUuidstring(uuid)required

Identifier of the locale for this content.

createdAtstring(date-time)required

Timestamp when this content was created.

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

Timestamp when this content was last modified.

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

Localized display label for the product.

descriptionstring or null

Localized detailed description for the product.

shortDescriptionstring or null

Localized short description for the product.

Response
application/json
{
  "uuid": "ccc11111-e89b-12d3-a456-426614174001",
  "productUuid": "789e0123-e89b-12d3-a456-426614174001",
  "localeUuid": "456e7890-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "label": "Premium Cotton T-Shirt",
  "description": "An upgraded everyday essential made from 100% organic cotton.",
  "shortDescription": "Premium organic cotton tee"
}

Delete product content

Request

Permanently deletes localized content for a product.

Security
Bearer
Path
productUuidstring(uuid)required

Unique identifier of the product.

productContentUuidstring(uuid)required

Unique identifier of the content entry.

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

Responses

Content deleted successfully.

Response
No content

Bulk create product content

Request

Creates localized content for multiple locales in a single operation.

Security
Bearer
Path
productUuidstring(uuid)required

Unique identifier of the product.

Bodyapplication/jsonrequiredArray [
localeUuidstring(uuid)required

Identifier of the locale for this content.

labelstring[ 3 .. 150 ] charactersrequired

Localized display label for the product.

descriptionstring or null[ 3 .. 10000 ] characters

Localized detailed description for the product.

shortDescriptionstring or null[ 3 .. 1000 ] characters

Localized short description for the product.

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

Responses

Content created successfully.

Bodyapplication/jsonArray [
uuidstring(uuid)required

Unique identifier for this content entry.

productUuidstring(uuid)required

Identifier of the product this content belongs to.

localeUuidstring(uuid)required

Identifier of the locale for this content.

createdAtstring(date-time)required

Timestamp when this content was created.

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

Timestamp when this content was last modified.

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

Localized display label for the product.

descriptionstring or null

Localized detailed description for the product.

shortDescriptionstring or null

Localized short description for the product.

]
Response
application/json
[
  {
    "uuid": "ccc11111-e89b-12d3-a456-426614174001",
    "productUuid": "789e0123-e89b-12d3-a456-426614174001",
    "localeUuid": "456e7890-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "label": "Classic Cotton T-Shirt",
    "description": "A comfortable everyday essential.",
    "shortDescription": "Soft organic cotton tee"
  },
  {
    "uuid": "ccc11111-e89b-12d3-a456-426614174001",
    "productUuid": "789e0123-e89b-12d3-a456-426614174001",
    "localeUuid": "456e7890-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "label": "Klassisches Baumwoll-T-Shirt",
    "description": "Ein bequemes Alltagskleidungsstuck.",
    "shortDescription": "Weiches Bio-Baumwoll-T-Shirt"
  },
  {
    "uuid": "ccc11111-e89b-12d3-a456-426614174001",
    "productUuid": "789e0123-e89b-12d3-a456-426614174001",
    "localeUuid": "456e7890-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "label": "T-shirt classique en coton",
    "description": "Un essentiel quotidien confortable.",
    "shortDescription": "T-shirt doux en coton bio"
  }
]

Bulk update product content

Request

Updates multiple localized content entries in a single operation.

Security
Bearer
Path
productUuidstring(uuid)required

Unique identifier of the product.

Bodyapplication/jsonrequiredArray [
uuidstring(uuid)required

Identifier of the content entry to update.

labelstring or null[ 3 .. 150 ] characters

Updated localized display label.

descriptionstring or null[ 3 .. 10000 ] characters

Updated localized detailed description.

shortDescriptionstring or null[ 3 .. 1000 ] characters

Updated localized short description.

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

Responses

Content updated successfully.

Bodyapplication/jsonArray [
uuidstring(uuid)required

Unique identifier for this content entry.

productUuidstring(uuid)required

Identifier of the product this content belongs to.

localeUuidstring(uuid)required

Identifier of the locale for this content.

createdAtstring(date-time)required

Timestamp when this content was created.

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

Timestamp when this content was last modified.

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

Localized display label for the product.

descriptionstring or null

Localized detailed description for the product.

shortDescriptionstring or null

Localized short description for the product.

]
Response
application/json
[
  {
    "uuid": "ccc11111-e89b-12d3-a456-426614174001",
    "productUuid": "789e0123-e89b-12d3-a456-426614174001",
    "localeUuid": "456e7890-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "label": "Premium Cotton T-Shirt",
    "description": "An upgraded everyday essential.",
    "shortDescription": "Premium organic cotton tee"
  },
  {
    "uuid": "ccc11111-e89b-12d3-a456-426614174001",
    "productUuid": "789e0123-e89b-12d3-a456-426614174001",
    "localeUuid": "456e7890-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "label": "Premium Baumwoll-T-Shirt",
    "description": "Ein verbessertes Alltagskleidungsstuck.",
    "shortDescription": "Premium Bio-Baumwoll-T-Shirt"
  }
]

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

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