Skip to content
/Product Assets

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

List product assets

Request

Retrieves a paginated list of assets linked to a product.

Security
Bearer
Path
productUuidstring(uuid)required

Unique identifier of the product.

Query
uuids[eq]Array of strings(uuid)

Filter by association UUIDs. Accepts multiple values.

assetUuids[eq]Array of strings(uuid)

Filter by asset UUIDs. Accepts multiple values.

productAssetTypeUuids[eq]Array of strings(uuid)

Filter by product asset type UUIDs. Accepts multiple values.

displayOrder[order]string

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

curl -i -X GET \
  'https://docs.apiera.io/_mock/openapi/v1/products/{productUuid}/assets?uuids%5Beq%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&assetUuids%5Beq%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&productAssetTypeUuids%5Beq%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&displayOrder%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' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successfully retrieved product assets.

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

Unique identifier for this product-asset association.

items[].​productUuidstring(uuid)required

Identifier of the product this asset is linked to.

items[].​assetUuidstring(uuid)required

Identifier of the linked asset.

items[].​productAssetTypeUuidstring(uuid)required

Identifier of the product asset type.

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[].​orderinteger(int32)required

Display order for this asset in product galleries.

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",
    "productUuid": "789e0123-e89b-12d3-a456-426614174001",
    "assetUuid": "234e5678-e89b-12d3-a456-426614174001",
    "productAssetTypeUuid": "fff00000-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "order": 1
  },
  {
    "uuid": "aaa11111-e89b-12d3-a456-426614174001",
    "productUuid": "789e0123-e89b-12d3-a456-426614174001",
    "assetUuid": "234e5678-e89b-12d3-a456-426614174001",
    "productAssetTypeUuid": "fff00000-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "order": 2
  },
  {
    "uuid": "aaa11111-e89b-12d3-a456-426614174001",
    "productUuid": "789e0123-e89b-12d3-a456-426614174001",
    "assetUuid": "234e5678-e89b-12d3-a456-426614174001",
    "productAssetTypeUuid": "fff00000-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "order": 3
  }
]

Link asset to product

Request

Creates a new association between a product and an asset.

Security
Bearer
Path
productUuidstring(uuid)required

Unique identifier of the product.

Bodyapplication/jsonrequired
assetUuidstring(uuid)required

Identifier of the asset to link.

productAssetTypeUuidstring(uuid)required

Identifier of the product asset type.

orderinteger(int32)required

Display order for this asset in product galleries.

curl -i -X POST \
  'https://docs.apiera.io/_mock/openapi/v1/products/{productUuid}/assets' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "assetUuid": "ee6af44a-bc5b-48d8-8594-0296d309de33",
    "productAssetTypeUuid": "3fe69845-2f00-4af7-91b0-56c045ddef20",
    "order": 0
  }'

Responses

Asset linked successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this product-asset association.

productUuidstring(uuid)required

Identifier of the product this asset is linked to.

assetUuidstring(uuid)required

Identifier of the linked asset.

productAssetTypeUuidstring(uuid)required

Identifier of the product asset type.

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"
orderinteger(int32)required

Display order for this asset in product galleries.

Response
application/json
{
  "uuid": "aaa11111-e89b-12d3-a456-426614174001",
  "productUuid": "789e0123-e89b-12d3-a456-426614174001",
  "assetUuid": "234e5678-e89b-12d3-a456-426614174001",
  "productAssetTypeUuid": "fff00000-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-20T08:15:00.000000Z",
  "order": 1
}

Get product asset

Request

Retrieves a single asset association for a product.

Security
Bearer
Path
productUuidstring(uuid)required

Unique identifier of the product.

productAssetUuidstring(uuid)required

Unique identifier of the product-asset association.

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

Responses

Successfully retrieved product asset.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this product-asset association.

productUuidstring(uuid)required

Identifier of the product this asset is linked to.

assetUuidstring(uuid)required

Identifier of the linked asset.

productAssetTypeUuidstring(uuid)required

Identifier of the product asset type.

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"
orderinteger(int32)required

Display order for this asset in product galleries.

Response
application/json
{
  "uuid": "aaa11111-e89b-12d3-a456-426614174001",
  "productUuid": "789e0123-e89b-12d3-a456-426614174001",
  "assetUuid": "234e5678-e89b-12d3-a456-426614174001",
  "productAssetTypeUuid": "fff00000-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-20T08:15:00.000000Z",
  "order": 1
}

Update product asset

Request

Updates an existing product-asset association. Only provided fields are updated.

Security
Bearer
Path
productUuidstring(uuid)required

Unique identifier of the product.

productAssetUuidstring(uuid)required

Unique identifier of the product-asset association.

Bodyapplication/jsonrequired
productAssetTypeUuidstring or null(uuid)

Updated product asset type identifier.

orderinteger or null(int32)

Updated display order for this asset.

curl -i -X PATCH \
  'https://docs.apiera.io/_mock/openapi/v1/products/{productUuid}/assets/{productAssetUuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "productAssetTypeUuid": "3fe69845-2f00-4af7-91b0-56c045ddef20",
    "order": 0
  }'

Responses

Product asset updated successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this product-asset association.

productUuidstring(uuid)required

Identifier of the product this asset is linked to.

assetUuidstring(uuid)required

Identifier of the linked asset.

