Asset Files

Asset Collections

An asset collection links an asset to a collection, enabling assets to be organized into flexible groupings.

Operations

Assets

An asset represents a managed file such as an image, video, or document. Each asset tracks its category, storage location, and descriptive metadata.

Operations

Attribute Contents

Attribute content provides locale-specific labels and descriptions for an attribute. Each content entry localizes the attribute for a specific locale, enabling multilingual attribute presentation.

Operations

Attributes

An attribute drives filtering and variants for products, such as color, size, or material. Each attribute defines a finite set of values that products can be classified and filtered by.

Operations

Brand Contents

Brand content provides locale-specific labels and descriptions for a brand. Each content entry localizes the brand for a specific locale, enabling multilingual brand presentation.

Operations

Brands

A brand identifies the manufacturer or label associated with products. Brands support localized content through brand content entries.

Operations

Category Contents

Category content provides locale-specific labels and descriptions for a category. Each content entry localizes the category for a specific locale, enabling multilingual category presentation.

Operations

Channels

A channel is a market distribution template that defines the requirements products must meet to be published to a specific sales context or geographic market.

Operations

Channel Input Types

A channel input type is an association between a channel and an input type, defining the requirement level and scoping behavior for that input type within the channel.

Operations

Collections

A collection is a flexible grouping mechanism for organizing assets. Collections support hierarchical structures through parent-child relationships and follow a lifecycle model with draft, active, inactive, and removed states.

Operations

Family Asset Types

A family asset type is an association between a family and an asset type, defining count constraints and applicability to parent and variant products.

Operations

Family Attributes

A family attribute is an association between a family and an attribute, defining the requirement level and auto-population behavior for that attribute within the family.

Operations

Family Categories

A family category is an association between a family and a category, defining the requirement level and auto-population behavior for that category within the family.

Operations

Families

A family is a product blueprint that defines the structure and requirements for a specific type of product, ensuring consistency and data quality across all products of the same type.

Operations

Family Input Types

A family input type is an association between a family and an input type, defining the requirement level and applicability to parent and variant products.

Operations

Family Relation Types

A family relation type is an association between a family and a relation type, defining count constraints for product relations within the family.

Operations

A file represents an individual version or variation of an asset, such as an original upload, a thumbnail, or a web-optimized rendition. Files are uploaded through a two-step process of initiation and completion.

Operations

Bulk initiate file uploads

Request

Initiates uploads for multiple files across one or more assets in a single operation.

Security

Bearer

Bodyapplication/jsonrequiredArray [

assetUuidstring(uuid)required

Identifier of the asset to associate files with.

variationTypestring(FileVariationType)required

Variation type indicating the intended use of a file.

Enum Value	Description
original	The original unmodified source file.
thumbnail	A small preview image.
webOptimized	Optimized for web display.
mobileOptimized	Optimized for mobile devices.
productDetail	Sized for product detail pages.
printReady	High-resolution file suitable for print.
socialMedia	Formatted for social media platforms.
videoPoster	A static poster image for a video.
videoPreview	A short preview clip of a video.
videoStreamLow	Low-quality video stream variant.

storageLocationstring(StorageLocation)required

Storage backend where asset files are stored.

Value	Description
s3	Amazon S3 object storage.

mimeTypestring<= 255 charactersrequired

MIME type of the file being uploaded.

extensionstring<= 10 charactersrequired

File extension of the file being uploaded.

]

curl -i -X POST \
  https://docs.apiera.io/_mock/openapi/v1/assets/files/bulk/actions/initiate-upload \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "assetUuid": "ee6af44a-bc5b-48d8-8594-0296d309de33",
      "variationType": "original",
      "storageLocation": "s3",
      "mimeType": "string",
      "extension": "string"
    }
  ]'

Responses

The created files with presigned upload URLs.

