Product API (1.0.0)

Download OpenAPI specification:

Products, variants, families, and catalog models.

Product Families

List product families

Get a paginated list of product families with optional filters

Authorizations:

BearerAuth

query Parameters

page	integer >= 1 Default: 1 Page number
page_size	integer [ 1 .. 100 ] Default: 10 Items per page
code	string Filter by code (exact match)
name	string Filter by name (partial match)
status	string Enum: "enabled" "disabled" Filter by status
search	string Search across code and name

Responses

Response samples

200
400
401
500

Content type

application/json

{"data": {"items": [{"attribute_count": 15,
"code": "APPAREL",
"created_at": "2024-01-10T09:00:00Z",
"created_by": {"id": "string",
"name": "string",
"type": "string"
},
"id": "5",
"modified_at": "2024-01-15T11:30:00Z",
"modified_by": {"id": "string",
"name": "string",
"type": "string"
},
"name": "Apparel",
"product_count": 156,
"status": "active"
}
],
"pagination": {"has_next": true,
"page": 0,
"page_size": 0,
"total_items": 0,
"total_pages": 0
}
},
"success": true
}

Create a new product family

Create a new product family with the provided details

Authorizations:

BearerAuth

Request Body schema: application/json
required

Product family details

code required	string
description	string
name required	string

Responses

Request samples

Payload

Content type

application/json

{"code": "APPAREL",
"description": "Clothing and fashion products including shirts, pants, dresses",
"name": "Apparel"
}

Response samples

201
400
401
409
500

Content type

application/json

{"data": {"attribute_count": 15,
"code": "APPAREL",
"created_at": "2024-01-10T09:00:00Z",
"created_by": {"id": "string",
"name": "string",
"type": "string"
},
"description": "Clothing and fashion products",
"display_attributes": {"image": {"code": "name",
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Product Name"
},
"name": {"code": "name",
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Product Name"
}
},
"id": "5",
"modified_at": "2024-01-15T11:30:00Z",
"modified_by": {"id": "string",
"name": "string",
"type": "string"
},
"name": "Apparel",
"product_count": 156,
"status": "active"
},
"success": true
}

Get product family details

Get details of a specific product family by ID

Authorizations:

BearerAuth

path Parameters

id

required

string

Product Family ID

Responses

Response samples

200
400
401
404
500

Content type

application/json

{"data": {"attribute_count": 15,
"code": "APPAREL",
"created_at": "2024-01-10T09:00:00Z",
"created_by": {"id": "string",
"name": "string",
"type": "string"
},
"description": "Clothing and fashion products",
"display_attributes": {"image": {"code": "name",
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Product Name"
},
"name": {"code": "name",
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Product Name"
}
},
"id": "5",
"modified_at": "2024-01-15T11:30:00Z",
"modified_by": {"id": "string",
"name": "string",
"type": "string"
},
"name": "Apparel",
"product_count": 156,
"status": "active"
},
"success": true
}

Delete a product family

Delete a product family by ID

Authorizations:

BearerAuth

path Parameters

id

required

string

Product Family ID

Responses

Response samples

401
404
500

Content type

application/json

{"errors": [{"code": "string",
"field": "string",
"message": "string"
}
],
"message": "string",
"success": true
}

Update a product family

Update an existing product family's details

Authorizations:

BearerAuth

path Parameters

id

required

string

Product Family ID

Request Body schema: application/json
required

Updated product family details

description	string
	object (UpdateDisplayAttributes)
name	string

Responses

Request samples

Payload

Content type

application/json

{"description": "Updated description for clothing category",
"display_attributes": {"image_attribute_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"name_attribute_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
},
"name": "Clothing & Accessories"
}

Response samples

200
400
401
404
500

Content type

application/json

{"data": {"attribute_count": 15,
"code": "APPAREL",
"created_at": "2024-01-10T09:00:00Z",
"created_by": {"id": "string",
"name": "string",
"type": "string"
},
"description": "Clothing and fashion products",
"display_attributes": {"image": {"code": "name",
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Product Name"
},
"name": {"code": "name",
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Product Name"
}
},
"id": "5",
"modified_at": "2024-01-15T11:30:00Z",
"modified_by": {"id": "string",
"name": "string",
"type": "string"
},
"name": "Apparel",
"product_count": 156,
"status": "active"
},
"success": true
}

Change product family status

Change the status of a product family (active/inactive)

Authorizations:

BearerAuth

path Parameters

id

required

string

Product Family ID

Request Body schema: application/json
required

Status change request

status

required

string

Enum: "active" "inactive"

Responses

Request samples

Payload

Content type

application/json

{"status": "inactive"
}

Response samples

200
400
401
404
500

Content type

application/json

