Skip to content
API Reference
/
/
Bulk transition product l...

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

Product Asset Types

Operations

Product Attributes

Operations

Product Categories

Operations

Product Contents

Operations

Products

Operations

List products

Request

Retrieves a paginated list of products with optional filtering and hydration.

Security
Bearer
Query
uuids[eq]Array of strings(uuid)

Filter by one or more UUIDs. Accepts multiple values.

familyUuids[eq]Array of strings(uuid)

Filter by one or more family UUIDs. Accepts multiple values.

skuUuids[eq]Array of strings(uuid)

Filter by one or more SKU UUIDs. Accepts multiple values.

brandUuids[eq]Array of strings(uuid)

Filter by one or more brand UUIDs. Accepts multiple values.

assetUuids[eq]Array of strings(uuid)

Filter by one or more linked asset UUIDs. Accepts multiple values.

attributeUuids[eq]Array of strings(uuid)

Filter by one or more linked attribute UUIDs. Accepts multiple values.

parentUuids[eq]Array of strings or null(uuid)

Filter by one or more parent product 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""archived""removed"
status[order]string

Sort order for status field. Values: asc, desc.

types[eq]Array of strings

Filter by one or more product types. Accepts multiple values.

Items Enum"simple""variantParent""variant"
type[order]string

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

isArchived[eq]boolean

Filter by archived status. Values: true, false.

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[productAssets]boolean

Include product asset junction UUIDs. Values: true, false.

expand[productAssets]boolean

Expand product asset junctions with full details. Values: true, false.

include[productAttributes]boolean

Include product attribute junction UUIDs. Values: true, false.

expand[productAttributes]boolean

Expand product attribute junctions with full details. Values: true, false.

include[productAttributeTerms]boolean

Include product attribute term junction UUIDs. Values: true, false.

expand[productAttributeTerms]boolean

Expand product attribute term junctions with full details. Values: true, false.

include[productCategories]boolean

Include product category junction UUIDs. Values: true, false.

expand[productCategories]boolean

Expand product category junctions with full details. Values: true, false.

include[productTags]boolean

Include product tag junction UUIDs. Values: true, false.

expand[productTags]boolean

Expand product tag junctions with full details. Values: true, false.

include[contents]boolean

Include content UUIDs. Values: true, false.

expand[contents]boolean

Expand localized content with full details. Values: true, false.

include[metadata]boolean

Include metadata UUIDs. Values: true, false.

expand[metadata]boolean

Expand metadata with full details. Values: true, false.

include[relations]boolean

Include relation UUIDs. Values: true, false.

expand[relations]boolean

Expand product relations with full details. Values: true, false.

expand[completeness]boolean

Expand completeness data with dimension scores and issues. Values: true, false.

curl -i -X GET \
  'https://docs.apiera.io/_mock/openapi/v1/products?uuids%5Beq%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&familyUuids%5Beq%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&skuUuids%5Beq%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&brandUuids%5Beq%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&assetUuids%5Beq%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&attributeUuids%5Beq%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&parentUuids%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&types%5Beq%5D=simple&type%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&isArchived%5Beq%5D=true&isRemoved%5Beq%5D=true&page=0&size=0&include%5BproductAssets%5D=true&expand%5BproductAssets%5D=true&include%5BproductAttributes%5D=true&expand%5BproductAttributes%5D=true&include%5BproductAttributeTerms%5D=true&expand%5BproductAttributeTerms%5D=true&include%5BproductCategories%5D=true&expand%5BproductCategories%5D=true&include%5BproductTags%5D=true&expand%5BproductTags%5D=true&include%5Bcontents%5D=true&expand%5Bcontents%5D=true&include%5Bmetadata%5D=true&expand%5Bmetadata%5D=true&include%5Brelations%5D=true&expand%5Brelations%5D=true&expand%5Bcompleteness%5D=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successfully retrieved paginated list of products.

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

Unique identifier for this product.