Bodyapplication/jsonArray [

uuidstring(uuid)required

Unique identifier for this file.

assetUuidstring(uuid)required

Identifier of the parent asset this file belongs to.

createdAtstring(date-time)required

Timestamp when this file was created.

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

statusstring(FileStatus)required

Upload status of a file.

Enum Value	Description
awaitingUpload	The file record has been created but the binary has not yet been uploaded.
uploaded	The file binary has been successfully uploaded.

variationTypestring(FileVariationType)required

Variation type indicating the intended use of a file.

Enum Value	Description
original	The original unmodified source file.
thumbnail	A small preview image.
webOptimized	Optimized for web display.
mobileOptimized	Optimized for mobile devices.
productDetail	Sized for product detail pages.
printReady	High-resolution file suitable for print.
socialMedia	Formatted for social media platforms.
videoPoster	A static poster image for a video.
videoPreview	A short preview clip of a video.
videoStreamLow	Low-quality video stream variant.

storageLocationstring(StorageLocation)required

Storage backend where asset files are stored.

Value	Description
s3	Amazon S3 object storage.

mimeTypestringrequired

MIME type of this file.

extensionstringrequired

File extension of this file.

storageSizeinteger or null(int64)

File size in bytes. Null if not yet calculated.

checksumstringrequired

SHA-256 checksum for file integrity verification.

isAutogeneratedbooleanrequired

Whether this file was automatically generated by the system.

presignedUrlstringrequired

Temporary pre-signed URL for downloading this file.

]

Response

application/json

[
  {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "assetUuid": "ee6af44a-bc5b-48d8-8594-0296d309de33",
    "createdAt": "2025-11-23T14:15:22.123456Z",
    "status": "awaitingUpload",
    "variationType": "original",
    "storageLocation": "s3",
    "mimeType": "string",
    "extension": "string",
    "storageSize": 0,
    "checksum": "string",
    "isAutogenerated": true,
    "presignedUrl": "string"
  }
]

Bulk complete file uploads

Request

Marks multiple file uploads as complete in a single operation.

Security

Bearer

Bodyapplication/jsonrequiredArray [

assetUuidstring(uuid)required

Identifier of the asset associated with the file.

fileUuidstring(uuid)required

Identifier of the file to complete.

checksumstring= 64 charactersrequired

SHA-256 checksum of the uploaded file for integrity verification.

]

curl -i -X PATCH \
  https://docs.apiera.io/_mock/openapi/v1/assets/files/bulk/actions/complete-upload \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "assetUuid": "ee6af44a-bc5b-48d8-8594-0296d309de33",
      "fileUuid": "cfc6962f-d401-4825-9c0a-77bccac9ba59",
      "checksum": "stringstringstringstringstringstringstringstringstringstringstri"
    }
  ]'

Responses

The files after upload completion.

Bodyapplication/jsonArray [

uuidstring(uuid)required

Unique identifier for this file.

assetUuidstring(uuid)required

Identifier of the parent asset this file belongs to.

createdAtstring(date-time)required

Timestamp when this file was created.

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

statusstring(FileStatus)required

Upload status of a file.

Enum Value	Description
awaitingUpload	The file record has been created but the binary has not yet been uploaded.
uploaded	The file binary has been successfully uploaded.

variationTypestring(FileVariationType)required

Variation type indicating the intended use of a file.

Enum Value	Description
original	The original unmodified source file.
thumbnail	A small preview image.
webOptimized	Optimized for web display.
mobileOptimized	Optimized for mobile devices.
productDetail	Sized for product detail pages.
printReady	High-resolution file suitable for print.
socialMedia	Formatted for social media platforms.
videoPoster	A static poster image for a video.
videoPreview	A short preview clip of a video.
videoStreamLow	Low-quality video stream variant.

storageLocationstring(StorageLocation)required

Storage backend where asset files are stored.

Value	Description
s3	Amazon S3 object storage.

mimeTypestringrequired

MIME type of this file.

extensionstringrequired

File extension of this file.

storageSizeinteger or null(int64)

File size in bytes. Null if not yet calculated.

checksumstringrequired

SHA-256 checksum for file integrity verification.

isAutogeneratedbooleanrequired

Whether this file was automatically generated by the system.

presignedUrlstringrequired

Temporary pre-signed URL for downloading this file.

]

Response

application/json

[
  {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "assetUuid": "ee6af44a-bc5b-48d8-8594-0296d309de33",
    "createdAt": "2025-11-23T14:15:22.123456Z",
    "status": "awaitingUpload",
    "variationType": "original",
    "storageLocation": "s3",
    "mimeType": "string",
    "extension": "string",
    "storageSize": 0,
    "checksum": "string",
    "isAutogenerated": true,
    "presignedUrl": "string"
  }
]