{"data": {"attribute_count": 15,
"code": "APPAREL",
"created_at": "2024-01-10T09:00:00Z",
"created_by": {"id": "string",
"name": "string",
"type": "string"
},
"description": "Clothing and fashion products",
"display_attributes": {"image": {"code": "name",
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Product Name"
},
"name": {"code": "name",
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Product Name"
}
},
"id": "5",
"modified_at": "2024-01-15T11:30:00Z",
"modified_by": {"id": "string",
"name": "string",
"type": "string"
},
"name": "Apparel",
"product_count": 156,
"status": "active"
},
"success": true
}

Product Family Translations

Get all translations for a product family

Retrieve all localized translations for a specific product family

Authorizations:

BearerAuth

path Parameters

id

required

string

Example: 1

Product Family ID

Responses

Response samples

200
400
404
500

Content type

application/json

{"data": {"items": [{"created_at": "2026-01-18T10:30:00Z",
"locale": "en_US",
"modified_at": "2026-01-18T15:45:00Z",
"name": "Apparel"
}
]
},
"success": true
}

Update product family translations

PATCH: Update multiple translations for a product family

Authorizations:

BearerAuth

path Parameters

id

required

string

Example: 1

Product Family ID

Request Body schema: application/json
required

Translations data

required

Array of objects (ProductFamilyTranslationInput)

Responses

Request samples

Payload

Content type

application/json

{"translations": [{"locale": "en_US",
"name": "Apparel"
}
]
}

Response samples

200
400
404
500

Content type

application/json

{"data": {"items": [{"created_at": "2026-01-18T10:30:00Z",
"locale": "en_US",
"modified_at": "2026-01-18T15:45:00Z",
"name": "Apparel"
}
]
},
"success": true
}

Product Family Attributes

List product family attributes

Get attributes for a product family

Authorizations:

BearerAuth

path Parameters

productFamilyId

required

string

Product Family ID

query Parameters

page	integer >= 1 Default: 1 Page number
page_size	integer [ 1 .. 100 ] Default: 20 Items per page
search	string Search by attribute name

Responses

Response samples

200
400
401
500

Content type

application/json

{"data": {"items": [{"attribute_code": "size",
"attribute_group": {"code": "GENERAL",
"id": "5",
"name": "General Information"
},
"attribute_id": "10",
"attribute_name": "Size",
"attribute_type": "select",
"channels": [{"code": "WEB",
"id": "1",
"name": "Web Store"
}
],
"created_at": "2024-01-15T10:00:00Z",
"created_by": {"id": "string",
"name": "string",
"type": "string"
},
"is_mandatory": true,
"is_overridable": true,
"is_unique": false,
"modified_at": "2024-01-20T15:30:00Z",
"modified_by": {"id": "string",
"name": "string",
"type": "string"
},
"value_per_channel": false,
"value_per_locale": true
}
],
"pagination": {"has_next": true,
"page": 0,
"page_size": 0,
"total_items": 0,
"total_pages": 0
}
},
"success": true
}

Create product family attributes

Bulk create attributes for a product family

Authorizations:

BearerAuth

path Parameters

productFamilyId

required

string

Product Family ID

Request Body schema: application/json
required

Attributes to create

required

Array of objects (CreateProductFamilyAttributeRequest)

Responses

Request samples

Payload

Content type

application/json

{"attributes": [{"attribute_id": "15",
"channel_ids": ["1",
"2",
"5"
],
"is_mandatory": false,
"is_overridable": true
}
]
}

Response samples

201
400
401
404
500

Content type

application/json

{"data": null,
"success": true
}

Partially update product family attributes

Partially update attributes for a product family

Authorizations:

BearerAuth

path Parameters

productFamilyId

required

string

Product Family ID

Request Body schema: application/json
required

Attributes to partially update

required

Array of objects (CreateProductFamilyAttributeRequest)

Responses

Request samples

Payload

Content type

application/json

{"attributes": [{"attribute_id": "15",
"channel_ids": ["1",
"2",
"5"
],
"is_mandatory": false,
"is_overridable": true
}
]
}

Response samples

200
400
401
404
500

Content type

application/json

{"data": null,
"success": true
}

Delete a product family attribute

Remove a specific attribute from a product family

Authorizations:

BearerAuth

path Parameters

productFamilyId required	string Product Family ID
attributeId required	string Attribute ID

Responses

Response samples

401
404
500

Content type

application/json

{"errors": [{"code": "string",
"field": "string",
"message": "string"
}
],
"message": "string",
"success": true
}

Variant Families

List variant families

Get all variant families for a specific product family

Authorizations:

BearerAuth

path Parameters

productFamilyId

required

string

Product Family ID

Responses

Response samples

200
401
500

Content type

application/json

