Skip to content

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

List product asset types

Request

Retrieves a paginated list of product asset types 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.

isFeatured[eq]boolean

Filter by featured 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/product-asset-types?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&isFeatured%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 product asset types.

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

Unique identifier for this product asset type.

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

Timestamp when this product asset type was created.

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

Timestamp when this product asset type was last modified.

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

Code for this product asset type.

items[].​isFeaturedbooleanrequired

Indicates if this is the featured product asset type.

paginationobject(PaginationResult)required
pagination.​pageinteger(int32)required
pagination.​sizeinteger(int32)required
pagination.​totalItemsinteger(int32)required
pagination.​totalPagesinteger(int32)required
Response
application/json
[ { "uuid": "fff11111-e89b-12d3-a456-426614174001", "createdAt": "2025-11-20T08:15:00.000000Z", "updatedAt": "2025-11-20T08:15:00.000000Z", "code": "main_image", "isFeatured": false }, { "uuid": "fff11111-e89b-12d3-a456-426614174001", "createdAt": "2025-11-20T08:15:00.000000Z", "updatedAt": "2025-11-20T08:15:00.000000Z", "code": "gallery", "isFeatured": false }, { "uuid": "fff11111-e89b-12d3-a456-426614174001", "createdAt": "2025-11-20T08:15:00.000000Z", "updatedAt": "2025-11-20T08:15:00.000000Z", "code": "datasheet", "isFeatured": false } ]

Create product asset type

Request

Creates a new product asset type.

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

Code for the product asset type.

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

Responses

Product asset type created successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this product asset type.

createdAtstring(date-time)required

Timestamp when this product asset type was created.

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

Timestamp when this product asset type was last modified.

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

Code for this product asset type.

isFeaturedbooleanrequired

Indicates if this is the featured product asset type.

Response
application/json
{ "uuid": "fff11111-e89b-12d3-a456-426614174001", "createdAt": "2025-11-20T08:15:00.000000Z", "updatedAt": "2025-11-20T08:15:00.000000Z", "code": "main_image", "isFeatured": false }

Get product asset type

Request

Retrieves complete details for a single product asset type.

Security
Bearer
Path
productAssetTypeUuidstring(uuid)required

Unique identifier of the product asset type.

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

Responses

Successfully retrieved product asset type.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this product asset type.

createdAtstring(date-time)required

Timestamp when this product asset type was created.

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

Timestamp when this product asset type was last modified.

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

Code for this product asset type.

isFeaturedbooleanrequired

Indicates if this is the featured product asset type.

Response
application/json
{ "uuid": "fff11111-e89b-12d3-a456-426614174001", "createdAt": "2025-11-20T08:15:00.000000Z", "updatedAt": "2025-11-20T08:15:00.000000Z", "code": "main_image", "isFeatured": false }

Update product asset type

Request

Updates an existing product asset type. Only provided fields are updated.

Security
Bearer
Path
productAssetTypeUuidstring(uuid)required

Unique identifier of the product asset type.

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

Updated code for the product asset type.

isFeaturedboolean or nullrequired
curl -i -X PATCH \
  'https://docs.apiera.io/_mock/openapi/v1/product-asset-types/{productAssetTypeUuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "string",
    "isFeatured": true
  }'

Responses

Product asset type updated successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this product asset type.

createdAtstring(date-time)required

Timestamp when this product asset type was created.

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

Timestamp when this product asset type was last modified.

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

Code for this product asset type.

isFeaturedbooleanrequired

Indicates if this is the featured product asset type.

Response
application/json
{ "uuid": "fff11111-e89b-12d3-a456-426614174001", "createdAt": "2025-11-20T08:15:00.000000Z", "updatedAt": "2025-11-23T15:45:00.000000Z", "code": "hero_image", "isFeatured": false }

Delete product asset type

Request

Permanently deletes a product asset type. Cannot be undone.

Security
Bearer
Path
productAssetTypeUuidstring(uuid)required

Unique identifier of the product asset type.

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

Responses

Product asset type deleted successfully.

Response
No content

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