Skip to content
API Reference
/
/
Bulk transition attribute...

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

Organization Members

Operations

Organizations

Operations

Organization Roles

Operations

Categories

Operations

Attributes

Operations

List attributes

Request

Retrieves a paginated list of attributes 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""published""unpublished""removed"
status[order]string

Sort order for status 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.

isRemoved[eq]boolean

Filter by removed status. Values: true, false.

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/attributes?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&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&isRemoved%5Beq%5D=true&page=0&size=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successfully retrieved paginated list of attributes.

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

Unique identifier for this attribute.

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

Timestamp when this attribute was created.

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

Timestamp when this attribute was last modified.

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

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

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

Current lifecycle status of this attribute.

Enum"draft""published""unpublished""removed"
items[].​namestringrequired

Display name for this attribute.

items[].​descriptionstring or null

Explanation of what this attribute represents and when to use it.

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

Attribute available for use in products

{
  "uuid": "123e4567-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "status": "published",
  "name": "Brand",
  "description": "Product manufacturer or brand name"
}

Create attribute

Request

Creates a new attribute. Terms must be added separately after creation.

Security
Bearer
Bodyapplication/jsonrequired
namestring[ 1 .. 100 ] charactersrequired

Display name for the attribute.

descriptionstring or null<= 500 characters

Optional explanation of what this attribute represents and when to use it.

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

Responses

Attribute created successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this attribute.

createdAtstring(date-time)required

Timestamp when this attribute was created.

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

Timestamp when this attribute was last modified.

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

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

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

Current lifecycle status of this attribute.

Enum"draft""published""unpublished""removed"
namestringrequired

Display name for this attribute.

descriptionstring or null

Explanation of what this attribute represents and when to use it.

Response
application/json

New attribute starts in draft status

{
  "uuid": "123e4567-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "status": "draft",
  "name": "Brand",
  "description": "Product manufacturer or brand name"
}

Bulk create attributes

Request

Creates multiple attributes in a single atomic operation.

Security
Bearer
Bodyapplication/jsonrequiredArray [
namestring[ 1 .. 100 ] charactersrequired

Display name for the attribute.

descriptionstring or null<= 500 characters

Optional explanation of what this attribute represents.

]
curl -i -X POST \
  https://docs.apiera.io/_mock/openapi/v1/attributes/bulk \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "name": "string",
      "description": "string"
    }
  ]'

Responses

Attributes created successfully.

Bodyapplication/jsonArray [
uuidstring(uuid)required

Unique identifier for this attribute.

createdAtstring(date-time)required

Timestamp when this attribute was created.

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

Timestamp when this attribute was last modified.

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

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

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

Current lifecycle status of this attribute.

Enum"draft""published""unpublished""removed"
namestringrequired

Display name for this attribute.

descriptionstring or null

Explanation of what this attribute represents and when to use it.

]
Response
application/json

Batch creation of product attributes

[
  {
    "uuid": "123e4567-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "status": "draft",
    "name": "Brand",
    "description": "Product manufacturer or brand name"
  },
  {
    "uuid": "123e4567-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "status": "draft",
    "name": "Color",
    "description": "Product color or finish"
  },
  {
    "uuid": "123e4567-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "status": "draft",
    "name": "Material",
    "description": "Primary material composition"
  }
]

Bulk update attributes

Request

Updates multiple attributes in a single operation.