{"data": {"items": [{"axes": [{"attribute": {"code": "string",
"id": "string",
"name": "string"
},
"id": "string",
"level": 0,
"position": 0
}
],
"code": "string",
"created_at": "string",
"created_by": {"id": "string",
"name": "string",
"type": "string"
},
"id": "string",
"modified_at": "string",
"modified_by": {"id": "string",
"name": "string",
"type": "string"
},
"name": "string",
"product_family_id": "string"
}
]
},
"success": true
}

Create a variant family

Create a new variant family for a product family

Authorizations:

BearerAuth

path Parameters

productFamilyId

required

string

Product Family ID

Request Body schema: application/json
required

Variant family data

	Array of objects (AxisInput)
code required	string <= 100 characters
name required	string [ 1 .. 255 ] characters

Responses

Request samples

Payload

Content type

application/json

{"axes": [{"attribute_id": "019cfa6c-1ec5-7f1f-95dc-1fd025ff5c42",
"level": 1,
"position": 1
}
],
"code": "string",
"name": "string"
}

Response samples

201
400
401
409
500

Content type

application/json

{"data": {"axes": [{"attribute": {"code": "string",
"id": "string",
"name": "string"
},
"id": "string",
"level": 0,
"position": 0
}
],
"code": "string",
"created_at": "string",
"created_by": {"id": "string",
"name": "string",
"type": "string"
},
"id": "string",
"modified_at": "string",
"modified_by": {"id": "string",
"name": "string",
"type": "string"
},
"name": "string",
"product_family_id": "string"
},
"success": true
}

Get variant family by ID

Get detailed information about a specific variant family

Authorizations:

BearerAuth

path Parameters

productFamilyId required	string Product Family ID
variantFamilyId required	string Variant Family ID

Responses

Response samples

200
401
404
500

Content type

application/json

{"data": {"axes": [{"attribute": {"code": "string",
"id": "string",
"name": "string"
},
"id": "string",
"level": 0,
"position": 0
}
],
"code": "string",
"created_at": "string",
"created_by": {"id": "string",
"name": "string",
"type": "string"
},
"id": "string",
"modified_at": "string",
"modified_by": {"id": "string",
"name": "string",
"type": "string"
},
"name": "string",
"product_family_id": "string"
},
"success": true
}

Delete a variant family

Soft delete a variant family by ID

Authorizations:

BearerAuth

path Parameters

productFamilyId required	string Product Family ID
variantFamilyId required	string Variant Family ID

Responses

Response samples

401
404
500

Content type

application/json

{"errors": [{"code": "string",
"field": "string",
"message": "string"
}
],
"message": "string",
"success": true
}

Variant Family Translations

Get all translations for a variant family

Retrieve all localized translations for a specific variant family

Authorizations:

BearerAuth

path Parameters

productFamilyId required	string Product Family ID
variantFamilyId required	string Variant Family ID

Responses

Response samples

200
401
404
500

Content type

application/json

{"data": {"items": [{"created_at": "string",
"locale": "string",
"modified_at": "string",
"name": "string"
}
]
},
"success": true
}

Update variant family translations

PATCH: Create or update multiple translations for a variant family

Authorizations:

BearerAuth

path Parameters

productFamilyId required	string Product Family ID
variantFamilyId required	string Variant Family ID

Request Body schema: application/json
required

Translations data

required

Array of objects (VariantFamilyTranslationInput)

Responses

Request samples

Payload

Content type

application/json

{"translations": [{"locale": "string",
"name": "string"
}
]
}

Response samples

200
400
401
404
500

Content type

application/json

{"data": {"items": [{"created_at": "string",
"locale": "string",
"modified_at": "string",
"name": "string"
}
]
},
"success": true
}

Products

List products

Get a paginated list of products with optional filters

Authorizations:

BearerAuth

query Parameters

page	integer >= 1 Default: 1 Page number
page_size	integer [ 1 .. 100 ] Default: 10 Items per page
code	string Filter by code (partial match)
name	string Filter by name (partial match)
status	string Enum: "enabled" "disabled" Filter by status
product_family_id	string Filter by product family ID
search	string Search across code and name

Responses

Response samples

200
400
401
500

Content type

application/json

{"data": {"items": [{"code": "TSHIRT-BLU-001",
"completeness": 85,
"created_at": "2024-01-15T10:30:00Z",
"created_by": {"id": "string",
"name": "string",
"type": "string"
},
"id": "1001",
"media_id": "550e8400-e29b-41d4-a716-446655440000",
"modified_at": "2024-01-20T14:45:00Z",
"modified_by": {"id": "string",
"name": "string",
"type": "string"
},
"name": "Blue Cotton T-Shirt",
"product_family": {"code": "APPAREL",
"id": "5",
"name": "Apparel"
},
"product_type": "configurable",
"status": "enabled",
"thumbnail": "https://cdn.catazenta.com/images/tshirt-blue.jpg",
"variant_count": 5
}
],
"pagination": {"has_next": true,
"page": 0,
"page_size": 0,
"total_items": 0,
"total_pages": 0
}
},
"success": true
}

