Skip to content
/Family Attributes

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/

Tags

Operations

Skus

Operations

Sku Dimensions

Operations

Sku Weights

Operations

Family Attributes

Operations

List family attributes

Request

Retrieves a paginated list of attribute 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}/attributes?page=1&size=20' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successfully retrieved attribute associations.

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

Unique identifier for this family-attribute association.

items[].​familyUuidstring(uuid)required

Identifier of the family this attribute is associated with.

items[].​attributeUuidstring(uuid)required

Identifier of the attribute associated with this family.

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

Timestamp when this association was created.

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

Timestamp when this association was last modified.

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

Defines the requirement level for this attribute on products in this family.

Enum"may""must""mustNot""should"
items[].​isAutoPopulatedbooleanrequired

Whether products created in this family automatically receive this attribute with a default value.

items[].​attributeNamestringrequired

Display name of the associated attribute for convenience.

paginationobject(PaginationResult)required
pagination.​pageinteger(int32)required
pagination.​sizeinteger(int32)required
pagination.​totalItemsinteger(int32)required
pagination.​totalPagesinteger(int32)required
Response
application/json

List of attributes associated with this family

[
  {
    "uuid": "bbb22222-e89b-12d3-a456-426614174001",
    "familyUuid": "123e4567-e89b-12d3-a456-426614174001",
    "attributeUuid": "ddd44444-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "requirementLevel": "must",
    "isAutoPopulated": false,
    "attributeName": "Brand"
  },
  {
    "uuid": "bbb22222-e89b-12d3-a456-426614174001",
    "familyUuid": "123e4567-e89b-12d3-a456-426614174001",
    "attributeUuid": "ddd44444-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "requirementLevel": "must",
    "isAutoPopulated": false,
    "attributeName": "Model Number"
  },
  {
    "uuid": "bbb22222-e89b-12d3-a456-426614174001",
    "familyUuid": "123e4567-e89b-12d3-a456-426614174001",
    "attributeUuid": "ddd44444-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "requirementLevel": "should",
    "isAutoPopulated": false,
    "attributeName": "Color"
  }
]

Associate attribute with family

Request

Creates a new attribute association for a family.

Security
Bearer
Path
familyUuidstring(uuid)required

Unique identifier of the family.

Bodyapplication/jsonrequired
attributeUuidstring(uuid)required

Identifier of the attribute to associate with this family.

requirementLevelstringrequired

Defines the requirement level for this attribute on products in this family.

Enum"may""must""mustNot""should"
isAutoPopulatedbooleanrequired

Whether this attribute is automatically added to new products in this family.

curl -i -X POST \
  'https://docs.apiera.io/_mock/openapi/v1/families/{familyUuid}/attributes' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "attributeUuid": "4104100f-5f1b-4071-ab51-e4d731f93685",
    "requirementLevel": "may",
    "isAutoPopulated": true
  }'

Responses

Attribute association created successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this family-attribute association.

familyUuidstring(uuid)required

Identifier of the family this attribute is associated with.

attributeUuidstring(uuid)required

Identifier of the attribute associated with this family.

createdAtstring(date-time)required

Timestamp when this association was created.

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

Timestamp when this association was last modified.

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

Defines the requirement level for this attribute on products in this family.

Enum"may""must""mustNot""should"
isAutoPopulatedbooleanrequired

Whether products created in this family automatically receive this attribute with a default value.

attributeNamestringrequired

Display name of the associated attribute for convenience.

Response
application/json

Attribute that must be provided for product completeness

{
  "uuid": "bbb22222-e89b-12d3-a456-426614174001",
  "familyUuid": "123e4567-e89b-12d3-a456-426614174001",
  "attributeUuid": "ddd44444-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-20T08:15:00.000000Z",
  "requirementLevel": "must",
  "isAutoPopulated": false,
  "attributeName": "Brand"
}

Get family attribute association

Request

Retrieves a single attribute association for a family.