Security
Bearer
Bodyapplication/jsonrequiredArray [
uuidstring(uuid)required

Identifier of the attribute to update.

namestring or null[ 1 .. 100 ] characters

Updated display name for the attribute.

descriptionstring or null<= 500 characters

Updated explanation of the attribute.

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

Responses

Attributes updated successfully.

Bodyapplication/jsonArray [
uuidstring(uuid)required

Unique identifier for this attribute.

createdAtstring(date-time)required

Timestamp when this attribute was created.

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

Timestamp when this attribute was last modified.

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

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

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

Current lifecycle status of this attribute.

Enum"draft""published""unpublished""removed"
namestringrequired

Display name for this attribute.

descriptionstring or null

Explanation of what this attribute represents and when to use it.

]
Response
application/json
[
  {
    "uuid": "123e4567-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "status": "published",
    "name": "Brand Name",
    "description": "Official brand or manufacturer name"
  },
  {
    "uuid": "123e4567-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "status": "published",
    "name": "Product Color",
    "description": "Available color options"
  }
]

Get attribute

Request

Retrieves complete details for a single attribute.

Security
Bearer
Path
attributeUuidstring(uuid)required

Unique identifier of the attribute.

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

Responses

Successfully retrieved attribute.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this attribute.

createdAtstring(date-time)required

Timestamp when this attribute was created.

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

Timestamp when this attribute was last modified.

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

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

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

Current lifecycle status of this attribute.

Enum"draft""published""unpublished""removed"
namestringrequired

Display name for this attribute.

descriptionstring or null

Explanation of what this attribute represents and when to use it.

Response
application/json
{
  "uuid": "123e4567-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "status": "published",
  "name": "Brand",
  "description": "Product manufacturer or brand name"
}

Update attribute

Request

Updates an existing attribute. Only provided fields are updated.

Security
Bearer
Path
attributeUuidstring(uuid)required

Unique identifier of the attribute.

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

Updated display name for the attribute.

descriptionstring or null<= 500 characters

Updated explanation of the attribute.

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

Responses

Attribute updated successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this attribute.

createdAtstring(date-time)required

Timestamp when this attribute was created.

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

Timestamp when this attribute was last modified.

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

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

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

Current lifecycle status of this attribute.

Enum"draft""published""unpublished""removed"
namestringrequired

Display name for this attribute.

descriptionstring or null

Explanation of what this attribute represents and when to use it.

Response
application/json

Attribute with modified properties

{
  "uuid": "123e4567-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "status": "published",
  "name": "Brand Name",
  "description": "Official brand or manufacturer name"
}

Delete attribute

Request

Permanently deletes an attribute. Cannot be undone.

Security
Bearer
Path
attributeUuidstring(uuid)required

Unique identifier of the attribute.

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

Responses

Attribute deleted successfully.

Response
No content

Transition attribute lifecycle

Request

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

Security
Bearer
Path
attributeUuidstring(uuid)required

Unique identifier of the attribute.

Bodyapplication/jsonrequired
transitionstringrequired

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

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

Responses

Attribute transitioned successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this attribute.

createdAtstring(date-time)required

Timestamp when this attribute was created.

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

Timestamp when this attribute was last modified.

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

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

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

Current lifecycle status of this attribute.

Enum"draft""published""unpublished""removed"
namestringrequired

Display name for this attribute.

descriptionstring or null

Explanation of what this attribute represents and when to use it.

Response
application/json
{
  "uuid": "123e4567-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "status": "published",
  "name": "Brand",
  "description": "Product manufacturer or brand name"
}

Bulk transition attribute lifecycle

Request

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

Security
Bearer
Bodyapplication/jsonrequired
transitionstringrequired

Lifecycle transition to apply to all specified attributes.

Enum"publish""unpublish""remove""restore"
uuidsArray of strings(uuid)required

List of attribute identifiers to transition.

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

Responses

Attributes transitioned successfully.

Bodyapplication/jsonArray [
uuidstring(uuid)required

Unique identifier for this attribute.

createdAtstring(date-time)required

Timestamp when this attribute was created.

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

Timestamp when this attribute was last modified.

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

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

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

Current lifecycle status of this attribute.

Enum"draft""published""unpublished""removed"
namestringrequired

Display name for this attribute.

descriptionstring or null

Explanation of what this attribute represents and when to use it.

]
Response
application/json
[
  {
    "uuid": "123e4567-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "status": "published",
    "name": "Brand",
    "description": "Product manufacturer or brand name"
  },
  {
    "uuid": "123e4567-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "status": "published",
    "name": "Color",
    "description": "Product color or finish"
  }
]

Attribute Terms

Operations

Assets

Operations

Asset Files

Operations

Asset Metadata

Operations
© 2025 Apiera AS