Create a new product

Create a new product with the provided details

Authorizations:

BearerAuth

Request Body schema: application/json
required

Product details

category_ids	Array of strings
code required	string <= 128 characters
product_family_id required	string
product_type	string <= 50 characters
variant_family_id	string

Responses

Request samples

Payload

Content type

application/json

{"category_ids": ["10",
"25",
"42"
],
"code": "TSHIRT-BLU-001",
"product_family_id": "5",
"product_type": "configurable",
"variant_family_id": "7"
}

Response samples

201
400
401
409
500

Content type

application/json

{"data": {"categories": [{"code": "mens-clothing",
"id": "10",
"name": "Men's Clothing"
}
],
"code": "TSHIRT-BLU-001",
"created_at": "2024-01-15T10:30:00Z",
"created_by": {"id": "string",
"name": "string",
"type": "string"
},
"display_attributes": {"image": {"code": "name",
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Product Name"
},
"name": {"code": "name",
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Product Name"
}
},
"id": "1001",
"modified_at": "2024-01-20T14:45:00Z",
"modified_by": {"id": "string",
"name": "string",
"type": "string"
},
"product_family": {"code": "APPAREL",
"id": "5",
"name": "Apparel"
},
"product_type": "configurable",
"status": "enabled",
"variant_family": {"code": "COLOR-SIZE",
"id": "7",
"name": "Color & Size"
}
},
"success": true
}

Get product by ID

Get detailed information about a specific product

Authorizations:

BearerAuth

path Parameters

id

required

string

Product ID

Responses

Response samples

200
400
401
404
500

Content type

application/json

{"data": {"categories": [{"code": "mens-clothing",
"id": "10",
"name": "Men's Clothing"
}
],
"code": "TSHIRT-BLU-001",
"created_at": "2024-01-15T10:30:00Z",
"created_by": {"id": "string",
"name": "string",
"type": "string"
},
"display_attributes": {"image": {"code": "name",
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Product Name"
},
"name": {"code": "name",
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Product Name"
}
},
"id": "1001",
"modified_at": "2024-01-20T14:45:00Z",
"modified_by": {"id": "string",
"name": "string",
"type": "string"
},
"product_family": {"code": "APPAREL",
"id": "5",
"name": "Apparel"
},
"product_type": "configurable",
"status": "enabled",
"variant_family": {"code": "COLOR-SIZE",
"id": "7",
"name": "Color & Size"
}
},
"success": true
}

Delete a product

Delete a product by ID

Authorizations:

BearerAuth

path Parameters

id

required

string

Product ID

Responses

Response samples

401
404
500

Content type

application/json

{"errors": [{"code": "string",
"field": "string",
"message": "string"
}
],
"message": "string",
"success": true
}

Update a product

Update an existing product's details

Authorizations:

BearerAuth

path Parameters

id

required

string

Product ID

Request Body schema: application/json
required

Updated product details

category_ids

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"category_ids": ["10",
"25"
]
}

Response samples

200
400
401
404
500

Content type

application/json

{"data": {"categories": [{"code": "mens-clothing",
"id": "10",
"name": "Men's Clothing"
}
],
"code": "TSHIRT-BLU-001",
"created_at": "2024-01-15T10:30:00Z",
"created_by": {"id": "string",
"name": "string",
"type": "string"
},
"display_attributes": {"image": {"code": "name",
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Product Name"
},
"name": {"code": "name",
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Product Name"
}
},
"id": "1001",
"modified_at": "2024-01-20T14:45:00Z",
"modified_by": {"id": "string",
"name": "string",
"type": "string"
},
"product_family": {"code": "APPAREL",
"id": "5",
"name": "Apparel"
},
"product_type": "configurable",
"status": "enabled",
"variant_family": {"code": "COLOR-SIZE",
"id": "7",
"name": "Color & Size"
}
},
"success": true
}

Clone a product

Clone a product with a new code, copying product data except variants and variant attributes

Authorizations:

BearerAuth

path Parameters

id

required

string

Source Product ID

Request Body schema: application/json
required

Clone payload

code

required

string <= 128 characters

Responses

Request samples

Payload

Content type

application/json

{"code": "TSHIRT-BLU-001-COPY"
}

Response samples

Content type

application/json

{"data": {"categories": [{"code": "mens-clothing",
"id": "10",
"name": "Men's Clothing"
}
],
"code": "TSHIRT-BLU-001",
"created_at": "2024-01-15T10:30:00Z",
"created_by": {"id": "string",
"name": "string",
"type": "string"
},
"display_attributes": {"image": {"code": "name",
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Product Name"
},
"name": {"code": "name",
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Product Name"
}
},
"id": "1001",
"modified_at": "2024-01-20T14:45:00Z",
"modified_by": {"id": "string",
"name": "string",
"type": "string"
},
"product_family": {"code": "APPAREL",
"id": "5",
"name": "Apparel"
},
"product_type": "configurable",
"status": "enabled",
"variant_family": {"code": "COLOR-SIZE",
"id": "7",
"name": "Color & Size"
}
},
"success": true
}