List asset files

Request

Retrieves a paginated list of files belonging to an asset.

Security

Bearer

Path

assetUuidstring(uuid)required

The unique identifier of the asset.

Query

uuids[eq]Array of strings(uuid)

statuses[eq]Array of strings(FileStatus)

Items Enum Value	Description
awaitingUpload	The file record has been created but the binary has not yet been uploaded.
uploaded	The file binary has been successfully uploaded.

status[order]string

variationTypes[eq]Array of strings(FileVariationType)

Items Enum Value	Description
original	The original unmodified source file.
thumbnail	A small preview image.
webOptimized	Optimized for web display.
mobileOptimized	Optimized for mobile devices.
productDetail	Sized for product detail pages.
printReady	High-resolution file suitable for print.
socialMedia	Formatted for social media platforms.
videoPoster	A static poster image for a video.
videoPreview	A short preview clip of a video.
videoStreamLow	Low-quality video stream variant.

variationType[order]string

mimeTypes[eq]Array of strings

extensions[eq]Array of strings

extension[contains]string

extension[starts]string

extension[ends]string

isAutogenerated[eq]boolean

createdAt[eq]string(date-time)

Example: createdAt[eq]=2025-11-23T14:15:22.123456Z

createdAt[min]string(date-time)

Example: createdAt[min]=2025-11-23T14:15:22.123456Z

createdAt[max]string(date-time)

Example: createdAt[max]=2025-11-23T14:15:22.123456Z

createdAt[order]string

storageSize[order]string

pageinteger(int32)

sizeinteger(int32)

curl -i -X GET \
  'https://docs.apiera.io/_mock/openapi/v1/assets/{assetUuid}/files?uuids%5Beq%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&statuses%5Beq%5D=awaitingUpload&status%5Border%5D=string&variationTypes%5Beq%5D=original&variationType%5Border%5D=string&mimeTypes%5Beq%5D=string&extensions%5Beq%5D=string&extension%5Bcontains%5D=string&extension%5Bstarts%5D=string&extension%5Bends%5D=string&isAutogenerated%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&storageSize%5Border%5D=string&page=0&size=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

A paginated list of asset files.

Bodyapplication/json

itemsArray of objects(FileResponse)required

items[].uuidstring(uuid)required

Unique identifier for this file.

items[].assetUuidstring(uuid)required

Identifier of the parent asset this file belongs to.

items[].createdAtstring(date-time)required

Timestamp when this file was created.

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

items[].statusstring(FileStatus)required

Upload status of a file.

Enum Value	Description
awaitingUpload	The file record has been created but the binary has not yet been uploaded.
uploaded	The file binary has been successfully uploaded.

items[].variationTypestring(FileVariationType)required

Variation type indicating the intended use of a file.

Enum Value	Description
original	The original unmodified source file.
thumbnail	A small preview image.
webOptimized	Optimized for web display.
mobileOptimized	Optimized for mobile devices.
productDetail	Sized for product detail pages.
printReady	High-resolution file suitable for print.
socialMedia	Formatted for social media platforms.
videoPoster	A static poster image for a video.
videoPreview	A short preview clip of a video.
videoStreamLow	Low-quality video stream variant.

items[].storageLocationstring(StorageLocation)required

Storage backend where asset files are stored.

Value	Description
s3	Amazon S3 object storage.

items[].mimeTypestringrequired

MIME type of this file.

items[].extensionstringrequired

File extension of this file.

items[].storageSizeinteger or null(int64)

File size in bytes. Null if not yet calculated.

items[].checksumstringrequired

SHA-256 checksum for file integrity verification.

items[].isAutogeneratedbooleanrequired

Whether this file was automatically generated by the system.

items[].presignedUrlstringrequired

Temporary pre-signed URL for downloading this file.

paginationobject(PaginationResult)required

pagination.pageinteger(int32)required

pagination.sizeinteger(int32)required

pagination.totalItemsinteger(int32)required

pagination.totalPagesinteger(int32)required

Response

application/json

{
  "items": [
    { … }
  ],
  "pagination": {
    "page": 0,
    "size": 0,
    "totalItems": 0,
    "totalPages": 0
  }
}

Get an asset file

Request

Retrieves a single file by its unique identifier.

Security

Bearer

Path

