Skip to content
API Reference
/
/
Bulk transition tag lifec...

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

List tags

Request

Retrieves a paginated list of tags with optional filtering.

Security
Bearer
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.

statuses[eq]Array of strings

Filter by one or more statuses. Accepts multiple values.

Items 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.

include[contents]boolean
expand[contents]boolean
curl -i -X GET \
  'https://docs.apiera.io/_mock/openapi/v1/tags?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&statuses%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&include%5Bcontents%5D=true&expand%5Bcontents%5D=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successfully retrieved paginated list of tags.

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

Unique identifier for this tag.

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

Timestamp when this tag was created.

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

Timestamp when this tag was last modified.

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

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

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

Current lifecycle status of this tag.

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

Code for this tag.

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

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

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

List of locale-specific content for this tag. 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": "123e4567-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "status": "published",
  "code": "bestseller"
}

Create tag

Request

Creates a new tag.

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

Code for the tag.

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

Responses

Tag created successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this tag.

createdAtstring(date-time)required

Timestamp when this tag was created.

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

Timestamp when this tag was last modified.

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

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

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

Current lifecycle status of this tag.

Enum"draft""published""unpublished""removed"
codestringrequired

Code for this tag.

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

Bulk create tags

Request

Creates multiple tags in a single atomic operation.

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

Code for the tag.

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

Responses

Tags created successfully.

Bodyapplication/jsonArray [
uuidstring(uuid)required

Unique identifier for this tag.

createdAtstring(date-time)required

Timestamp when this tag was created.

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

Timestamp when this tag was last modified.

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

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

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

Current lifecycle status of this tag.

Enum"draft""published""unpublished""removed"
codestringrequired

Code for this tag.

]
Response
application/json
[
  {
    "uuid": "123e4567-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "status": "draft",
    "code": "bestseller"
  },
  {
    "uuid": "123e4567-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "status": "draft",
    "code": "new_arrival"
  },
  {
    "uuid": "123e4567-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "status": "draft",
    "code": "sale"
  }
]

Bulk update tags

Request

Updates multiple tags in a single operation.

Security
Bearer
Bodyapplication/jsonrequiredArray [
uuidstring(uuid)required

Identifier of the tag to update.

codestring or null[ 1 .. 100 ] characters

Updated code for the tag.

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

Responses

Tags updated successfully.

Bodyapplication/jsonArray [
uuidstring(uuid)required

Unique identifier for this tag.

createdAtstring(date-time)required

Timestamp when this tag was created.

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

Timestamp when this tag was last modified.

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

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

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

Current lifecycle status of this tag.

Enum"draft""published""unpublished""removed"
codestringrequired

Code for this tag.

]
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",
    "code": "top_seller"
  },
  {
    "uuid": "123e4567-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "status": "published",
    "code": "fresh_arrival"
  }
]

Get tag

Request

Retrieves complete details for a single tag.

Security
Bearer
Path
tagUuidstring(uuid)required

Unique identifier of the tag.

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

Responses

Successfully retrieved tag.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this tag.

createdAtstring(date-time)required

Timestamp when this tag was created.

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

Timestamp when this tag was last modified.

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

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

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

Current lifecycle status of this tag.

Enum"draft""published""unpublished""removed"
codestringrequired

Code for this tag.

contentUuidsArray of strings or null(uuid)

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

contentsArray of objects or null(TagContentResponse)

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

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",
  "code": "bestseller"
}

Update tag

Request

Updates an existing tag. Only provided fields are updated.

Security
Bearer
Path
tagUuidstring(uuid)required

Unique identifier of the tag.

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

Updated code for the tag.

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

Responses

Tag updated successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this tag.

createdAtstring(date-time)required

Timestamp when this tag was created.

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

Timestamp when this tag was last modified.

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

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

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

Current lifecycle status of this tag.

Enum"draft""published""unpublished""removed"
codestringrequired

Code for this tag.

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",
  "code": "top_seller"
}

Delete tag

Request

Permanently deletes a tag. Cannot be undone.

Security
Bearer
Path
tagUuidstring(uuid)required

Unique identifier of the tag.

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

Responses

Tag deleted successfully.

Response
No content

Transition tag lifecycle

Request

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

Security
Bearer
Path
tagUuidstring(uuid)required

Unique identifier of the tag.

Bodyapplication/jsonrequired
transitionstringrequired

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

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

Responses

Tag transitioned successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this tag.

createdAtstring(date-time)required

Timestamp when this tag was created.

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

Timestamp when this tag was last modified.

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

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

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

Current lifecycle status of this tag.

Enum"draft""published""unpublished""removed"
codestringrequired

Code for this tag.

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",
  "code": "bestseller"
}

Bulk transition tag lifecycle

Request

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

Security
Bearer
Bodyapplication/jsonrequired
transitionstringrequired

Lifecycle transition to apply to all specified tags.

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

List of tag identifiers to transition.

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

Responses

Tags transitioned successfully.

Bodyapplication/jsonArray [
uuidstring(uuid)required

Unique identifier for this tag.

createdAtstring(date-time)required

Timestamp when this tag was created.

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

Timestamp when this tag was last modified.

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

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

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

Current lifecycle status of this tag.

Enum"draft""published""unpublished""removed"
codestringrequired

Code for this tag.

]
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",
    "code": "bestseller"
  },
  {
    "uuid": "123e4567-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "status": "published",
    "code": "new_arrival"
  }
]

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

Assets

Operations

Asset Files

Operations

Asset Metadata

Operations
© 2025 Apiera AS