Change product status

Change the status of a product (draft/in_review/approved/archived) with variant cascade

Authorizations:

BearerAuth

path Parameters

id

required

string

Product ID

Request Body schema: application/json
required

Status change request

status

required

string

Enum: "draft" "in_review" "approved" "archived"

Responses

Request samples

Payload

Content type

application/json

{"status": "approved"
}

Response samples

200
400
401
404
500

Content type

application/json

{"data": {"categories": [{"code": "mens-clothing",
"id": "10",
"name": "Men's Clothing"
}
],
"code": "TSHIRT-BLU-001",
"created_at": "2024-01-15T10:30:00Z",
"created_by": {"id": "string",
"name": "string",
"type": "string"
},
"display_attributes": {"image": {"code": "name",
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Product Name"
},
"name": {"code": "name",
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Product Name"
}
},
"id": "1001",
"modified_at": "2024-01-20T14:45:00Z",
"modified_by": {"id": "string",
"name": "string",
"type": "string"
},
"product_family": {"code": "APPAREL",
"id": "5",
"name": "Apparel"
},
"product_type": "configurable",
"status": "enabled",
"variant_family": {"code": "COLOR-SIZE",
"id": "7",
"name": "Color & Size"
}
},
"success": true
}

Product Revisions

List product revisions

Paginated version history for a product (newest first)

Authorizations:

BearerAuth

path Parameters

id

required

string

Product ID

query Parameters

page	integer >= 1 Default: 1 Page number
page_size	integer [ 1 .. 100 ] Default: 20 Items per page

Responses

Response samples

200
401
404

Content type

application/json

{"data": {"items": [{"change_source": "string",
"change_summary": [0
],
"created_at": "string",
"created_by": {"id": "string",
"name": "string",
"type": "string"
},
"id": "string",
"restored_from_revision_id": "string",
"revision_number": 0
}
],
"pagination": {"has_next": true,
"page": 0,
"page_size": 0,
"total_items": 0,
"total_pages": 0
}
},
"success": true
}

Get current product revision

Full snapshot for the product's latest revision via latest_revision_id pointer

Authorizations:

BearerAuth

path Parameters

id

required

string

Product ID

Responses

Response samples

200
404

Content type

application/json

{"data": {"change_source": "string",
"change_summary": [0
],
"created_at": "string",
"created_by": {"id": "string",
"name": "string",
"type": "string"
},
"id": "string",
"restored_from_revision_id": "string",
"revision_number": 0,
"snapshot": {"category_ids": ["string"
],
"product": {"code": "string",
"product_family_id": "string",
"product_type": "string",
"product_variant_family_id": "string",
"status": "string"
},
"product_attributes": [{"attribute_id": "string",
"uniqueness_hash": 0,
"value": [0
]
}
],
"variants": [{"attributes": [{"attribute_id": "string",
"uniqueness_hash": 0,
"value": [0
]
}
],
"code": "string",
"id": "string",
"is_default": true,
"status": "string"
}
],
"version": 0
},
"snapshot_schema_version": 0
},
"success": true
}

Get product revision

Full snapshot for a single revision

Authorizations:

BearerAuth

path Parameters

id required	string Product ID
revisionId required	string Revision ID

Responses

Response samples

200
404

Content type

application/json

{"data": {"change_source": "string",
"change_summary": [0
],
"created_at": "string",
"created_by": {"id": "string",
"name": "string",
"type": "string"
},
"id": "string",
"restored_from_revision_id": "string",
"revision_number": 0,
"snapshot": {"category_ids": ["string"
],
"product": {"code": "string",
"product_family_id": "string",
"product_type": "string",
"product_variant_family_id": "string",
"status": "string"
},
"product_attributes": [{"attribute_id": "string",
"uniqueness_hash": 0,
"value": [0
]
}
],
"variants": [{"attributes": [{"attribute_id": "string",
"uniqueness_hash": 0,
"value": [0
]
}
],
"code": "string",
"id": "string",
"is_default": true,
"status": "string"
}
],
"version": 0
},
"snapshot_schema_version": 0
},
"success": true
}

Restore product revision

Restore catalog state from a revision; creates a new revision with change_source revert

Authorizations:

BearerAuth

path Parameters

id required	string Product ID
revisionId required	string Revision ID

Request Body schema: application/json

Optional optimistic lock and comment

comment	string
expected_revision	integer

Responses

Request samples

Payload

Content type

application/json

{"comment": "string",
"expected_revision": 0
}

Response samples

200
409

Content type

application/json

