Skip to content
/Family Relation Types

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

List family relation types

Request

Retrieves a paginated list of relation type associations for a family.

Security
Bearer
Path
familyUuidstring(uuid)required

Unique identifier of the family.

Query
pageinteger(int32)

Page number for pagination. Default is 1.

Default 1
sizeinteger(int32)

Page size for pagination. Default is 20.

Default 20
curl -i -X GET \
  'https://docs.apiera.io/_mock/openapi/v1/families/{familyUuid}/relation-types?page=1&size=20' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successfully retrieved relation type associations.

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

Unique identifier for this family-relation type association.

items[].​familyUuidstring(uuid)required

Identifier of the family this association belongs to.

items[].​productRelationTypeUuidstring(uuid)required

Identifier of the product relation type that is associated.

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

Timestamp when the association was created.

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

Timestamp when the association was last modified.

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

Whether relations of this type are required for products in this family.

items[].​minCountinteger(int32)required

Minimum number of relations of this type required.

items[].​maxCountinteger or null(int32)required

Maximum number of relations of this type allowed. Null means unlimited.

paginationobject(PaginationResult)required
pagination.​pageinteger(int32)required
pagination.​sizeinteger(int32)required
pagination.​totalItemsinteger(int32)required
pagination.​totalPagesinteger(int32)required
Response
application/json
[
  {
    "uuid": "bbb22222-e89b-12d3-a456-426614174001",
    "familyUuid": "123e4567-e89b-12d3-a456-426614174001",
    "productRelationTypeUuid": "ddd44444-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "isRequired": true,
    "minCount": 1,
    "maxCount": 5
  },
  {
    "uuid": "bbb22222-e89b-12d3-a456-426614174001",
    "familyUuid": "123e4567-e89b-12d3-a456-426614174001",
    "productRelationTypeUuid": "ddd44444-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "isRequired": false,
    "minCount": 0,
    "maxCount": 10
  }
]

Associate relation type with family

Request

Creates a new relation type association for a family.

Security
Bearer
Path
familyUuidstring(uuid)required

Unique identifier of the family.

Bodyapplication/jsonrequired
productRelationTypeUuidstring(uuid)required

Identifier of the product relation type to associate.

isRequiredbooleanrequired

Whether relations of this type are required for products in this family.

minCountinteger(int32)required

Minimum number of relations of this type required.

maxCountinteger or null(int32)required

Maximum number of relations of this type allowed. Null means unlimited.

curl -i -X POST \
  'https://docs.apiera.io/_mock/openapi/v1/families/{familyUuid}/relation-types' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "productRelationTypeUuid": "7834a835-50d6-4e97-8a63-309dc16472d4",
    "isRequired": true,
    "minCount": 0,
    "maxCount": 0
  }'

Responses

Relation type association created successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this family-relation type association.

familyUuidstring(uuid)required

Identifier of the family this association belongs to.

productRelationTypeUuidstring(uuid)required

Identifier of the product relation type that is associated.

createdAtstring(date-time)required

Timestamp when the association was created.

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

Timestamp when the association was last modified.

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

Whether relations of this type are required for products in this family.

minCountinteger(int32)required

Minimum number of relations of this type required.

maxCountinteger or null(int32)required

Maximum number of relations of this type allowed. Null means unlimited.

Response
application/json
{
  "uuid": "bbb22222-e89b-12d3-a456-426614174001",
  "familyUuid": "123e4567-e89b-12d3-a456-426614174001",
  "productRelationTypeUuid": "ddd44444-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-20T08:15:00.000000Z",
  "isRequired": true,
  "minCount": 1,
  "maxCount": 5
}

Get family relation type association

Request

Retrieves a single relation type association for a family.

Security
Bearer
Path
familyUuidstring(uuid)required

Unique identifier of the family.

familyRelationTypeUuidstring(uuid)required

Unique identifier of the relation type association.

curl -i -X GET \
  'https://docs.apiera.io/_mock/openapi/v1/families/{familyUuid}/relation-types/{familyRelationTypeUuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successfully retrieved relation type association.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this family-relation type association.

familyUuidstring(uuid)required

Identifier of the family this association belongs to.

productRelationTypeUuidstring(uuid)required

Identifier of the product relation type that is associated.

createdAtstring(date-time)required

Timestamp when the association was created.

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

Timestamp when the association was last modified.

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

Whether relations of this type are required for products in this family.

minCountinteger(int32)required

Minimum number of relations of this type required.

maxCountinteger or null(int32)required

Maximum number of relations of this type allowed. Null means unlimited.

Response
application/json
{
  "uuid": "bbb22222-e89b-12d3-a456-426614174001",
  "familyUuid": "123e4567-e89b-12d3-a456-426614174001",
  "productRelationTypeUuid": "ddd44444-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-20T08:15:00.000000Z",
  "isRequired": true,
  "minCount": 1,
  "maxCount": 5
}

Update family relation type association

Request

Updates an existing relation type association. Only provided fields are updated.

Security
Bearer
Path
familyUuidstring(uuid)required

Unique identifier of the family.

familyRelationTypeUuidstring(uuid)required

Unique identifier of the relation type association.

Bodyapplication/jsonrequired
isRequiredboolean or nullrequired

Whether relations of this type are required.

minCountinteger or null(int32)required

Minimum number of relations of this type required.

maxCountinteger or null(int32)required

Maximum number of relations of this type allowed. Null means unlimited.

curl -i -X PATCH \
  'https://docs.apiera.io/_mock/openapi/v1/families/{familyUuid}/relation-types/{familyRelationTypeUuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "isRequired": true,
    "minCount": 0,
    "maxCount": 0
  }'