items[].​familyUuidstring or null(uuid)

Identifier of the family defining structure and requirements for this product.

items[].​skuUuidstring or null(uuid)

Identifier of the SKU providing inventory and dimensional data.

items[].​parentUuidstring or null(uuid)

Identifier of the parent product for variant relationships.

items[].​brandUuidstring or null(uuid)

Identifier of the brand associated with this product.

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

Timestamp when this product was created.

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

Timestamp when this product was last modified.

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

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

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

Timestamp when this product was archived. Null if not archived.

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

Current lifecycle status of this product.

Enum"draft""published""unpublished""archived""removed"
items[].​typestringrequired

Product type defining variant behavior.

Enum"simple""variantParent""variant"
items[].​codestringrequired

Unique code identifier for this product.

items[].​overallScoreinteger(int32)required

Completeness score from 0-100 indicating how complete this product is.

items[].​canPublishbooleanrequired

Whether this product meets all required criteria for publishing.

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

Collection of product-asset junction UUIDs. Populated when include[productAssets]=true.

items[].​productAssetsArray of objects or null(ProductAssetResponse)

Collection of product-asset junctions. Populated when expand[productAssets]=true.

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

Collection of product-attribute junction UUIDs. Populated when include[productAttributes]=true.

items[].​productAttributesArray of objects or null(ProductAttributeResponse)

Collection of product-attribute junctions. Populated when expand[productAttributes]=true.

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

Collection of product-term junction UUIDs. Populated when include[productAttributeTerms]=true.

items[].​productAttributeTermsArray of objects or null(ProductTermResponse)

Collection of product-term junctions. Populated when expand[productAttributeTerms]=true.

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

Collection of product-category junction UUIDs. Populated when include[productCategories]=true.

items[].​productCategoriesArray of objects or null(ProductCategoryResponse)

Collection of product-category junctions. Populated when expand[productCategories]=true.

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

Collection of product-tag junction UUIDs. Populated when include[productTags]=true.

items[].​productTagsArray of objects or null(ProductTagResponse)

Collection of product-tag junctions. Populated when expand[productTags]=true.

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

Collection of content UUIDs for this product.

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

Collection of localized content for this product.

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

Collection of metadata UUIDs for this product.

items[].​metadataArray of objects or null(ProductMetadataResponse)

Collection of custom metadata entries for this product.

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

Collection of relation UUIDs for this product.

items[].​relationsArray of objects or null(ProductRelationResponse)

Collection of related products.

items[].​completenessobject or null(ProductCompletenessResponse)

Completeness evaluation data for a product.

paginationobject(PaginationResult)required
pagination.​pageinteger(int32)required
pagination.​sizeinteger(int32)required
pagination.​totalItemsinteger(int32)required
pagination.​totalPagesinteger(int32)required
Response
application/json
{
  "uuid": "789e0123-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "status": "published",
  "type": "simple",
  "code": "TSHIRT-001",
  "overallScore": 75,
  "canPublish": true
}

Create product

Request

Creates a new product. Associations must be added separately after creation.

Security
Bearer
Bodyapplication/jsonrequired
familyUuidstring or null(uuid)

Optional family UUID defining structure and requirements.

skuUuidstring or null(uuid)

Optional SKU UUID for inventory and dimensional data.

parentUuidstring or null(uuid)

Optional parent product UUID for variant relationships.

brandUuidstring or null(uuid)

Optional brand UUID for brand association.

typestringrequired

Product type defining variant behavior.

Enum"simple""variantParent""variant"
codestring[ 3 .. 100 ] charactersrequired

Unique code identifier for the product.

curl -i -X POST \
  https://docs.apiera.io/_mock/openapi/v1/products \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "familyUuid": "0738e3a0-a16e-4b1d-8a18-44d0e84defd1",
    "skuUuid": "d10caf37-754b-44ef-9b00-f4b72b13bb41",
    "parentUuid": "a234027b-494b-4285-a8ce-894cd0943051",
    "brandUuid": "b53b8ac7-0b29-4fc4-9034-60a12921bb3d",
    "type": "simple",
    "code": "string"
  }'