{"data": {"change_source": "string",
"change_summary": [0
],
"created_at": "string",
"created_by": {"id": "string",
"name": "string",
"type": "string"
},
"id": "string",
"restored_from_revision_id": "string",
"revision_number": 0,
"snapshot": {"category_ids": ["string"
],
"product": {"code": "string",
"product_family_id": "string",
"product_type": "string",
"product_variant_family_id": "string",
"status": "string"
},
"product_attributes": [{"attribute_id": "string",
"uniqueness_hash": 0,
"value": [0
]
}
],
"variants": [{"attributes": [{"attribute_id": "string",
"uniqueness_hash": 0,
"value": [0
]
}
],
"code": "string",
"id": "string",
"is_default": true,
"status": "string"
}
],
"version": 0
},
"snapshot_schema_version": 0
},
"success": true
}

Product Attributes

List product attributes

Get all attributes for a specific product with attribute metadata

Authorizations:

BearerAuth

path Parameters

productId

required

string

Product ID

query Parameters

page	integer >= 1 Default: 1 Page number
page_size	integer [ 1 .. 100 ] Default: 20 Items per page

Responses

Response samples

200
400
401
404
500

Content type

application/json

{"data": {"items": [{"attribute_code": "color",
"attribute_config": { },
"attribute_group": {"code": "GENERAL",
"id": "3",
"name": "General Information"
},
"attribute_id": "10",
"attribute_name": "Color",
"attribute_translations": { },
"attribute_type": "select",
"channel_settings": [{"channel_code": "amazon",
"enabled": true
}
],
"is_custom": false,
"is_mandatory": true,
"is_overridable": true,
"is_unique": false,
"is_variant_axis": true,
"modified_at": "2024-01-20T14:45:00Z",
"modified_by": {"id": "string",
"name": "string",
"type": "string"
},
"value_per_channel": false,
"value_per_locale": true,
"values": [{"channel": "$default",
"data": { },
"locale": "$default"
}
]
}
],
"pagination": {"has_next": true,
"page": 0,
"page_size": 0,
"total_items": 0,
"total_pages": 0
}
},
"success": true
}

Create or update product attributes

Bulk create or update attributes for a product. Each value uses the standardized payload: text/number/boolean: {"value": "some text"} | select: {"value": "option_code"}

Authorizations:

BearerAuth

path Parameters

productId

required

string

Product ID

Request Body schema: application/json
required

Product attributes

Array

attribute_id required	string
	Array of objects (ScopedValue)

Responses

Request samples

Payload

Content type

application/json

[{"attribute_id": "10",
"values": [{"channel": "$default",
"data": { },
"locale": "$default"
}
]
}
]

Response samples

201
400
401
404
500

Content type

application/json

{"data": null,
"success": true
}

Partially update product attributes

Update specific fields of product attributes without replacing entire attribute set. Each value uses the standardized payload: text/number/boolean: {"value": "some text"} | select: {"value": "option_code"}

Authorizations:

BearerAuth

path Parameters

productId

required

string

Product ID

Request Body schema: application/json
required

Product attributes to partially update

Array

attribute_id required	string
	Array of objects (ScopedValue)

Responses

Request samples

Payload

Content type

application/json

[{"attribute_id": "10",
"values": [{"channel": "$default",
"data": { },
"locale": "$default"
}
]
}
]

Response samples

200
400
401
404
500

Content type

application/json

{"data": null,
"success": true
}

Delete a product attribute

Delete a specific attribute from a product

Authorizations:

BearerAuth

path Parameters

productId required	string Product ID
id required	string Product Attribute ID

Responses

Response samples

401
404
500

Content type

application/json

{"errors": [{"code": "string",
"field": "string",
"message": "string"
}
],
"message": "string",
"success": true
}

Variants

List product variants

Get all variants for a specific product

Authorizations:

BearerAuth

path Parameters

productId

required

string

Product ID

Responses

Response samples

200
400
401
404
500

Content type

application/json

{"data": {"items": [{"axis_values": [{"axis_code": "color",
"option_code": "blue",
"option_label": "Blue"
}
],
"created_at": "2024-01-15T11:00:00Z",
"created_by": {"id": "string",
"name": "string",
"type": "string"
},
"id": "3001",
"is_default": false,
"media_id": "550e8400-e29b-41d4-a716-446655440000",
"modified_at": "2024-01-20T16:30:00Z",
"modified_by": {"id": "string",
"name": "string",
"type": "string"
},
"name": "Blue T-Shirt S",
"sku": "TSHIRT-BLU-S",
"status": "enabled",
"thumbnail": "https://cdn.example.com/img.jpg"
}
],
"pagination": {"has_next": true,
"page": 0,
"page_size": 0,
"total_items": 0,
"total_pages": 0
}
},
"success": true
}

Create a new variant

Create a new variant for a product with attributes

Authorizations:

BearerAuth