assetUuidstring(uuid)required

The unique identifier of the asset.

fileUuidstring(uuid)required

The unique identifier of the file.

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

Responses

The requested file.

Bodyapplication/json

uuidstring(uuid)required

Unique identifier for this file.

assetUuidstring(uuid)required

Identifier of the parent asset this file belongs to.

createdAtstring(date-time)required

Timestamp when this file was created.

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

statusstring(FileStatus)required

Upload status of a file.

Enum Value	Description
awaitingUpload	The file record has been created but the binary has not yet been uploaded.
uploaded	The file binary has been successfully uploaded.

variationTypestring(FileVariationType)required

Variation type indicating the intended use of a file.

Enum Value	Description
original	The original unmodified source file.
thumbnail	A small preview image.
webOptimized	Optimized for web display.
mobileOptimized	Optimized for mobile devices.
productDetail	Sized for product detail pages.
printReady	High-resolution file suitable for print.
socialMedia	Formatted for social media platforms.
videoPoster	A static poster image for a video.
videoPreview	A short preview clip of a video.
videoStreamLow	Low-quality video stream variant.

storageLocationstring(StorageLocation)required

Storage backend where asset files are stored.

Value	Description
s3	Amazon S3 object storage.

mimeTypestringrequired

MIME type of this file.

extensionstringrequired

File extension of this file.

storageSizeinteger or null(int64)

File size in bytes. Null if not yet calculated.

checksumstringrequired

SHA-256 checksum for file integrity verification.

isAutogeneratedbooleanrequired

Whether this file was automatically generated by the system.

presignedUrlstringrequired

Temporary pre-signed URL for downloading this file.

Response

application/json

{
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "assetUuid": "a1b2c3d4-5678-9012-3456-789012345678",
  "createdAt": "2025-01-15T10:30:00.000000Z",
  "status": "uploaded",
  "variationType": "original",
  "storageLocation": "s3",
  "mimeType": "image/jpeg",
  "extension": ".jpg",
  "storageSize": 204800,
  "checksum": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
  "isAutogenerated": false,
  "presignedUrl": "https://storage.example.com/files/3fa85f64.jpg?token=abc123"
}

Delete an asset file

Request

Permanently deletes a file from an asset.

Security

Bearer

Path

assetUuidstring(uuid)required

The unique identifier of the asset.

fileUuidstring(uuid)required

The unique identifier of the file to delete.

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

Responses

The file was successfully deleted.

Response

No content

Initiate a file upload

Request

Initiates an upload for a new file within an asset. Returns a presigned URL for uploading the file content.

Security

Bearer

Path

assetUuidstring(uuid)required

The unique identifier of the asset.

Bodyapplication/jsonrequired

variationTypestring(FileVariationType)required

Variation type indicating the intended use of a file.

Enum Value	Description
original	The original unmodified source file.
thumbnail	A small preview image.
webOptimized	Optimized for web display.
mobileOptimized	Optimized for mobile devices.
productDetail	Sized for product detail pages.
printReady	High-resolution file suitable for print.
socialMedia	Formatted for social media platforms.
videoPoster	A static poster image for a video.
videoPreview	A short preview clip of a video.
videoStreamLow	Low-quality video stream variant.

storageLocationstring(StorageLocation)required

Storage backend where asset files are stored.

Value	Description
s3	Amazon S3 object storage.

mimeTypestring<= 255 charactersrequired

MIME type of the file being uploaded.

extensionstring<= 10 charactersrequired

File extension of the file being uploaded.

curl -i -X POST \
  'https://docs.apiera.io/_mock/openapi/v1/assets/{assetUuid}/files/actions/initiate-upload' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "variationType": "original",
    "storageLocation": "s3",
    "mimeType": "string",
    "extension": "string"
  }'

Responses

The created file with a presigned upload URL.

Bodyapplication/json

uuidstring(uuid)required

Unique identifier for this file.

assetUuidstring(uuid)required

Identifier of the parent asset this file belongs to.

createdAtstring(date-time)required

Timestamp when this file was created.

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

statusstring(FileStatus)required

Upload status of a file.

Enum Value	Description
awaitingUpload	The file record has been created but the binary has not yet been uploaded.
uploaded	The file binary has been successfully uploaded.

variationTypestring(FileVariationType)required

