Skip to content
/Product Metadata

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

List product metadata

Request

Retrieves a paginated list of metadata entries for a product.

Security
Bearer
Path
productUuidstring(uuid)required

Unique identifier of the product.

Query
uuids[eq]Array of strings(uuid)

Filter by specific metadata entry UUIDs.

localeUuids[eq]Array of strings(uuid)

Filter by specific locale UUIDs.

type[eq]string

Filter by exact metadata type match.

type[order]string

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

key[eq]string

Filter by exact key match.

key[order]string

Sort order for key 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}/metadata?uuids%5Beq%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&localeUuids%5Beq%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&type%5Beq%5D=string&type%5Border%5D=string&key%5Beq%5D=string&key%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 metadata entries.

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

Unique identifier for this metadata entry.

items[].​productUuidstring(uuid)required

Identifier of the product this metadata belongs to.

items[].​localeUuidstring(uuid)required

Identifier of the locale this metadata is associated with.

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

Timestamp when this metadata entry was created.

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

Timestamp when this metadata entry was last modified.

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

Data type of the metadata value.

Enum"string""number""boolean""json"
items[].​keystringrequired

Metadata key identifier.

items[].​valuestringrequired

Metadata value content.

paginationobject(PaginationResult)required
pagination.​pageinteger(int32)required
pagination.​sizeinteger(int32)required
pagination.​totalItemsinteger(int32)required
pagination.​totalPagesinteger(int32)required
Response
application/json
[
  {
    "uuid": "eee55555-e89b-12d3-a456-426614174001",
    "productUuid": "123e4567-e89b-12d3-a456-426614174001",
    "localeUuid": "fff66666-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "type": "string",
    "key": "seo_title",
    "value": "Premium Wireless Headphones | Best Audio Quality"
  },
  {
    "uuid": "eee55555-e89b-12d3-a456-426614174001",
    "productUuid": "123e4567-e89b-12d3-a456-426614174001",
    "localeUuid": "fff66666-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "type": "string",
    "key": "seo_description",
    "value": "Experience crystal-clear sound with our premium wireless headphones."
  },
  {
    "uuid": "eee55555-e89b-12d3-a456-426614174001",
    "productUuid": "123e4567-e89b-12d3-a456-426614174001",
    "localeUuid": "fff66666-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "type": "boolean",
    "key": "featured",
    "value": "true"
  },
  {
    "uuid": "eee55555-e89b-12d3-a456-426614174001",
    "productUuid": "123e4567-e89b-12d3-a456-426614174001",
    "localeUuid": "fff66666-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "type": "number",
    "key": "display_priority",
    "value": "100"
  }
]

Create product metadata

Request

Creates a new metadata entry for a product.

Security
Bearer
Path
productUuidstring(uuid)required

Unique identifier of the product.

Bodyapplication/jsonrequired
localeUuidstring(uuid)required

Identifier of the locale this metadata is associated with.

typestringrequired

Data type of the metadata value.

Enum"string""number""boolean""json"
keystring[ 1 .. 255 ] charactersrequired

Metadata key identifier.

valuestring[ 1 .. 10000 ] charactersrequired

Metadata value content. Must match the specified type.

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

Responses

Metadata entry created successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this metadata entry.

productUuidstring(uuid)required

Identifier of the product this metadata belongs to.

localeUuidstring(uuid)required

Identifier of the locale this metadata is associated with.

createdAtstring(date-time)required

Timestamp when this metadata entry was created.

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

Timestamp when this metadata entry was last modified.

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

Data type of the metadata value.

Enum"string""number""boolean""json"
keystringrequired

Metadata key identifier.

valuestringrequired

Metadata value content.

Response
application/json
{
  "uuid": "eee55555-e89b-12d3-a456-426614174001",
  "productUuid": "123e4567-e89b-12d3-a456-426614174001",
  "localeUuid": "fff66666-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-20T08:15:00.000000Z",
  "type": "string",
  "key": "seo_title",
  "value": "Premium Wireless Headphones"
}

Get product metadata

Request

Retrieves a single metadata entry for a product.

Security
Bearer
Path
productUuidstring(uuid)required

Unique identifier of the product.

productMetadataUuidstring(uuid)required

Unique identifier of the metadata entry.

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

Responses

Successfully retrieved metadata entry.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this metadata entry.

productUuidstring(uuid)required

Identifier of the product this metadata belongs to.

localeUuidstring(uuid)required

Identifier of the locale this metadata is associated with.

createdAtstring(date-time)required

Timestamp when this metadata entry was created.

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

Timestamp when this metadata entry was last modified.

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

Data type of the metadata value.

Enum"string""number""boolean""json"
keystringrequired

Metadata key identifier.

valuestringrequired

Metadata value content.

Response
application/json
{
  "uuid": "eee55555-e89b-12d3-a456-426614174001",
  "productUuid": "123e4567-e89b-12d3-a456-426614174001",
  "localeUuid": "fff66666-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-20T08:15:00.000000Z",
  "type": "string",
  "key": "seo_title",
  "value": "Premium Wireless Headphones | Best Audio Quality"
}

Update product metadata

Request

Updates an existing metadata entry. Only provided fields are updated.

Security
Bearer
Path
productUuidstring(uuid)required

Unique identifier of the product.

productMetadataUuidstring(uuid)required

Unique identifier of the metadata entry.

Bodyapplication/jsonrequired
typeinteger or null(NullableOfMetadataType)

Updated data type of the metadata value.