path Parameters

productId

required

string

Product ID

Request Body schema: application/json
required

Variant details

required	Array of objects (AxisValueInput) non-empty
is_default	boolean
sku required	string <= 128 characters

Responses

Request samples

Payload

Content type

application/json

{"axis_values": [{"axis_code": "color",
"option_code": "blue"
}
],
"is_default": false,
"sku": "TSHIRT-BLU-S"
}

Response samples

201
400
401
404
500

Content type

application/json

{"data": {"axis_values": [{"axis_code": "color",
"option_code": "blue",
"option_label": "Blue"
}
],
"categories": [{"code": "mens-clothing",
"id": "10",
"name": "Men's Clothing"
}
],
"created_at": "2024-01-15T11:00:00Z",
"created_by": {"id": "string",
"name": "string",
"type": "string"
},
"display_attributes": {"image": {"code": "name",
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Product Name"
},
"name": {"code": "name",
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Product Name"
}
},
"id": "3001",
"is_default": false,
"modified_at": "2024-01-20T16:30:00Z",
"modified_by": {"id": "string",
"name": "string",
"type": "string"
},
"product": {"id": "1001",
"name": "Blue Cotton T-Shirt"
},
"product_family": {"code": "APPAREL",
"id": "5",
"name": "Apparel"
},
"sku": "TSHIRT-BLU-S",
"status": "enabled",
"variant_axes": [{"code": "color",
"level": 1,
"name": "Color",
"value": { }
}
]
},
"success": true
}

Get variant by ID

Get detailed information about a specific variant

Authorizations:

BearerAuth

path Parameters

productId required	string Product ID
id required	string Variant ID

Responses

Response samples

200
400
401
404
500

Content type

application/json

{"data": {"axis_values": [{"axis_code": "color",
"option_code": "blue",
"option_label": "Blue"
}
],
"categories": [{"code": "mens-clothing",
"id": "10",
"name": "Men's Clothing"
}
],
"created_at": "2024-01-15T11:00:00Z",
"created_by": {"id": "string",
"name": "string",
"type": "string"
},
"display_attributes": {"image": {"code": "name",
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Product Name"
},
"name": {"code": "name",
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Product Name"
}
},
"id": "3001",
"is_default": false,
"modified_at": "2024-01-20T16:30:00Z",
"modified_by": {"id": "string",
"name": "string",
"type": "string"
},
"product": {"id": "1001",
"name": "Blue Cotton T-Shirt"
},
"product_family": {"code": "APPAREL",
"id": "5",
"name": "Apparel"
},
"sku": "TSHIRT-BLU-S",
"status": "enabled",
"variant_axes": [{"code": "color",
"level": 1,
"name": "Color",
"value": { }
}
]
},
"success": true
}

Delete a variant

Delete a variant by ID

Authorizations:

BearerAuth

path Parameters

productId required	string Product ID
id required	string Variant ID

Responses

Response samples

401
404
500

Content type

application/json

{"errors": [{"code": "string",
"field": "string",
"message": "string"
}
],
"message": "string",
"success": true
}

Update a variant

Update an existing variant's details

Authorizations:

BearerAuth

path Parameters

productId required	string Product ID
id required	string Variant ID

Request Body schema: application/json
required

Updated variant details

is_default

boolean

Responses

Request samples

Payload

Content type

application/json

{"is_default": true
}

Response samples

200
400
401
404
500

Content type

application/json

{"data": {"axis_values": [{"axis_code": "color",
"option_code": "blue",
"option_label": "Blue"
}
],
"categories": [{"code": "mens-clothing",
"id": "10",
"name": "Men's Clothing"
}
],
"created_at": "2024-01-15T11:00:00Z",
"created_by": {"id": "string",
"name": "string",
"type": "string"
},
"display_attributes": {"image": {"code": "name",
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Product Name"
},
"name": {"code": "name",
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Product Name"
}
},
"id": "3001",
"is_default": false,
"modified_at": "2024-01-20T16:30:00Z",
"modified_by": {"id": "string",
"name": "string",
"type": "string"
},
"product": {"id": "1001",
"name": "Blue Cotton T-Shirt"
},
"product_family": {"code": "APPAREL",
"id": "5",
"name": "Apparel"
},
"sku": "TSHIRT-BLU-S",
"status": "enabled",
"variant_axes": [{"code": "color",
"level": 1,
"name": "Color",
"value": { }
}
]
},
"success": true
}

Change variant status

Change the status of a variant (draft/in_review/approved/archived)

Authorizations:

BearerAuth

path Parameters

productId required	string Product ID
id required	string Variant ID

Request Body schema: application/json
required

Status change request

status

required

string

Enum: "draft" "in_review" "approved" "archived"

Responses

Request samples

Payload

Content type

application/json

{"status": "approved"
}

Response samples

200
400
401
404
500

Content type

