Skip to content
/Product Relations

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

List product relations

Request

Retrieves a paginated list of relations for a product.

Security
Bearer
Path
productUuidstring(uuid)required

Unique identifier of the product.

Query
uuids[eq]Array of strings(uuid)

Filter by specific relation UUIDs.

productReferenceUuids[eq]Array of strings(uuid)

Filter by target product UUIDs.

productRelationTypeUuids[eq]Array of strings(uuid)

Filter by product relation type UUIDs.

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}/relations?uuids%5Beq%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&productReferenceUuids%5Beq%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&productRelationTypeUuids%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 product relations.

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

Unique identifier for this product relation.

items[].​productUuidstring(uuid)required

Identifier of the source product owning this relation.

items[].​productReferenceUuidstring(uuid)required

Identifier of the target product being referenced.

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

Timestamp when this relation was created.

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

Timestamp when this relation was last modified.

Example: "2025-11-23T14:15:22.123456Z"
items[].​productRelationTypeUuidstring(uuid)required

Identifier of the product relation type.

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",
    "productUuid": "123e4567-e89b-12d3-a456-426614174001",
    "productReferenceUuid": "22222222-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "productRelationTypeUuid": "aaaa1111-e89b-12d3-a456-426614174001"
  },
  {
    "uuid": "aaa11111-e89b-12d3-a456-426614174001",
    "productUuid": "123e4567-e89b-12d3-a456-426614174001",
    "productReferenceUuid": "33333333-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "productRelationTypeUuid": "bbbb2222-e89b-12d3-a456-426614174001"
  },
  {
    "uuid": "aaa11111-e89b-12d3-a456-426614174001",
    "productUuid": "123e4567-e89b-12d3-a456-426614174001",
    "productReferenceUuid": "44444444-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "productRelationTypeUuid": "cccc3333-e89b-12d3-a456-426614174001"
  }
]

Link products

Request

Creates a relationship between two products.

Security
Bearer
Path
productUuidstring(uuid)required

Unique identifier of the source product.

Bodyapplication/jsonrequired
productReferenceUuidstring(uuid)required

Identifier of the target product to relate to.

productRelationTypeUuidstring(uuid)required

Identifier of the product relation type.

curl -i -X POST \
  'https://docs.apiera.io/_mock/openapi/v1/products/{productUuid}/relations' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "productReferenceUuid": "e85293aa-b630-45ca-b862-9c70685c4933",
    "productRelationTypeUuid": "7834a835-50d6-4e97-8a63-309dc16472d4"
  }'

Responses

Product relation created successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this product relation.

productUuidstring(uuid)required

Identifier of the source product owning this relation.

productReferenceUuidstring(uuid)required

Identifier of the target product being referenced.

createdAtstring(date-time)required

Timestamp when this relation was created.

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

Timestamp when this relation was last modified.

Example: "2025-11-23T14:15:22.123456Z"
productRelationTypeUuidstring(uuid)required

Identifier of the product relation type.

Response
application/json
{
  "uuid": "aaa11111-e89b-12d3-a456-426614174001",
  "productUuid": "123e4567-e89b-12d3-a456-426614174001",
  "productReferenceUuid": "22222222-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-20T08:15:00.000000Z",
  "productRelationTypeUuid": "aaaa1111-e89b-12d3-a456-426614174001"
}

Get product relation

Request

Retrieves a single relation for a product.

Security
Bearer
Path
productUuidstring(uuid)required

Unique identifier of the product.

productRelationUuidstring(uuid)required

Unique identifier of the relation.

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

Responses

Successfully retrieved product relation.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this product relation.

productUuidstring(uuid)required

Identifier of the source product owning this relation.

productReferenceUuidstring(uuid)required

Identifier of the target product being referenced.

createdAtstring(date-time)required

Timestamp when this relation was created.

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

Timestamp when this relation was last modified.

Example: "2025-11-23T14:15:22.123456Z"
productRelationTypeUuidstring(uuid)required

Identifier of the product relation type.

Response
application/json
{
  "uuid": "aaa11111-e89b-12d3-a456-426614174001",
  "productUuid": "123e4567-e89b-12d3-a456-426614174001",
  "productReferenceUuid": "22222222-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-20T08:15:00.000000Z",
  "productRelationTypeUuid": "aaaa1111-e89b-12d3-a456-426614174001"
}

Update product relation

Request

Updates an existing product relation. Only provided fields are updated.

Security
Bearer
Path
productUuidstring(uuid)required

Unique identifier of the product.

productRelationUuidstring(uuid)required

Unique identifier of the relation.

Bodyapplication/jsonrequired
productRelationTypeUuidstring or null(uuid)

Updated product relation type identifier.

curl -i -X PATCH \
  'https://docs.apiera.io/_mock/openapi/v1/products/{productUuid}/relations/{productRelationUuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "productRelationTypeUuid": "7834a835-50d6-4e97-8a63-309dc16472d4"
  }'

Responses

