Skip to content
API Reference
/
/
Create family

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

Families

Operations

List families

Request

Retrieves a paginated list of families with optional filtering.

Security
Bearer
Query
name[eq]string

Filter by exact name match.

name[contains]string

Filter by partial name match.

name[starts]string

Filter by name prefix.

name[ends]string

Filter by name suffix.

name[order]string

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

status[eq]string

Filter by exact status match.

Enum"draft""active""inactive""removed"
status[order]string

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

parentUuid[eq]string(uuid)

Filter by parent family UUID.

isRemoved[eq]boolean

Filter by removed status. Values: true, false.

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/families?name%5Beq%5D=string&name%5Bcontains%5D=string&name%5Bstarts%5D=string&name%5Bends%5D=string&name%5Border%5D=string&status%5Beq%5D=draft&status%5Border%5D=string&parentUuid%5Beq%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&isRemoved%5Beq%5D=true&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 paginated list of families.

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

Unique identifier for this family.

items[].​parentUuidstring or null(uuid)

Identifier of the parent family for hierarchical organization. Null if this is a root family.

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

Timestamp when this family was created.

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

Timestamp when this family was last modified.

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

Timestamp when this family was removed. Null if not removed.

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

Current lifecycle status of this family.

Enum"draft""active""inactive""removed"
items[].​namestringrequired

Display name for this family.

items[].​descriptionstring or null

Detailed description of the family's purpose and which products it applies to.

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

Family in active status ready for use

{
  "uuid": "123e4567-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "status": "active",
  "name": "Electronics",
  "description": "Product family for electronics catalog"
}

Create family

Request

Creates a new family. Categories and attributes must be added separately after creation.

Security
Bearer
Bodyapplication/jsonrequired
parentUuidstring or null(uuid)

Optional parent family UUID for hierarchical organization.

namestring[ 3 .. 100 ] charactersrequired

Display name for the family.

descriptionstring or null<= 1000 characters

Optional detailed description of the family's purpose and scope.

curl -i -X POST \
  https://docs.apiera.io/_mock/openapi/v1/families \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "parentUuid": "a234027b-494b-4285-a8ce-894cd0943051",
    "name": "string",
    "description": "string"
  }'

Responses

Family created successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this family.

parentUuidstring or null(uuid)

Identifier of the parent family for hierarchical organization. Null if this is a root family.

createdAtstring(date-time)required

Timestamp when this family was created.

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

Timestamp when this family was last modified.

Example: "2025-11-23T14:15:22.123456Z"
removedAtstring or null(date-time)

Timestamp when this family was removed. Null if not removed.

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

Current lifecycle status of this family.

Enum"draft""active""inactive""removed"
namestringrequired

Display name for this family.

descriptionstring or null

Detailed description of the family's purpose and which products it applies to.

Response
application/json

New family without parent relationship

{
  "uuid": "123e4567-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "status": "draft",
  "name": "Electronics",
  "description": "Product family for electronics catalog"
}

Get family

Request

Retrieves complete details for a single family.

Security
Bearer
Path
familyUuidstring(uuid)required

Unique identifier of the family.

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

Responses

Successfully retrieved family.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this family.

parentUuidstring or null(uuid)

Identifier of the parent family for hierarchical organization. Null if this is a root family.

createdAtstring(date-time)required

Timestamp when this family was created.

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

Timestamp when this family was last modified.

Example: "2025-11-23T14:15:22.123456Z"
removedAtstring or null(date-time)

Timestamp when this family was removed. Null if not removed.

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

Current lifecycle status of this family.

Enum"draft""active""inactive""removed"
namestringrequired

Display name for this family.

descriptionstring or null

Detailed description of the family's purpose and which products it applies to.

Response
application/json
{
  "uuid": "123e4567-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "status": "active",
  "name": "Electronics",
  "description": "Product family for electronics catalog"
}

Update family

Request

Updates an existing family. Only provided fields are updated.