Security
Bearer
Path
familyUuidstring(uuid)required

Unique identifier of the family.

familyAttributeUuidstring(uuid)required

Unique identifier of the attribute association.

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

Responses

Successfully retrieved attribute association.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this family-attribute association.

familyUuidstring(uuid)required

Identifier of the family this attribute is associated with.

attributeUuidstring(uuid)required

Identifier of the attribute associated with this family.

createdAtstring(date-time)required

Timestamp when this association was created.

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

Timestamp when this association was last modified.

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

Defines the requirement level for this attribute on products in this family.

Enum"may""must""mustNot""should"
isAutoPopulatedbooleanrequired

Whether products created in this family automatically receive this attribute with a default value.

attributeNamestringrequired

Display name of the associated attribute for convenience.

Response
application/json
{
  "uuid": "bbb22222-e89b-12d3-a456-426614174001",
  "familyUuid": "123e4567-e89b-12d3-a456-426614174001",
  "attributeUuid": "ddd44444-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-20T08:15:00.000000Z",
  "requirementLevel": "must",
  "isAutoPopulated": false,
  "attributeName": "Brand"
}

Update family attribute association

Request

Updates an existing attribute association. Only provided fields are updated.

Security
Bearer
Path
familyUuidstring(uuid)required

Unique identifier of the family.

familyAttributeUuidstring(uuid)required

Unique identifier of the attribute association.

Bodyapplication/jsonrequired
requirementLevelinteger or null(NullableOfRequirementLevel)

Updated requirement level for this attribute.

isAutoPopulatedboolean or null

Updated auto-population setting for this attribute.

curl -i -X PATCH \
  'https://docs.apiera.io/_mock/openapi/v1/families/{familyUuid}/attributes/{familyAttributeUuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "requirementLevel": 0,
    "isAutoPopulated": true
  }'

Responses

Attribute association updated successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this family-attribute association.

familyUuidstring(uuid)required

Identifier of the family this attribute is associated with.

attributeUuidstring(uuid)required

Identifier of the attribute associated with this family.

createdAtstring(date-time)required

Timestamp when this association was created.

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

Timestamp when this association was last modified.

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

Defines the requirement level for this attribute on products in this family.

Enum"may""must""mustNot""should"
isAutoPopulatedbooleanrequired

Whether products created in this family automatically receive this attribute with a default value.

attributeNamestringrequired

Display name of the associated attribute for convenience.

Response
application/json

Association with modified requirement level

{
  "uuid": "bbb22222-e89b-12d3-a456-426614174001",
  "familyUuid": "123e4567-e89b-12d3-a456-426614174001",
  "attributeUuid": "ddd44444-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "requirementLevel": "should",
  "isAutoPopulated": false,
  "attributeName": "Brand"
}

Remove attribute from family

Request

Permanently removes an attribute association from a family.

Security
Bearer
Path
familyUuidstring(uuid)required

Unique identifier of the family.

familyAttributeUuidstring(uuid)required

Unique identifier of the attribute association.

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

Responses

Attribute association removed successfully.

Response
No content

Bulk associate attributes with family

Request

Creates multiple attribute associations for a family in a single operation.

Security
Bearer
Path
familyUuidstring(uuid)required

Unique identifier of the family.

Bodyapplication/jsonrequiredArray [
attributeUuidstring(uuid)required

Identifier of the attribute to associate with this family.

requirementLevelstringrequired

Defines the requirement level for this attribute on products in this family.

Enum"may""must""mustNot""should"
isAutoPopulatedbooleanrequired

Whether this attribute is automatically added to new products.

]
curl -i -X POST \
  'https://docs.apiera.io/_mock/openapi/v1/families/{familyUuid}/attributes/bulk' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "attributeUuid": "4104100f-5f1b-4071-ab51-e4d731f93685",
      "requirementLevel": "may",
      "isAutoPopulated": true
    }
  ]'