Responses

Relation type association updated successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this family-relation type association.

familyUuidstring(uuid)required

Identifier of the family this association belongs to.

productRelationTypeUuidstring(uuid)required

Identifier of the product relation type that is associated.

createdAtstring(date-time)required

Timestamp when the association was created.

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

Timestamp when the association was last modified.

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

Whether relations of this type are required for products in this family.

minCountinteger(int32)required

Minimum number of relations of this type required.

maxCountinteger or null(int32)required

Maximum number of relations of this type allowed. Null means unlimited.

Response
application/json
{
  "uuid": "bbb22222-e89b-12d3-a456-426614174001",
  "familyUuid": "123e4567-e89b-12d3-a456-426614174001",
  "productRelationTypeUuid": "ddd44444-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "isRequired": false,
  "minCount": 0,
  "maxCount": 3
}

Remove relation type from family

Request

Permanently removes a relation type association from a family.

Security
Bearer
Path
familyUuidstring(uuid)required

Unique identifier of the family.

familyRelationTypeUuidstring(uuid)required

Unique identifier of the relation type association.

curl -i -X DELETE \
  'https://docs.apiera.io/_mock/openapi/v1/families/{familyUuid}/relation-types/{familyRelationTypeUuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Relation type association removed successfully.

Response
No content

Bulk associate relation types with family

Request

Creates multiple relation type associations for a family in a single operation.

Security
Bearer
Path
familyUuidstring(uuid)required

Unique identifier of the family.

Bodyapplication/jsonrequiredArray [
productRelationTypeUuidstring(uuid)required

Identifier of the product relation type to associate.

isRequiredbooleanrequired

Whether relations of this type are required for products in this family.

minCountinteger(int32)required

Minimum number of relations of this type required.

maxCountinteger or null(int32)required

Maximum number of relations of this type allowed. Null means unlimited.

]
curl -i -X POST \
  'https://docs.apiera.io/_mock/openapi/v1/families/{familyUuid}/relation-types/bulk' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "productRelationTypeUuid": "7834a835-50d6-4e97-8a63-309dc16472d4",
      "isRequired": true,
      "minCount": 0,
      "maxCount": 0
    }
  ]'

Responses

Relation type associations created successfully.

Bodyapplication/jsonArray [
uuidstring(uuid)required

Unique identifier for this family-relation type association.

familyUuidstring(uuid)required

Identifier of the family this association belongs to.

productRelationTypeUuidstring(uuid)required

Identifier of the product relation type that is associated.

createdAtstring(date-time)required

Timestamp when the association was created.

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

Timestamp when the association was last modified.

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

Whether relations of this type are required for products in this family.

minCountinteger(int32)required

Minimum number of relations of this type required.

maxCountinteger or null(int32)required

Maximum number of relations of this type allowed. Null means unlimited.

]
Response
application/json
[
  {
    "uuid": "bbb22222-e89b-12d3-a456-426614174001",
    "familyUuid": "123e4567-e89b-12d3-a456-426614174001",
    "productRelationTypeUuid": "ddd44444-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "isRequired": true,
    "minCount": 1,
    "maxCount": 5
  },
  {
    "uuid": "bbb22222-e89b-12d3-a456-426614174001",
    "familyUuid": "123e4567-e89b-12d3-a456-426614174001",
    "productRelationTypeUuid": "ddd44444-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "isRequired": false,
    "minCount": 0,
    "maxCount": 10
  }
]

Bulk update family relation type associations

Request

Updates multiple relation type associations in a single operation.

Security
Bearer
Path
familyUuidstring(uuid)required

Unique identifier of the family.

Bodyapplication/jsonrequiredArray [
uuidstring(uuid)required

Identifier of the family relation type association to update.

isRequiredboolean or nullrequired

Whether relations of this type are required.

minCountinteger or null(int32)required

Minimum number of relations of this type required.

maxCountinteger or null(int32)required

Maximum number of relations of this type allowed. Null means unlimited.

]
curl -i -X PATCH \
  'https://docs.apiera.io/_mock/openapi/v1/families/{familyUuid}/relation-types/bulk' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "isRequired": true,
      "minCount": 0,
      "maxCount": 0
    }
  ]'

Responses

Relation type associations updated successfully.

Bodyapplication/jsonArray [
uuidstring(uuid)required

Unique identifier for this family-relation type association.

familyUuidstring(uuid)required

Identifier of the family this association belongs to.

productRelationTypeUuidstring(uuid)required

Identifier of the product relation type that is associated.

createdAtstring(date-time)required

Timestamp when the association was created.

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

Timestamp when the association was last modified.

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

Whether relations of this type are required for products in this family.

minCountinteger(int32)required

Minimum number of relations of this type required.

maxCountinteger or null(int32)required

Maximum number of relations of this type allowed. Null means unlimited.

]
Response
application/json
[
  {
    "uuid": "bbb22222-e89b-12d3-a456-426614174001",
    "familyUuid": "123e4567-e89b-12d3-a456-426614174001",
    "productRelationTypeUuid": "ddd44444-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "isRequired": false,
    "minCount": 0,
    "maxCount": 5
  },
  {
    "uuid": "bbb22222-e89b-12d3-a456-426614174001",
    "familyUuid": "123e4567-e89b-12d3-a456-426614174001",
    "productRelationTypeUuid": "ddd44444-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "isRequired": true,
    "minCount": 2,
    "maxCount": 10
  }
]

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

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