Security
Bearer
Path
familyUuidstring(uuid)required

Unique identifier of the family.

Bodyapplication/jsonrequired
parentUuidstring or null(uuid)

Updated parent family UUID. Set to null to remove parent relationship.

namestring or null[ 3 .. 100 ] characters

Updated display name for the family.

descriptionstring or null<= 1000 characters

Updated description for the family.

curl -i -X PATCH \
  'https://docs.apiera.io/_mock/openapi/v1/families/{familyUuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "parentUuid": "a234027b-494b-4285-a8ce-894cd0943051",
    "name": "string",
    "description": "string"
  }'

Responses

Family updated successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this family.

parentUuidstring or null(uuid)

Identifier of the parent family for hierarchical organization. Null if this is a root family.

createdAtstring(date-time)required

Timestamp when this family was created.

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

Timestamp when this family was last modified.

Example: "2025-11-23T14:15:22.123456Z"
removedAtstring or null(date-time)

Timestamp when this family was removed. Null if not removed.

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

Current lifecycle status of this family.

Enum"draft""active""inactive""removed"
namestringrequired

Display name for this family.

descriptionstring or null

Detailed description of the family's purpose and which products it applies to.

Response
application/json

Family with modified properties

{
  "uuid": "123e4567-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "status": "active",
  "name": "Electronics - Updated",
  "description": "Product family for electronics - updated catalog"
}

Delete family

Request

Permanently deletes a family. Cannot be undone.

Security
Bearer
Path
familyUuidstring(uuid)required

Unique identifier of the family.

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

Responses

Family deleted successfully.

Response
No content

Bulk create families

Request

Creates multiple families in a single atomic operation.

Security
Bearer
Bodyapplication/jsonrequiredArray [
parentUuidstring or null(uuid)

Optional parent family UUID for hierarchical organization.

namestring[ 3 .. 100 ] charactersrequired

Display name for the family.

descriptionstring or null<= 1000 characters

Optional detailed description of the family's purpose and scope.

]
curl -i -X POST \
  https://docs.apiera.io/_mock/openapi/v1/families/bulk \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "parentUuid": "a234027b-494b-4285-a8ce-894cd0943051",
      "name": "string",
      "description": "string"
    }
  ]'

Responses

Families created successfully.

Bodyapplication/jsonArray [
uuidstring(uuid)required

Unique identifier for this family.

parentUuidstring or null(uuid)

Identifier of the parent family for hierarchical organization. Null if this is a root family.

createdAtstring(date-time)required

Timestamp when this family was created.

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

Timestamp when this family was last modified.

Example: "2025-11-23T14:15:22.123456Z"
removedAtstring or null(date-time)

Timestamp when this family was removed. Null if not removed.

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

Current lifecycle status of this family.

Enum"draft""active""inactive""removed"
namestringrequired

Display name for this family.

descriptionstring or null

Detailed description of the family's purpose and which products it applies to.

]
Response
application/json

Batch creation of different family types

[
  {
    "uuid": "123e4567-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "status": "draft",
    "name": "Electronics",
    "description": "Product family for electronics catalog"
  },
  {
    "uuid": "123e4567-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "status": "draft",
    "name": "Apparel",
    "description": "Product family for apparel catalog"
  },
  {
    "uuid": "123e4567-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "status": "draft",
    "name": "Home & Garden",
    "description": "Product family for home & garden catalog"
  }
]

Bulk update families

Request

Updates multiple families in a single operation.

Security
Bearer
Bodyapplication/jsonrequiredArray [
uuidstring(uuid)required

Identifier of the family to update.

parentUuidstring or null(uuid)

Updated parent family UUID.

namestring or null[ 3 .. 100 ] characters

Updated display name for the family.

descriptionstring or null<= 1000 characters

Updated description for the family.

]
curl -i -X PATCH \
  https://docs.apiera.io/_mock/openapi/v1/families/bulk \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "parentUuid": "a234027b-494b-4285-a8ce-894cd0943051",
      "name": "string",
      "description": "string"
    }
  ]'