application/json

{"data": {"axis_values": [{"axis_code": "color",
"option_code": "blue",
"option_label": "Blue"
}
],
"categories": [{"code": "mens-clothing",
"id": "10",
"name": "Men's Clothing"
}
],
"created_at": "2024-01-15T11:00:00Z",
"created_by": {"id": "string",
"name": "string",
"type": "string"
},
"display_attributes": {"image": {"code": "name",
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Product Name"
},
"name": {"code": "name",
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Product Name"
}
},
"id": "3001",
"is_default": false,
"modified_at": "2024-01-20T16:30:00Z",
"modified_by": {"id": "string",
"name": "string",
"type": "string"
},
"product": {"id": "1001",
"name": "Blue Cotton T-Shirt"
},
"product_family": {"code": "APPAREL",
"id": "5",
"name": "Apparel"
},
"sku": "TSHIRT-BLU-S",
"status": "enabled",
"variant_axes": [{"code": "color",
"level": 1,
"name": "Color",
"value": { }
}
]
},
"success": true
}

Variant Attributes

List variant attributes

Get all attributes for a specific variant with attribute metadata

Authorizations:

BearerAuth

path Parameters

productId required	string Product ID
variantId required	string Variant ID

query Parameters

page	integer >= 1 Default: 1 Page number
page_size	integer [ 1 .. 100 ] Default: 20 Items per page
search	string Search by attribute name

Responses

Response samples

200
400
401
404
500

Content type

application/json

{"data": {"items": [{"attribute_code": "color",
"attribute_config": { },
"attribute_group": {"code": "GENERAL",
"id": "3",
"name": "General Information"
},
"attribute_id": "10",
"attribute_name": "Color",
"attribute_translations": { },
"attribute_type": "select",
"channel_settings": [{"channel_code": "amazon",
"enabled": true
}
],
"is_custom": false,
"is_inherited": false,
"is_mandatory": true,
"is_overridable": false,
"is_overridden": true,
"is_unique": false,
"is_variant_axis": true,
"modified_at": "2024-01-20T17:00:00Z",
"modified_by": {"id": "string",
"name": "string",
"type": "string"
},
"value_per_channel": false,
"value_per_locale": true,
"values": [{"channel": "$default",
"data": { },
"locale": "$default"
}
]
}
],
"pagination": {"has_next": true,
"page": 0,
"page_size": 0,
"total_items": 0,
"total_pages": 0
}
},
"success": true
}

Create variant attributes

Bulk create or update attributes for a variant. Each value uses the standardized payload: text/number/boolean: {"value": "some text"} | select: {"value": "option_code"}

Authorizations:

BearerAuth

path Parameters

productId required	string Product ID
variantId required	string Variant ID

Request Body schema: application/json
required

Variant attributes

Array

attribute_id required	string
	Array of objects (ScopedValue2)

Responses

Request samples

Payload

Content type

application/json

[{"attribute_id": "10",
"values": [{"channel": "$default",
"data": { },
"locale": "$default"
}
]
}
]

Response samples

201
400
401
404
500

Content type

application/json

{"data": null,
"success": true
}

Update variant attributes

Bulk update or create attributes for a variant (PATCH semantics - only modifies provided attributes). Each value uses the standardized payload: text/number/boolean: {"value": "some text"} | select: {"value": "option_code"}

Authorizations:

BearerAuth

path Parameters

productId required	string Product ID
variantId required	string Variant ID

Request Body schema: application/json
required

Variant attributes to update

Array

attribute_id required	string
	Array of objects (ScopedValue2)

Responses

Request samples

Payload

Content type

application/json

[{"attribute_id": "10",
"values": [{"channel": "$default",
"data": { },
"locale": "$default"
}
]
}
]

Response samples

200
400
401
404
500

Content type

application/json

{"data": null,
"success": true
}

Delete a variant attribute

Delete a specific attribute from a variant

Authorizations:

BearerAuth

path Parameters

productId required	string Product ID
variantId required	string Variant ID
id required	string Variant Attribute ID

Responses

Response samples

401
404
500

Content type

application/json

{"errors": [{"code": "string",
"field": "string",
"message": "string"
}
],
"message": "string",
"success": true
}

Product API (1.0.0)

Product Families

List product families

Authorizations:

query Parameters

Responses

Response samples

Create a new product family

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get product family details

Authorizations:

path Parameters

Responses

Response samples

Delete a product family

Authorizations:

path Parameters

Responses

Response samples

Update a product family

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Change product family status

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Product Family Translations

Get all translations for a product family

Authorizations:

path Parameters

Responses

Response samples

Update product family translations

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Product Family Attributes

List product family attributes

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Create product family attributes

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Partially update product family attributes

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete a product family attribute

Authorizations:

path Parameters

Responses

Response samples

Variant Families

List variant families

Authorizations:

path Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required