Skip to content
/Family Categories

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

Family Categories

Operations

List family categories

Request

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

Responses

Successfully retrieved category associations.

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

Unique identifier for this family-category association.

items[].​familyUuidstring(uuid)required

Identifier of the family this category is associated with.

items[].​categoryUuidstring(uuid)required

Identifier of the category 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 category on products in this family.

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

Whether products created in this family automatically receive this category assignment.

items[].​categoryNamestringrequired

Display name of the associated category 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 categories associated with this family

[
  {
    "uuid": "aaa11111-e89b-12d3-a456-426614174001",
    "familyUuid": "123e4567-e89b-12d3-a456-426614174001",
    "categoryUuid": "ccc33333-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "requirementLevel": "must",
    "isAutoPopulated": true,
    "categoryName": "Consumer Electronics"
  },
  {
    "uuid": "aaa11111-e89b-12d3-a456-426614174001",
    "familyUuid": "123e4567-e89b-12d3-a456-426614174001",
    "categoryUuid": "ccc33333-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "requirementLevel": "should",
    "isAutoPopulated": false,
    "categoryName": "Computers"
  }
]

Associate category with family

Request

Creates a new category association for a family.

Security
Bearer
Path
familyUuidstring(uuid)required

Unique identifier of the family.

Bodyapplication/jsonrequired
categoryUuidstring(uuid)required

Identifier of the category to associate with this family.

requirementLevelstringrequired

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

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

Whether this category assignment is automatically applied to new products in this family.

curl -i -X POST \
  'https://docs.apiera.io/_mock/openapi/v1/families/{familyUuid}/categories' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "categoryUuid": "4c772354-7065-4cf9-9d3f-9fd93650af3c",
    "requirementLevel": "may",
    "isAutoPopulated": true
  }'

Responses

Category association created successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this family-category association.

familyUuidstring(uuid)required

Identifier of the family this category is associated with.

categoryUuidstring(uuid)required

Identifier of the category 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 category on products in this family.

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

Whether products created in this family automatically receive this category assignment.

categoryNamestringrequired

Display name of the associated category for convenience.

Response
application/json

Category that must be assigned to products

{
  "uuid": "aaa11111-e89b-12d3-a456-426614174001",
  "familyUuid": "123e4567-e89b-12d3-a456-426614174001",
  "categoryUuid": "ccc33333-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-20T08:15:00.000000Z",
  "requirementLevel": "must",
  "isAutoPopulated": true,
  "categoryName": "Consumer Electronics"
}

Get family category association

Request

Retrieves a single category association for a family.

Security
Bearer
Path
familyUuidstring(uuid)required

Unique identifier of the family.

familyCategoryUuidstring(uuid)required

Unique identifier of the category association.

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

Responses

Successfully retrieved category association.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this family-category association.

familyUuidstring(uuid)required

Identifier of the family this category is associated with.

categoryUuidstring(uuid)required

Identifier of the category 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 category on products in this family.

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

Whether products created in this family automatically receive this category assignment.

categoryNamestringrequired

Display name of the associated category for convenience.

Response
application/json
{
  "uuid": "aaa11111-e89b-12d3-a456-426614174001",
  "familyUuid": "123e4567-e89b-12d3-a456-426614174001",
  "categoryUuid": "ccc33333-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-20T08:15:00.000000Z",
  "requirementLevel": "must",
  "isAutoPopulated": true,
  "categoryName": "Consumer Electronics"
}

Update family category association

Request

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

Security
Bearer
Path
familyUuidstring(uuid)required

Unique identifier of the family.

familyCategoryUuidstring(uuid)required

Unique identifier of the category association.

Bodyapplication/jsonrequired
requirementLevelinteger or null(NullableOfRequirementLevel2)

Updated requirement level for this category.

isAutoPopulatedboolean or null

Updated auto-population setting for this category.

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

Responses

Category association updated successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this family-category association.

familyUuidstring(uuid)required

Identifier of the family this category is associated with.

categoryUuidstring(uuid)required

Identifier of the category 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 category on products in this family.

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

Whether products created in this family automatically receive this category assignment.