productAssetTypeUuidstring(uuid)required

Identifier of the product asset type.

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"
orderinteger(int32)required

Display order for this asset in product galleries.

Response
application/json
{
  "uuid": "aaa11111-e89b-12d3-a456-426614174001",
  "productUuid": "789e0123-e89b-12d3-a456-426614174001",
  "assetUuid": "234e5678-e89b-12d3-a456-426614174001",
  "productAssetTypeUuid": "fff00000-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "order": 1
}

Unlink asset from product

Request

Removes an asset association from a product.

Security
Bearer
Path
productUuidstring(uuid)required

Unique identifier of the product.

productAssetUuidstring(uuid)required

Unique identifier of the product-asset association.

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

Responses

Asset unlinked successfully.

Response
No content

Bulk link assets to product

Request

Creates multiple asset associations for a product in a single operation.

Security
Bearer
Path
productUuidstring(uuid)required

Unique identifier of the product.

Bodyapplication/jsonrequiredArray [
assetUuidstring(uuid)required

Identifier of the asset to link.

productAssetTypeUuidstring(uuid)required

Identifier of the product asset type.

orderinteger(int32)required

Display order for this asset in product galleries.

]
curl -i -X POST \
  'https://docs.apiera.io/_mock/openapi/v1/products/{productUuid}/assets/bulk' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "assetUuid": "ee6af44a-bc5b-48d8-8594-0296d309de33",
      "productAssetTypeUuid": "3fe69845-2f00-4af7-91b0-56c045ddef20",
      "order": 0
    }
  ]'

Responses

Assets linked successfully.

Bodyapplication/jsonArray [
uuidstring(uuid)required

Unique identifier for this product-asset association.

productUuidstring(uuid)required

Identifier of the product this asset is linked to.

assetUuidstring(uuid)required

Identifier of the linked asset.

productAssetTypeUuidstring(uuid)required

Identifier of the product asset type.

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"
orderinteger(int32)required

Display order for this asset in product galleries.

]
Response
application/json
[
  {
    "uuid": "aaa11111-e89b-12d3-a456-426614174001",
    "productUuid": "789e0123-e89b-12d3-a456-426614174001",
    "assetUuid": "234e5678-e89b-12d3-a456-426614174001",
    "productAssetTypeUuid": "fff00000-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "order": 1
  },
  {
    "uuid": "aaa11111-e89b-12d3-a456-426614174001",
    "productUuid": "789e0123-e89b-12d3-a456-426614174001",
    "assetUuid": "234e5678-e89b-12d3-a456-426614174001",
    "productAssetTypeUuid": "fff00000-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "order": 2
  },
  {
    "uuid": "aaa11111-e89b-12d3-a456-426614174001",
    "productUuid": "789e0123-e89b-12d3-a456-426614174001",
    "assetUuid": "234e5678-e89b-12d3-a456-426614174001",
    "productAssetTypeUuid": "fff00000-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "order": 3
  },
  {
    "uuid": "aaa11111-e89b-12d3-a456-426614174001",
    "productUuid": "789e0123-e89b-12d3-a456-426614174001",
    "assetUuid": "234e5678-e89b-12d3-a456-426614174001",
    "productAssetTypeUuid": "fff00000-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "order": 4
  }
]

Bulk update product assets

Request

Updates multiple product-asset associations in a single operation.

Security
Bearer
Path
productUuidstring(uuid)required

Unique identifier of the product.

Bodyapplication/jsonrequiredArray [
uuidstring(uuid)required

Identifier of the product-asset association to update.

productAssetTypeUuidstring or null(uuid)

Updated product asset type identifier.

orderinteger or null(int32)

Updated display order for this asset.

]
curl -i -X PATCH \
  'https://docs.apiera.io/_mock/openapi/v1/products/{productUuid}/assets/bulk' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "productAssetTypeUuid": "3fe69845-2f00-4af7-91b0-56c045ddef20",
      "order": 0
    }
  ]'

Responses

Product assets updated successfully.

Bodyapplication/jsonArray [
uuidstring(uuid)required

Unique identifier for this product-asset association.

productUuidstring(uuid)required

Identifier of the product this asset is linked to.

assetUuidstring(uuid)required

Identifier of the linked asset.

productAssetTypeUuidstring(uuid)required

Identifier of the product asset type.

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"
orderinteger(int32)required

Display order for this asset in product galleries.

]
Response
application/json
[
  {
    "uuid": "aaa11111-e89b-12d3-a456-426614174001",
    "productUuid": "789e0123-e89b-12d3-a456-426614174001",
    "assetUuid": "234e5678-e89b-12d3-a456-426614174001",
    "productAssetTypeUuid": "fff00000-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "order": 1
  },
  {
    "uuid": "aaa11111-e89b-12d3-a456-426614174001",
    "productUuid": "789e0123-e89b-12d3-a456-426614174001",
    "assetUuid": "234e5678-e89b-12d3-a456-426614174001",
    "productAssetTypeUuid": "fff00000-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "order": 2
  },
  {
    "uuid": "aaa11111-e89b-12d3-a456-426614174001",
    "productUuid": "789e0123-e89b-12d3-a456-426614174001",
    "assetUuid": "234e5678-e89b-12d3-a456-426614174001",
    "productAssetTypeUuid": "fff00000-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "order": 3
  }
]

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