Responses

Families updated successfully.

Bodyapplication/jsonArray [
uuidstring(uuid)required

Unique identifier for this family.

parentUuidstring or null(uuid)

Identifier of the parent family for hierarchical organization. Null if this is a root family.

createdAtstring(date-time)required

Timestamp when this family was created.

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

Timestamp when this family was last modified.

Example: "2025-11-23T14:15:22.123456Z"
removedAtstring or null(date-time)

Timestamp when this family was removed. Null if not removed.

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

Current lifecycle status of this family.

Enum"draft""active""inactive""removed"
namestringrequired

Display name for this family.

descriptionstring or null

Detailed description of the family's purpose and which products it applies to.

]
Response
application/json
[
  {
    "uuid": "123e4567-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "status": "active",
    "name": "Electronics - Updated",
    "description": "Product family for electronics - updated catalog"
  },
  {
    "uuid": "123e4567-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "status": "active",
    "name": "Apparel - Updated",
    "description": "Product family for apparel - updated catalog"
  }
]

Transition family lifecycle

Request

Transitions a family to a different lifecycle state. Valid transitions depend on current status.

Security
Bearer
Path
familyUuidstring(uuid)required

Unique identifier of the family.

Bodyapplication/jsonrequired
transitionstringrequired

Lifecycle transition to apply. Valid transitions depend on current status.

Enum"activate""deactivate""remove""restore"
curl -i -X PATCH \
  'https://docs.apiera.io/_mock/openapi/v1/families/{familyUuid}/actions/lifecycle' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "transition": "activate"
  }'

Responses

Family transitioned successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this family.

parentUuidstring or null(uuid)

Identifier of the parent family for hierarchical organization. Null if this is a root family.

createdAtstring(date-time)required

Timestamp when this family was created.

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

Timestamp when this family was last modified.

Example: "2025-11-23T14:15:22.123456Z"
removedAtstring or null(date-time)

Timestamp when this family was removed. Null if not removed.

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

Current lifecycle status of this family.

Enum"draft""active""inactive""removed"
namestringrequired

Display name for this family.

descriptionstring or null

Detailed description of the family's purpose and which products it applies to.

Response
application/json
{
  "uuid": "123e4567-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "status": "active",
  "name": "Electronics",
  "description": "Product family for electronics catalog"
}

Bulk transition family lifecycle

Request

Transitions multiple families to a different lifecycle state in a single operation.

Security
Bearer
Bodyapplication/jsonrequired
transitionstringrequired

Lifecycle transition to apply to all specified families.

Enum"activate""deactivate""remove""restore"
uuidsArray of strings(uuid)required

List of family identifiers to transition.

curl -i -X PATCH \
  https://docs.apiera.io/_mock/openapi/v1/families/bulk/actions/lifecycle \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "transition": "activate",
    "uuids": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
  }'

Responses

Families transitioned successfully.

Bodyapplication/jsonArray [
uuidstring(uuid)required

Unique identifier for this family.

parentUuidstring or null(uuid)

Identifier of the parent family for hierarchical organization. Null if this is a root family.

createdAtstring(date-time)required

Timestamp when this family was created.

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

Timestamp when this family was last modified.

Example: "2025-11-23T14:15:22.123456Z"
removedAtstring or null(date-time)

Timestamp when this family was removed. Null if not removed.

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

Current lifecycle status of this family.

Enum"draft""active""inactive""removed"
namestringrequired

Display name for this family.

descriptionstring or null

Detailed description of the family's purpose and which products it applies to.

]
Response
application/json
[
  {
    "uuid": "123e4567-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "status": "active",
    "name": "Electronics",
    "description": "Product family for electronics catalog"
  },
  {
    "uuid": "123e4567-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "status": "active",
    "name": "Apparel",
    "description": "Product family for apparel catalog"
  }
]

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