Responses

Product created successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this product.

familyUuidstring or null(uuid)

Identifier of the family defining structure and requirements for this product.

skuUuidstring or null(uuid)

Identifier of the SKU providing inventory and dimensional data.

parentUuidstring or null(uuid)

Identifier of the parent product for variant relationships.

brandUuidstring or null(uuid)

Identifier of the brand associated with this product.

createdAtstring(date-time)required

Timestamp when this product was created.

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

Timestamp when this product was last modified.

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

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

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

Timestamp when this product was archived. Null if not archived.

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

Current lifecycle status of this product.

Enum"draft""published""unpublished""archived""removed"
typestringrequired

Product type defining variant behavior.

Enum"simple""variantParent""variant"
codestringrequired

Unique code identifier for this product.

Response
application/json
{
  "uuid": "789e0123-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "status": "draft",
  "type": "simple",
  "code": "NEW-TSHIRT-001"
}

Get product

Request

Retrieves complete details for a single product with optional hydration.

Security
Bearer
Path
productUuidstring(uuid)required

Unique identifier of the product.

Query
include[productAssets]boolean

Include product asset junction UUIDs. Values: true, false.

expand[productAssets]boolean

Expand product asset junctions with full details. Values: true, false.

include[productAttributes]boolean

Include product attribute junction UUIDs. Values: true, false.

expand[productAttributes]boolean

Expand product attribute junctions with full details. Values: true, false.

include[productAttributeTerms]boolean

Include product attribute term junction UUIDs. Values: true, false.

expand[productAttributeTerms]boolean

Expand product attribute term junctions with full details. Values: true, false.

include[productCategories]boolean

Include product category junction UUIDs. Values: true, false.

expand[productCategories]boolean

Expand product category junctions with full details. Values: true, false.

include[productTags]boolean

Include product tag junction UUIDs. Values: true, false.

expand[productTags]boolean

Expand product tag junctions with full details. Values: true, false.

include[contents]boolean

Include content UUIDs. Values: true, false.

expand[contents]boolean

Expand localized content with full details. Values: true, false.

include[metadata]boolean

Include metadata UUIDs. Values: true, false.

expand[metadata]boolean

Expand metadata with full details. Values: true, false.

include[relations]boolean

Include relation UUIDs. Values: true, false.

expand[relations]boolean

Expand product relations with full details. Values: true, false.

expand[completeness]boolean

Expand completeness data with dimension scores and issues. Values: true, false.

curl -i -X GET \
  'https://docs.apiera.io/_mock/openapi/v1/products/{productUuid}?include%5BproductAssets%5D=true&expand%5BproductAssets%5D=true&include%5BproductAttributes%5D=true&expand%5BproductAttributes%5D=true&include%5BproductAttributeTerms%5D=true&expand%5BproductAttributeTerms%5D=true&include%5BproductCategories%5D=true&expand%5BproductCategories%5D=true&include%5BproductTags%5D=true&expand%5BproductTags%5D=true&include%5Bcontents%5D=true&expand%5Bcontents%5D=true&include%5Bmetadata%5D=true&expand%5Bmetadata%5D=true&include%5Brelations%5D=true&expand%5Brelations%5D=true&expand%5Bcompleteness%5D=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successfully retrieved product.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this product.

familyUuidstring or null(uuid)

Identifier of the family defining structure and requirements for this product.

skuUuidstring or null(uuid)

Identifier of the SKU providing inventory and dimensional data.

parentUuidstring or null(uuid)

Identifier of the parent product for variant relationships.

brandUuidstring or null(uuid)

Identifier of the brand associated with this product.

createdAtstring(date-time)required

Timestamp when this product was created.

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

Timestamp when this product was last modified.

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

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

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