Variation type indicating the intended use of a file.

Enum Value	Description
original	The original unmodified source file.
thumbnail	A small preview image.
webOptimized	Optimized for web display.
mobileOptimized	Optimized for mobile devices.
productDetail	Sized for product detail pages.
printReady	High-resolution file suitable for print.
socialMedia	Formatted for social media platforms.
videoPoster	A static poster image for a video.
videoPreview	A short preview clip of a video.
videoStreamLow	Low-quality video stream variant.

storageLocationstring(StorageLocation)required

Storage backend where asset files are stored.

Value	Description
s3	Amazon S3 object storage.

mimeTypestringrequired

MIME type of this file.

extensionstringrequired

File extension of this file.

storageSizeinteger or null(int64)

File size in bytes. Null if not yet calculated.

checksumstringrequired

SHA-256 checksum for file integrity verification.

isAutogeneratedbooleanrequired

Whether this file was automatically generated by the system.

presignedUrlstringrequired

Temporary pre-signed URL for downloading this file.

Response

application/json

{
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "assetUuid": "a1b2c3d4-5678-9012-3456-789012345678",
  "createdAt": "2025-01-15T10:30:00.000000Z",
  "status": "awaitingUpload",
  "variationType": "original",
  "storageLocation": "s3",
  "mimeType": "image/jpeg",
  "extension": ".jpg",
  "checksum": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
  "isAutogenerated": false,
  "presignedUrl": "https://storage.example.com/files/3fa85f64.jpg?token=abc123"
}

Complete a file upload

Request

Marks a file upload as complete after the file content has been uploaded to the presigned URL.

Security

Bearer

Path

assetUuidstring(uuid)required

The unique identifier of the asset.

fileUuidstring(uuid)required

The unique identifier of the file to complete.

Bodyapplication/jsonrequired

checksumstring= 64 charactersrequired

SHA-256 checksum of the uploaded file for integrity verification.

curl -i -X PATCH \
  'https://docs.apiera.io/_mock/openapi/v1/assets/{assetUuid}/files/{fileUuid}/actions/complete-upload' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "checksum": "stringstringstringstringstringstringstringstringstringstringstri"
  }'

Responses

The file after upload completion.

Bodyapplication/json

uuidstring(uuid)required

Unique identifier for this file.

assetUuidstring(uuid)required

Identifier of the parent asset this file belongs to.

createdAtstring(date-time)required

Timestamp when this file was created.

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

statusstring(FileStatus)required

Upload status of a file.

Enum Value	Description
awaitingUpload	The file record has been created but the binary has not yet been uploaded.
uploaded	The file binary has been successfully uploaded.

variationTypestring(FileVariationType)required

Variation type indicating the intended use of a file.

Enum Value	Description
original	The original unmodified source file.
thumbnail	A small preview image.
webOptimized	Optimized for web display.
mobileOptimized	Optimized for mobile devices.
productDetail	Sized for product detail pages.
printReady	High-resolution file suitable for print.
socialMedia	Formatted for social media platforms.
videoPoster	A static poster image for a video.
videoPreview	A short preview clip of a video.
videoStreamLow	Low-quality video stream variant.

storageLocationstring(StorageLocation)required

Storage backend where asset files are stored.

Value	Description
s3	Amazon S3 object storage.

mimeTypestringrequired

MIME type of this file.

extensionstringrequired

File extension of this file.

storageSizeinteger or null(int64)

File size in bytes. Null if not yet calculated.

checksumstringrequired

SHA-256 checksum for file integrity verification.

isAutogeneratedbooleanrequired

Whether this file was automatically generated by the system.

presignedUrlstringrequired

Temporary pre-signed URL for downloading this file.

Response

application/json

{
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "assetUuid": "a1b2c3d4-5678-9012-3456-789012345678",
  "createdAt": "2025-01-15T10:30:00.000000Z",
  "status": "uploaded",
  "variationType": "original",
  "storageLocation": "s3",
  "mimeType": "image/jpeg",
  "extension": ".jpg",
  "storageSize": 204800,
  "checksum": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
  "isAutogenerated": false,
  "presignedUrl": "https://storage.example.com/files/3fa85f64.jpg?token=abc123"
}

Input Types