categoryNamestringrequired

Display name of the associated category for convenience.

Response
application/json

Association with modified requirement level

{
  "uuid": "aaa11111-e89b-12d3-a456-426614174001",
  "familyUuid": "123e4567-e89b-12d3-a456-426614174001",
  "categoryUuid": "ccc33333-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "requirementLevel": "should",
  "isAutoPopulated": true,
  "categoryName": "Consumer Electronics"
}

Remove category from family

Request

Permanently removes a category association from a family.

Security
Bearer
Path
familyUuidstring(uuid)required

Unique identifier of the family.

familyCategoryUuidstring(uuid)required

Unique identifier of the category association.

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

Responses

Category association removed successfully.

Response
No content

Bulk associate categories with family

Request

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

Security
Bearer
Path
familyUuidstring(uuid)required

Unique identifier of the family.

Bodyapplication/jsonrequiredArray [
categoryUuidstring(uuid)required

Identifier of the category to associate with this family.

requirementLevelstringrequired

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

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

Whether this category assignment is automatically applied to new products.

]
curl -i -X POST \
  'https://docs.apiera.io/_mock/openapi/v1/families/{familyUuid}/categories/bulk' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "categoryUuid": "4c772354-7065-4cf9-9d3f-9fd93650af3c",
      "requirementLevel": "may",
      "isAutoPopulated": true
    }
  ]'

Responses

Category associations created successfully.

Bodyapplication/jsonArray [
uuidstring(uuid)required

Unique identifier for this family-category association.

familyUuidstring(uuid)required

Identifier of the family this category is associated with.

categoryUuidstring(uuid)required

Identifier of the category 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 category on products in this family.

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

Whether products created in this family automatically receive this category assignment.

categoryNamestringrequired

Display name of the associated category for convenience.

]
Response
application/json

Bulk creation of category requirements

[
  {
    "uuid": "aaa11111-e89b-12d3-a456-426614174001",
    "familyUuid": "123e4567-e89b-12d3-a456-426614174001",
    "categoryUuid": "ccc33333-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "requirementLevel": "must",
    "isAutoPopulated": true,
    "categoryName": "Consumer Electronics"
  },
  {
    "uuid": "aaa11111-e89b-12d3-a456-426614174001",
    "familyUuid": "123e4567-e89b-12d3-a456-426614174001",
    "categoryUuid": "ccc33333-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "requirementLevel": "should",
    "isAutoPopulated": false,
    "categoryName": "Computers"
  },
  {
    "uuid": "aaa11111-e89b-12d3-a456-426614174001",
    "familyUuid": "123e4567-e89b-12d3-a456-426614174001",
    "categoryUuid": "ccc33333-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "requirementLevel": "may",
    "isAutoPopulated": false,
    "categoryName": "Premium Products"
  }
]

Bulk update family category associations

Request

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

requirementLevelinteger or null(NullableOfRequirementLevel2)

Updated requirement level for this category.

isAutoPopulatedboolean or null

Updated auto-population setting for this category.

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

Responses

Category associations updated successfully.

Bodyapplication/jsonArray [
uuidstring(uuid)required

Unique identifier for this family-category association.

familyUuidstring(uuid)required

Identifier of the family this category is associated with.

categoryUuidstring(uuid)required

Identifier of the category 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 category on products in this family.

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

Whether products created in this family automatically receive this category assignment.

categoryNamestringrequired

Display name of the associated category for convenience.

]
Response
application/json
[
  {
    "uuid": "aaa11111-e89b-12d3-a456-426614174001",
    "familyUuid": "123e4567-e89b-12d3-a456-426614174001",
    "categoryUuid": "ccc33333-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "requirementLevel": "should",
    "isAutoPopulated": true,
    "categoryName": "Consumer Electronics"
  },
  {
    "uuid": "aaa11111-e89b-12d3-a456-426614174001",
    "familyUuid": "123e4567-e89b-12d3-a456-426614174001",
    "categoryUuid": "ccc33333-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "requirementLevel": "must",
    "isAutoPopulated": true,
    "categoryName": "Computers"
  }
]

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