Timestamp when this product was archived. Null if not archived.

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

Current lifecycle status of this product.

Enum"draft""published""unpublished""archived""removed"
typestringrequired

Product type defining variant behavior.

Enum"simple""variantParent""variant"
codestringrequired

Unique code identifier for this product.

overallScoreinteger(int32)required

Completeness score from 0-100 indicating how complete this product is.

canPublishbooleanrequired

Whether this product meets all required criteria for publishing.

productAssetUuidsArray of strings or null(uuid)

Collection of product-asset junction UUIDs. Populated when include[productAssets]=true.

productAssetsArray of objects or null(ProductAssetResponse)

Collection of product-asset junctions. Populated when expand[productAssets]=true.

productAttributeUuidsArray of strings or null(uuid)

Collection of product-attribute junction UUIDs. Populated when include[productAttributes]=true.

productAttributesArray of objects or null(ProductAttributeResponse)

Collection of product-attribute junctions. Populated when expand[productAttributes]=true.

productAttributeTermUuidsArray of strings or null(uuid)

Collection of product-term junction UUIDs. Populated when include[productAttributeTerms]=true.

productAttributeTermsArray of objects or null(ProductTermResponse)

Collection of product-term junctions. Populated when expand[productAttributeTerms]=true.

productCategoryUuidsArray of strings or null(uuid)

Collection of product-category junction UUIDs. Populated when include[productCategories]=true.

productCategoriesArray of objects or null(ProductCategoryResponse)

Collection of product-category junctions. Populated when expand[productCategories]=true.

productTagUuidsArray of strings or null(uuid)

Collection of product-tag junction UUIDs. Populated when include[productTags]=true.

productTagsArray of objects or null(ProductTagResponse)

Collection of product-tag junctions. Populated when expand[productTags]=true.

contentUuidsArray of strings or null(uuid)

Collection of content UUIDs for this product.

contentsArray of objects or null(ProductContentResponse)

Collection of localized content for this product.

metadataUuidsArray of strings or null(uuid)

Collection of metadata UUIDs for this product.

metadataArray of objects or null(ProductMetadataResponse)

Collection of custom metadata entries for this product.

relationUuidsArray of strings or null(uuid)

Collection of relation UUIDs for this product.

relationsArray of objects or null(ProductRelationResponse)

Collection of related products.

completenessobject or null(ProductCompletenessResponse)

Completeness evaluation data for a product.

Response
application/json
{
  "uuid": "789e0123-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "status": "published",
  "type": "simple",
  "code": "TSHIRT-001",
  "overallScore": 75,
  "canPublish": true
}

Update product

Request

Updates an existing product. Only provided fields are updated.

Security
Bearer
Path
productUuidstring(uuid)required

Unique identifier of the product.

Bodyapplication/jsonrequired
familyUuidstring or null(uuid)

Updated family UUID. Set to null to remove family association.

skuUuidstring or null(uuid)

Updated SKU UUID. Set to null to remove SKU association.

brandUuidstring or null(uuid)

Updated brand UUID. Set to null to remove brand association.

codestring or null[ 3 .. 100 ] characters

Updated unique code identifier.

curl -i -X PATCH \
  'https://docs.apiera.io/_mock/openapi/v1/products/{productUuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "familyUuid": "0738e3a0-a16e-4b1d-8a18-44d0e84defd1",
    "skuUuid": "d10caf37-754b-44ef-9b00-f4b72b13bb41",
    "brandUuid": "b53b8ac7-0b29-4fc4-9034-60a12921bb3d",
    "code": "string"
  }'

Responses

Product updated successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this product.

familyUuidstring or null(uuid)

Identifier of the family defining structure and requirements for this product.

skuUuidstring or null(uuid)

Identifier of the SKU providing inventory and dimensional data.

parentUuidstring or null(uuid)

Identifier of the parent product for variant relationships.

brandUuidstring or null(uuid)