An input type defines a data entry field within a type group, such as a product description, regular price, or SEO metadata. Each input type specifies its data type and validation constraints for the values captured against it.

Operations

Locales

A locale defines a language and region combination used for localizing content across the system. One locale can be designated as the default for the tenant.

Operations

Product Assets

A product asset is an association between a product and an asset, classified by asset type and ordered by display priority.

Operations

Product Asset Types

A product asset type classifies the different kinds of assets that can be attached to products and controls featured asset selection.

Operations

Product Attributes

A product attribute is an association between a product and an attribute, indicating whether it is used for variant differentiation.

Operations

Product Categories

A product category is an association between a product and a category, used for organizing products into groups.

Operations

Product Channel Publications

A product channel publication represents the publication state of a product for a specific channel.

Operations

Product Channel Publication Schedules

A product channel publication schedule automates lifecycle transitions for a channel publication at a specified time.

Operations

Products

A product is the central entity that holds enriched content, attributes, assets, categories, and relations. Products can be simple, variant parents, or variants.

Operations

Product Input Values

A product input value holds the actual data entered for a product's input type, optionally scoped to a specific channel and locale.

Operations

Product Relations

A product relation is a typed link between two products, classified by a product relation type.

Operations

Product Relation Types

A product relation type defines a named, directional relationship that can exist between products, supporting both one-way and two-way relations.

Operations

Product Tags

A product tag is an association between a product and a tag, used for flexible cross-cutting classification.

Operations

Product Terms

A product term is an association between a product attribute and a specific term value selected from the attribute's term set.

Operations

Tag Contents

Tag content provides locale-specific labels and descriptions for a tag. Each content entry localizes the tag for a specific locale, enabling multilingual tag presentation.

Operations

Attribute Term Contents

Operations

Attribute Terms

A term defines a discrete value within an attribute, such as Red, Blue, or XL. Terms provide the selectable options used for product filtering and variant differentiation.

Operations

Type Groups

A type group is a logical grouping of input types for a single entity type, such as product specifications or product dimensions. Each type group belongs to one entity type and organizes related input types under a common category.

Operations

Webhook Delivery Attempts

Webhook delivery attempts represent individual HTTP requests made to deliver a webhook event. Each delivery may have multiple attempts with detailed response information.

Operations

Webhook Deliveries

Webhook deliveries represent individual delivery attempts of webhook events to a subscription's target URL. Deliveries are read-only and provide visibility into delivery status and retry history.

Operations

Webhook Event Types

Webhook event types represent the types of events that can trigger webhook deliveries. These are platform-managed and available as read-only to all authenticated users.

Operations

Webhook Subscriptions

A webhook subscription defines a target URL that receives HTTP callbacks when specific events occur in the system. Subscriptions can be activated, deactivated, and configured with specific event types to listen for.

Operations

Webhook Subscription Event Types

Webhook subscription event types define which event types a webhook subscription listens for. Adding an event type to a subscription means the subscription will receive callbacks when that event occurs.

Operations

Apiera REST API (1.1.0)CopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from ClaudeConnect to CursorInstall MCP server on CursorConnect to VS CodeInstall MCP server on VS Code

Asset Collections

Assets

Attribute Contents

Attributes

Brand Contents

Brands

Category Contents

Categories

Channels

Channel Input Types

Collections

Family Asset Types

Family Attributes

Family Categories

Families

Family Input Types

Family Relation Types

Asset Files

Bulk initiate file uploads

Request

Responses

Was this helpful?

Bulk complete file uploads

Request

Responses

Was this helpful?

List asset files

Request

Responses

Was this helpful?

Get an asset file

Request

Responses

Was this helpful?

Delete an asset file

Request

Responses

Was this helpful?

Initiate a file upload

Request

Responses

Was this helpful?

Complete a file upload

Request

Responses

Was this helpful?

Input Types

Locales

Product Assets

Product Asset Types

Product Attributes

Product Categories

Product Channel Publications

Product Channel Publication Schedules

Products

Product Input Values

Product Relations

Product Relation Types

Product Tags

Product Terms

Tag Contents

Tags

Attribute Term Contents

Attribute Terms

Type Groups

Webhook Delivery Attempts

Webhook Deliveries

Webhook Event Types

Webhook Subscriptions

Webhook Subscription Event Types

Apiera REST API (1.1.0)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code