Skip to content
/Attribute Terms

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

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

List attribute terms

Request

Retrieves a paginated list of terms for an attribute with optional filtering.

Security
Bearer
Path
attributeUuidstring(uuid)required

Unique identifier of the attribute.

Query
uuids[eq]Array of strings(uuid)

Filter by one or more UUIDs. Accepts multiple values.

codes[eq]Array of strings

Filter by one or more exact codes. Accepts multiple values.

code[contains]string

Filter by partial code match.

code[starts]string

Filter by code prefix.

code[ends]string

Filter by code suffix.

code[order]string

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

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.

include[contents]boolean
expand[contents]boolean
curl -i -X GET \
  'https://docs.apiera.io/_mock/openapi/v1/attributes/{attributeUuid}/terms?uuids%5Beq%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&codes%5Beq%5D=string&code%5Bcontains%5D=string&code%5Bstarts%5D=string&code%5Bends%5D=string&code%5Border%5D=string&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&include%5Bcontents%5D=true&expand%5Bcontents%5D=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successfully retrieved terms.

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

Unique identifier for this term.

items[].​attributeUuidstring(uuid)required

Unique identifier of the parent attribute.

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

Timestamp when this term was created.

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

Timestamp when this term was last modified.

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

Code for this term.

items[].​contentUuidsArray of strings or null(uuid)

List of content UUIDs associated with this term. Only populated when include[contents]=true.

items[].​contentsArray of objects or null(TermContentResponse)

List of locale-specific content for this term. Only populated when expand[contents]=true.

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",
    "attributeUuid": "123e4567-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "code": "apple"
  },
  {
    "uuid": "aaa11111-e89b-12d3-a456-426614174001",
    "attributeUuid": "123e4567-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "code": "samsung"
  },
  {
    "uuid": "aaa11111-e89b-12d3-a456-426614174001",
    "attributeUuid": "123e4567-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "code": "sony"
  },
  {
    "uuid": "aaa11111-e89b-12d3-a456-426614174001",
    "attributeUuid": "123e4567-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "code": "lg"
  }
]

Create term

Request

Creates a new term for an attribute.

Security
Bearer
Path
attributeUuidstring(uuid)required

Unique identifier of the attribute.

Bodyapplication/jsonrequired
codestring[ 1 .. 100 ] charactersrequired

Term code that can be assigned to products.

curl -i -X POST \
  'https://docs.apiera.io/_mock/openapi/v1/attributes/{attributeUuid}/terms' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "string"
  }'

Responses

Term created successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this term.

attributeUuidstring(uuid)required

Identifier of the attribute this term belongs to.

createdAtstring(date-time)required

Timestamp when this term was created.

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

Timestamp when this term was last modified.

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

Code that can be assigned to products.

Response
application/json
{
  "uuid": "aaa11111-e89b-12d3-a456-426614174001",
  "attributeUuid": "123e4567-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-20T08:15:00.000000Z",
  "code": "apple"
}

Get term

Request

Retrieves a single term.

Security
Bearer
Path
attributeUuidstring(uuid)required

Unique identifier of the attribute.

termUuidstring(uuid)required

Unique identifier of the term.

Query
include[contents]boolean
expand[contents]boolean
curl -i -X GET \
  'https://docs.apiera.io/_mock/openapi/v1/attributes/{attributeUuid}/terms/{termUuid}?include%5Bcontents%5D=true&expand%5Bcontents%5D=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successfully retrieved term.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this term.

attributeUuidstring(uuid)required

Unique identifier of the parent attribute.

createdAtstring(date-time)required

Timestamp when this term was created.

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

Timestamp when this term was last modified.

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

Code for this term.

contentUuidsArray of strings or null(uuid)

List of content UUIDs associated with this term. Only populated when include[contents]=true.

contentsArray of objects or null(TermContentResponse)

List of locale-specific content for this term. Only populated when expand[contents]=true.

Response
application/json
{
  "uuid": "aaa11111-e89b-12d3-a456-426614174001",
  "attributeUuid": "123e4567-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-20T08:15:00.000000Z",
  "code": "apple"
}

Update term

Request

Updates an existing term. Only provided fields are updated.

Security
Bearer
Path
attributeUuidstring(uuid)required

Unique identifier of the attribute.

termUuidstring(uuid)required

Unique identifier of the term.

Bodyapplication/jsonrequired
codestring or null[ 1 .. 100 ] characters

Updated term code.

curl -i -X PATCH \
  'https://docs.apiera.io/_mock/openapi/v1/attributes/{attributeUuid}/terms/{termUuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "string"
  }'

Responses

Term updated successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this term.

attributeUuidstring(uuid)required

Identifier of the attribute this term belongs to.

createdAtstring(date-time)required

Timestamp when this term was created.

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

Timestamp when this term was last modified.

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

Code that can be assigned to products.

Response
application/json
{
  "uuid": "aaa11111-e89b-12d3-a456-426614174001",
  "attributeUuid": "123e4567-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "code": "space_gray"
}

Delete term

Request

Permanently deletes a term.

Security
Bearer
Path
attributeUuidstring(uuid)required

Unique identifier of the attribute.

termUuidstring(uuid)required

Unique identifier of the term.

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

Responses

Term deleted successfully.

Response
No content

Assets

Operations

Asset Files

Operations

Asset Metadata

Operations
© 2025 Apiera AS