Identifier of the brand associated with this product.

createdAtstring(date-time)required

Timestamp when this product was created.

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

Timestamp when this product was last modified.

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

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

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

Timestamp when this product was archived. Null if not archived.

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

Current lifecycle status of this product.

Enum"draft""published""unpublished""archived""removed"
typestringrequired

Product type defining variant behavior.

Enum"simple""variantParent""variant"
codestringrequired

Unique code identifier for this product.

Response
application/json
{
  "uuid": "789e0123-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "status": "published",
  "type": "simple",
  "code": "UPDATED-PROD-001"
}

Delete product

Request

Permanently deletes a product and all associations. Cannot be undone.

Security
Bearer
Path
productUuidstring(uuid)required

Unique identifier of the product.

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

Responses

Product deleted successfully.

Response
No content

Bulk create products

Request

Creates multiple products in a single atomic operation.

Security
Bearer
Bodyapplication/jsonrequiredArray [
familyUuidstring or null(uuid)

Optional family UUID defining structure and requirements.

skuUuidstring or null(uuid)

Optional SKU UUID for inventory and dimensional data.

parentUuidstring or null(uuid)

Optional parent product UUID for variant relationships.

brandUuidstring or null(uuid)

Optional brand UUID for brand association.

typestringrequired

Product type defining variant behavior.

Enum"simple""variantParent""variant"
codestring[ 3 .. 100 ] charactersrequired

Unique code identifier for the product.

]
curl -i -X POST \
  https://docs.apiera.io/_mock/openapi/v1/products/bulk \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "familyUuid": "0738e3a0-a16e-4b1d-8a18-44d0e84defd1",
      "skuUuid": "d10caf37-754b-44ef-9b00-f4b72b13bb41",
      "parentUuid": "a234027b-494b-4285-a8ce-894cd0943051",
      "brandUuid": "b53b8ac7-0b29-4fc4-9034-60a12921bb3d",
      "type": "simple",
      "code": "string"
    }
  ]'

Responses

Products created successfully.

Bodyapplication/jsonArray [
uuidstring(uuid)required

Unique identifier for this product.

familyUuidstring or null(uuid)

Identifier of the family defining structure and requirements for this product.

skuUuidstring or null(uuid)

Identifier of the SKU providing inventory and dimensional data.

parentUuidstring or null(uuid)

Identifier of the parent product for variant relationships.

brandUuidstring or null(uuid)

Identifier of the brand associated with this product.

createdAtstring(date-time)required

Timestamp when this product was created.

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

Timestamp when this product was last modified.

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

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

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

Timestamp when this product was archived. Null if not archived.

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

Current lifecycle status of this product.

Enum"draft""published""unpublished""archived""removed"
typestringrequired

Product type defining variant behavior.

Enum"simple""variantParent""variant"
codestringrequired

Unique code identifier for this product.

]
Response
application/json
[
  {
    "uuid": "789e0123-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "status": "draft",
    "type": "simple",
    "code": "PROD-A-001"
  },
  {
    "uuid": "789e0123-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "status": "draft",
    "type": "simple",
    "code": "PROD-B-001"
  },
  {
    "uuid": "789e0123-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "status": "draft",
    "type": "variantParent",
    "code": "PROD-CONFIG-001"
  }
]

Bulk update products

Request

Updates multiple products in a single operation.

Security
Bearer
Bodyapplication/jsonrequiredArray [
uuidstring(uuid)required

Identifier of the product to update.

familyUuidstring or null(uuid)

Updated family UUID.

skuUuidstring or null(uuid)

Updated SKU UUID.

brandUuidstring or null(uuid)

Updated brand UUID.

codestring or null[ 3 .. 100 ] characters

Updated unique code identifier.

]
curl -i -X PATCH \
  https://docs.apiera.io/_mock/openapi/v1/products/bulk \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "familyUuid": "0738e3a0-a16e-4b1d-8a18-44d0e84defd1",
      "skuUuid": "d10caf37-754b-44ef-9b00-f4b72b13bb41",
      "brandUuid": "b53b8ac7-0b29-4fc4-9034-60a12921bb3d",
      "code": "string"
    }
  ]'