Responses

Attribute associations created successfully.

Bodyapplication/jsonArray [
uuidstring(uuid)required

Unique identifier for this family-attribute association.

familyUuidstring(uuid)required

Identifier of the family this attribute is associated with.

attributeUuidstring(uuid)required

Identifier of the attribute associated with this family.

createdAtstring(date-time)required

Timestamp when this association was created.

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

Timestamp when this association was last modified.

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

Defines the requirement level for this attribute on products in this family.

Enum"may""must""mustNot""should"
isAutoPopulatedbooleanrequired

Whether products created in this family automatically receive this attribute with a default value.

attributeNamestringrequired

Display name of the associated attribute for convenience.

]
Response
application/json

Bulk creation of attribute requirements

[
  {
    "uuid": "bbb22222-e89b-12d3-a456-426614174001",
    "familyUuid": "123e4567-e89b-12d3-a456-426614174001",
    "attributeUuid": "ddd44444-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "requirementLevel": "must",
    "isAutoPopulated": false,
    "attributeName": "Brand"
  },
  {
    "uuid": "bbb22222-e89b-12d3-a456-426614174001",
    "familyUuid": "123e4567-e89b-12d3-a456-426614174001",
    "attributeUuid": "ddd44444-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "requirementLevel": "must",
    "isAutoPopulated": false,
    "attributeName": "Model Number"
  },
  {
    "uuid": "bbb22222-e89b-12d3-a456-426614174001",
    "familyUuid": "123e4567-e89b-12d3-a456-426614174001",
    "attributeUuid": "ddd44444-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "requirementLevel": "should",
    "isAutoPopulated": false,
    "attributeName": "Color"
  },
  {
    "uuid": "bbb22222-e89b-12d3-a456-426614174001",
    "familyUuid": "123e4567-e89b-12d3-a456-426614174001",
    "attributeUuid": "ddd44444-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "requirementLevel": "may",
    "isAutoPopulated": false,
    "attributeName": "Warranty Period"
  }
]

Bulk update family attribute associations

Request

Updates multiple attribute 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-attribute association to update.

requirementLevelinteger or null(NullableOfRequirementLevel)

Updated requirement level for this attribute.

isAutoPopulatedboolean or null

Updated auto-population setting for this attribute.

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

Responses

Attribute associations updated successfully.

Bodyapplication/jsonArray [
uuidstring(uuid)required

Unique identifier for this family-attribute association.

familyUuidstring(uuid)required

Identifier of the family this attribute is associated with.

attributeUuidstring(uuid)required

Identifier of the attribute associated with this family.

createdAtstring(date-time)required

Timestamp when this association was created.

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

Timestamp when this association was last modified.

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

Defines the requirement level for this attribute on products in this family.

Enum"may""must""mustNot""should"
isAutoPopulatedbooleanrequired

Whether products created in this family automatically receive this attribute with a default value.

attributeNamestringrequired

Display name of the associated attribute for convenience.

]
Response
application/json
[
  {
    "uuid": "bbb22222-e89b-12d3-a456-426614174001",
    "familyUuid": "123e4567-e89b-12d3-a456-426614174001",
    "attributeUuid": "ddd44444-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "requirementLevel": "should",
    "isAutoPopulated": false,
    "attributeName": "Brand"
  },
  {
    "uuid": "bbb22222-e89b-12d3-a456-426614174001",
    "familyUuid": "123e4567-e89b-12d3-a456-426614174001",
    "attributeUuid": "ddd44444-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "requirementLevel": "must",
    "isAutoPopulated": true,
    "attributeName": "Model Number"
  }
]

Family Categories

Operations

Families

Operations

Organization Members

Operations

Organizations

Operations

Organization Roles

Operations

Categories

Operations

Attributes

Operations

Attribute Terms

Operations

Assets

Operations

Asset Files

Operations

Asset Metadata

Operations
© 2025 Apiera AS