Product relation updated successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this product relation.

productUuidstring(uuid)required

Identifier of the source product owning this relation.

productReferenceUuidstring(uuid)required

Identifier of the target product being referenced.

createdAtstring(date-time)required

Timestamp when this relation was created.

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

Timestamp when this relation was last modified.

Example: "2025-11-23T14:15:22.123456Z"
productRelationTypeUuidstring(uuid)required

Identifier of the product relation type.

Response
application/json
{
  "uuid": "aaa11111-e89b-12d3-a456-426614174001",
  "productUuid": "123e4567-e89b-12d3-a456-426614174001",
  "productReferenceUuid": "22222222-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "productRelationTypeUuid": "dddd4444-e89b-12d3-a456-426614174001"
}

Unlink products

Request

Permanently removes a relationship between products.

Security
Bearer
Path
productUuidstring(uuid)required

Unique identifier of the product.

productRelationUuidstring(uuid)required

Unique identifier of the relation.

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

Responses

Product relation removed successfully.

Response
No content

Bulk link products

Request

Creates multiple product relationships in a single operation.

Security
Bearer
Path
productUuidstring(uuid)required

Unique identifier of the source product.

Bodyapplication/jsonrequiredArray [
productReferenceUuidstring(uuid)required

Identifier of the target product to relate to.

productRelationTypeUuidstring(uuid)required

Identifier of the product relation type.

]
curl -i -X POST \
  'https://docs.apiera.io/_mock/openapi/v1/products/{productUuid}/relations/bulk' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "productReferenceUuid": "e85293aa-b630-45ca-b862-9c70685c4933",
      "productRelationTypeUuid": "7834a835-50d6-4e97-8a63-309dc16472d4"
    }
  ]'

Responses

Product relations created successfully.

Bodyapplication/jsonArray [
uuidstring(uuid)required

Unique identifier for this product relation.

productUuidstring(uuid)required

Identifier of the source product owning this relation.

productReferenceUuidstring(uuid)required

Identifier of the target product being referenced.

createdAtstring(date-time)required

Timestamp when this relation was created.

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

Timestamp when this relation was last modified.

Example: "2025-11-23T14:15:22.123456Z"
productRelationTypeUuidstring(uuid)required

Identifier of the product relation type.

]
Response
application/json
[
  {
    "uuid": "aaa11111-e89b-12d3-a456-426614174001",
    "productUuid": "123e4567-e89b-12d3-a456-426614174001",
    "productReferenceUuid": "22222222-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "productRelationTypeUuid": "aaaa1111-e89b-12d3-a456-426614174001"
  },
  {
    "uuid": "aaa11111-e89b-12d3-a456-426614174001",
    "productUuid": "123e4567-e89b-12d3-a456-426614174001",
    "productReferenceUuid": "33333333-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "productRelationTypeUuid": "bbbb2222-e89b-12d3-a456-426614174001"
  },
  {
    "uuid": "aaa11111-e89b-12d3-a456-426614174001",
    "productUuid": "123e4567-e89b-12d3-a456-426614174001",
    "productReferenceUuid": "44444444-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "productRelationTypeUuid": "cccc3333-e89b-12d3-a456-426614174001"
  }
]

Bulk update product relations

Request

Updates multiple product relations in a single operation.

Security
Bearer
Path
productUuidstring(uuid)required

Unique identifier of the product.

Bodyapplication/jsonrequiredArray [
uuidstring(uuid)required

Identifier of the relation to update.

productRelationTypeUuidstring or null(uuid)

Updated product relation type identifier.

]
curl -i -X PATCH \
  'https://docs.apiera.io/_mock/openapi/v1/products/{productUuid}/relations/bulk' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "productRelationTypeUuid": "7834a835-50d6-4e97-8a63-309dc16472d4"
    }
  ]'

Responses

Product relations updated successfully.

Bodyapplication/jsonArray [
uuidstring(uuid)required

Unique identifier for this product relation.

productUuidstring(uuid)required

Identifier of the source product owning this relation.

productReferenceUuidstring(uuid)required

Identifier of the target product being referenced.

createdAtstring(date-time)required

Timestamp when this relation was created.

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

Timestamp when this relation was last modified.

Example: "2025-11-23T14:15:22.123456Z"
productRelationTypeUuidstring(uuid)required

Identifier of the product relation type.

]
Response
application/json
[
  {
    "uuid": "aaa11111-e89b-12d3-a456-426614174001",
    "productUuid": "123e4567-e89b-12d3-a456-426614174001",
    "productReferenceUuid": "22222222-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "productRelationTypeUuid": "dddd4444-e89b-12d3-a456-426614174001"
  },
  {
    "uuid": "aaa11111-e89b-12d3-a456-426614174001",
    "productUuid": "123e4567-e89b-12d3-a456-426614174001",
    "productReferenceUuid": "33333333-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "productRelationTypeUuid": "eeee5555-e89b-12d3-a456-426614174001"
  }
]

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