keystring or null[ 1 .. 255 ] characters

Updated metadata key identifier.

valuestring or null[ 1 .. 10000 ] characters

Updated metadata value content.

curl -i -X PATCH \
  'https://docs.apiera.io/_mock/openapi/v1/products/{productUuid}/metadata/{productMetadataUuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": 0,
    "key": "string",
    "value": "string"
  }'

Responses

Metadata entry updated successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this metadata entry.

productUuidstring(uuid)required

Identifier of the product this metadata belongs to.

localeUuidstring(uuid)required

Identifier of the locale this metadata is associated with.

createdAtstring(date-time)required

Timestamp when this metadata entry was created.

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

Timestamp when this metadata entry was last modified.

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

Data type of the metadata value.

Enum"string""number""boolean""json"
keystringrequired

Metadata key identifier.

valuestringrequired

Metadata value content.

Response
application/json
{
  "uuid": "eee55555-e89b-12d3-a456-426614174001",
  "productUuid": "123e4567-e89b-12d3-a456-426614174001",
  "localeUuid": "fff66666-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "type": "string",
  "key": "seo_title",
  "value": "Premium Wireless Headphones - Updated"
}

Delete product metadata

Request

Permanently deletes a metadata entry.

Security
Bearer
Path
productUuidstring(uuid)required

Unique identifier of the product.

productMetadataUuidstring(uuid)required

Unique identifier of the metadata entry.

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

Responses

Metadata entry deleted successfully.

Response
No content

Bulk create product metadata

Request

Creates multiple metadata entries for a product in a single operation.

Security
Bearer
Path
productUuidstring(uuid)required

Unique identifier of the product.

Bodyapplication/jsonrequiredArray [
localeUuidstring(uuid)required

Identifier of the locale this metadata is associated with.

typestringrequired

Data type of the metadata value.

Enum"string""number""boolean""json"
keystring[ 1 .. 255 ] charactersrequired

Metadata key identifier.

valuestring[ 1 .. 10000 ] charactersrequired

Metadata value content. Must match the specified type.

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

Responses

Metadata entries created successfully.

Bodyapplication/jsonArray [
uuidstring(uuid)required

Unique identifier for this metadata entry.

productUuidstring(uuid)required

Identifier of the product this metadata belongs to.

localeUuidstring(uuid)required

Identifier of the locale this metadata is associated with.

createdAtstring(date-time)required

Timestamp when this metadata entry was created.

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

Timestamp when this metadata entry was last modified.

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

Data type of the metadata value.

Enum"string""number""boolean""json"
keystringrequired

Metadata key identifier.

valuestringrequired

Metadata value content.

]
Response
application/json
[
  {
    "uuid": "eee55555-e89b-12d3-a456-426614174001",
    "productUuid": "123e4567-e89b-12d3-a456-426614174001",
    "localeUuid": "fff66666-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "type": "string",
    "key": "seo_title",
    "value": "Premium Wireless Headphones"
  },
  {
    "uuid": "eee55555-e89b-12d3-a456-426614174001",
    "productUuid": "123e4567-e89b-12d3-a456-426614174001",
    "localeUuid": "fff66666-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "type": "string",
    "key": "seo_description",
    "value": "Experience crystal-clear sound."
  },
  {
    "uuid": "eee55555-e89b-12d3-a456-426614174001",
    "productUuid": "123e4567-e89b-12d3-a456-426614174001",
    "localeUuid": "fff66666-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "type": "boolean",
    "key": "featured",
    "value": "true"
  },
  {
    "uuid": "eee55555-e89b-12d3-a456-426614174001",
    "productUuid": "123e4567-e89b-12d3-a456-426614174001",
    "localeUuid": "fff66666-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "type": "number",
    "key": "display_priority",
    "value": "100"
  }
]

Bulk update product metadata

Request

Updates multiple metadata entries in a single operation.

Security
Bearer
Path
productUuidstring(uuid)required

Unique identifier of the product.

Bodyapplication/jsonrequiredArray [
uuidstring(uuid)required

Identifier of the metadata entry to update.

typeinteger or null(NullableOfMetadataType)

Updated data type of the metadata value.

keystring or null[ 1 .. 255 ] characters

Updated metadata key identifier.

valuestring or null[ 1 .. 10000 ] characters

Updated metadata value content.

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

Responses

Metadata entries updated successfully.

Bodyapplication/jsonArray [
uuidstring(uuid)required

Unique identifier for this metadata entry.

productUuidstring(uuid)required

Identifier of the product this metadata belongs to.

localeUuidstring(uuid)required

Identifier of the locale this metadata is associated with.

createdAtstring(date-time)required

Timestamp when this metadata entry was created.

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

Timestamp when this metadata entry was last modified.

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

Data type of the metadata value.

Enum"string""number""boolean""json"
keystringrequired

Metadata key identifier.

valuestringrequired

Metadata value content.

]
Response
application/json
[
  {
    "uuid": "eee55555-e89b-12d3-a456-426614174001",
    "productUuid": "123e4567-e89b-12d3-a456-426614174001",
    "localeUuid": "fff66666-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "type": "string",
    "key": "seo_title",
    "value": "Premium Wireless Headphones - Updated"
  },
  {
    "uuid": "eee55555-e89b-12d3-a456-426614174001",
    "productUuid": "123e4567-e89b-12d3-a456-426614174001",
    "localeUuid": "fff66666-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "type": "number",
    "key": "display_priority",
    "value": "200"
  }
]

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