Responses

Products updated successfully.

Bodyapplication/jsonArray [
uuidstring(uuid)required

Unique identifier for this product.

familyUuidstring or null(uuid)

Identifier of the family defining structure and requirements for this product.

skuUuidstring or null(uuid)

Identifier of the SKU providing inventory and dimensional data.

parentUuidstring or null(uuid)

Identifier of the parent product for variant relationships.

brandUuidstring or null(uuid)

Identifier of the brand associated with this product.

createdAtstring(date-time)required

Timestamp when this product was created.

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

Timestamp when this product was last modified.

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

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

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

Timestamp when this product was archived. Null if not archived.

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

Current lifecycle status of this product.

Enum"draft""published""unpublished""archived""removed"
typestringrequired

Product type defining variant behavior.

Enum"simple""variantParent""variant"
codestringrequired

Unique code identifier for this product.

]
Response
application/json
[
  {
    "uuid": "789e0123-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "status": "published",
    "type": "simple",
    "code": "PROD-A-UPDATED"
  },
  {
    "uuid": "789e0123-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "status": "published",
    "type": "simple",
    "code": "PROD-B-UPDATED"
  }
]

Transition product lifecycle

Request

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

Security
Bearer
Path
productUuidstring(uuid)required

Unique identifier of the product.

Bodyapplication/jsonrequired
transitionstringrequired

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

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

Responses

Product transitioned successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this product.

familyUuidstring or null(uuid)

Identifier of the family defining structure and requirements for this product.

skuUuidstring or null(uuid)

Identifier of the SKU providing inventory and dimensional data.

parentUuidstring or null(uuid)

Identifier of the parent product for variant relationships.

brandUuidstring or null(uuid)

Identifier of the brand associated with this product.

createdAtstring(date-time)required

Timestamp when this product was created.

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

Timestamp when this product was last modified.

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

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

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

Timestamp when this product was archived. Null if not archived.

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

Current lifecycle status of this product.

Enum"draft""published""unpublished""archived""removed"
typestringrequired

Product type defining variant behavior.

Enum"simple""variantParent""variant"
codestringrequired

Unique code identifier for this product.

Response
application/json
{
  "uuid": "789e0123-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "status": "published",
  "type": "simple",
  "code": "PUBLISHED-PROD-001"
}

Bulk transition product lifecycle

Request

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

Security
Bearer
Bodyapplication/jsonrequired
transitionstringrequired

Lifecycle transition to apply to all specified products.

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

List of product identifiers to transition.

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

Responses

Products transitioned successfully.

Bodyapplication/jsonArray [
uuidstring(uuid)required

Unique identifier for this product.

familyUuidstring or null(uuid)

Identifier of the family defining structure and requirements for this product.

skuUuidstring or null(uuid)

Identifier of the SKU providing inventory and dimensional data.

parentUuidstring or null(uuid)

Identifier of the parent product for variant relationships.

brandUuidstring or null(uuid)

Identifier of the brand associated with this product.

createdAtstring(date-time)required

Timestamp when this product was created.

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

Timestamp when this product was last modified.

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

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

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

Timestamp when this product was archived. Null if not archived.

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

Current lifecycle status of this product.

Enum"draft""published""unpublished""archived""removed"
typestringrequired

Product type defining variant behavior.

Enum"simple""variantParent""variant"
codestringrequired

Unique code identifier for this product.

]
Response
application/json
[
  {
    "uuid": "789e0123-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "status": "published",
    "type": "simple",
    "code": "PROD-A-001"
  },
  {
    "uuid": "789e0123-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "status": "published",
    "type": "simple",
    "code": "PROD-B-001"
  }
]

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