Attribute API (1.0.0)

Download OpenAPI specification:

Attribute definitions, groups, and options.

Attribute Groups

List attribute groups

List all attribute groups with pagination

Authorizations:

BearerAuth

query Parameters

page	integer Default: 1 Page number
page_size	integer Default: 20 Page size
search	string Search term for code or name
status	string Filter by status

Responses

Response samples

200
400
500

Content type

application/json

{"data": {"items": [{"attribute_count": 12,
"code": "TECHNICAL",
"created_at": "2026-01-18T10:30:00Z",
"created_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"id": "5",
"modified_at": "2026-01-18T15:45:00Z",
"modified_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"name": "Technical Specifications",
"sort_order": 1,
"status": "active"
}
],
"pagination": {"has_next": true,
"page": 0,
"page_size": 0,
"total_items": 0,
"total_pages": 0
}
},
"success": true
}

Create an attribute group

Create a new attribute group

Authorizations:

BearerAuth

Request Body schema: application/json
required

Attribute group creation request

code required	string [ 1 .. 64 ] characters
description	string <= 255 characters
name required	string [ 1 .. 255 ] characters
sort_order	integer >= 0

Responses

Request samples

Payload

Content type

application/json

{"code": "TECHNICAL",
"description": "Technical attribute group",
"name": "Technical Specifications",
"sort_order": 1
}

Response samples

201
400
500

Content type

application/json

{"data": {"attribute_count": 12,
"code": "TECHNICAL",
"created_at": "2026-01-18T10:30:00Z",
"created_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"description": "Technical attribute group",
"id": "5",
"modified_at": "2026-01-18T15:45:00Z",
"modified_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"name": "Technical Specifications",
"sort_order": 1,
"status": "active"
},
"success": true
}

Get an attribute group by ID

Retrieve a single attribute group by its unique identifier

Authorizations:

BearerAuth

path Parameters

id

required

string

Attribute Group ID

Responses

Response samples

200
400
404
500

Content type

application/json

{"data": {"attribute_count": 12,
"code": "TECHNICAL",
"created_at": "2026-01-18T10:30:00Z",
"created_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"description": "Technical attribute group",
"id": "5",
"modified_at": "2026-01-18T15:45:00Z",
"modified_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"name": "Technical Specifications",
"sort_order": 1,
"status": "active"
},
"success": true
}

Delete an attribute group

Delete an attribute group by ID

Authorizations:

BearerAuth

path Parameters

id

required

string

Attribute Group ID

Responses

Response samples

400
404
500

Content type

application/json

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

Update an attribute group

Update an existing attribute group by ID

Authorizations:

BearerAuth

path Parameters

id

required

string

Attribute Group ID

Request Body schema: application/json
required

Attribute group update request

description	string
name	string [ 1 .. 255 ] characters
sort_order	integer >= 0

Responses

Request samples

Payload

Content type

application/json

{"description": "Updated description",
"name": "Technical Specifications",
"sort_order": 1
}

Response samples

200
400
404
500

Content type

application/json

{"data": {"attribute_count": 12,
"code": "TECHNICAL",
"created_at": "2026-01-18T10:30:00Z",
"created_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"description": "Technical attribute group",
"id": "5",
"modified_at": "2026-01-18T15:45:00Z",
"modified_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"name": "Technical Specifications",
"sort_order": 1,
"status": "active"
},
"success": true
}

Change attribute group status

Change an attribute group's status (activate or deactivate)

Authorizations:

BearerAuth

path Parameters

id

required

string

Attribute Group 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": "active"
}

Response samples

200
400
404
500

Content type

application/json

{"data": {"attribute_count": 12,
"code": "TECHNICAL",
"created_at": "2026-01-18T10:30:00Z",
"created_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"description": "Technical attribute group",
"id": "5",
"modified_at": "2026-01-18T15:45:00Z",
"modified_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"name": "Technical Specifications",
"sort_order": 1,
"status": "active"
},
"success": true
}

Attribute Group Translations

Get all translations for an attribute group

Retrieve all localized translations for a specific attribute group

Authorizations:

BearerAuth

path Parameters

id

required

string

Attribute Group 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": "Technical Specifications"
}
]
},
"success": true
}

Update attribute group translations

PATCH: Update multiple translations for an attribute group

Authorizations:

BearerAuth

path Parameters

id

required

string

Attribute Group ID

Request Body schema: application/json
required

Translations data

required

Array of objects (AttributeGroupTranslationInput)

Responses

Request samples

Payload

Content type

application/json

{"translations": [{"locale": "en_US",
"name": "Technical Specifications"
}
]
}

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": "Technical Specifications"
}
]
},
"success": true
}

Attributes

List attribute types

Retrieve all available attribute types

Authorizations:

BearerAuth

Responses

Response samples

200
500

Content type

application/json

{"data": [{"code": "text",
"description": "Single-line text input",
"name": "Text",
"sort_order": 1
}
],
"success": true
}

List attributes

List all attributes with pagination and filtering

Authorizations:

BearerAuth

query Parameters

page	integer Default: 1 Page number
page_size	integer Default: 20 Page size
search	string Search term for code or name
attribute_type	string Filter by attribute type
status	string Filter by status

Responses

Response samples

200
400
500

Content type

application/json

{"data": {"items": [{"attribute_group": {"code": "TECHNICAL",
"id": "5",
"name": "Technical"
},
"attribute_type": "select",
"code": "COLOR",
"created_at": "2026-01-18T10:30:00Z",
"created_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"id": "15",
"is_unique": false,
"modified_at": "2026-01-18T15:45:00Z",
"modified_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"name": "Color",
"sort_order": 1,
"status": "active",
"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 an attribute

Create a new attribute

Authorizations:

BearerAuth

Request Body schema: application/json
required

Attribute creation request

attribute_group_id	string non-empty
attribute_type required	string Enum: "text" "text_area" "number" "price" "select" "multi_select" "measurement" "media" "media_group" "boolean" "date" "date_range" "file" "location" "link" "identifier" "tax_class"
code required	string <= 50 characters
	object
description	string <= 1000 characters
is_unique	boolean
name required	string <= 255 characters
sort_order	integer >= 0
value_per_channel	boolean
value_per_locale	boolean

Responses

Request samples

Payload

Content type

application/json

{"attribute_group_id": "5",
"attribute_type": "select",
"code": "COLOR",
"config": { },
"description": "Product color attribute",
"is_unique": false,
"name": "Color",
"sort_order": 1,
"value_per_channel": false,
"value_per_locale": true
}

Response samples

201
400
500

Content type

application/json

{"data": {"attribute_group": {"code": "TECHNICAL",
"id": "5",
"name": "Technical"
},
"attribute_type": "select",
"code": "COLOR",
"config": { },
"created_at": "2026-01-18T10:30:00Z",
"created_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"description": "Product color attribute",
"id": "15",
"is_unique": false,
"modified_at": "2026-01-18T15:45:00Z",
"modified_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"name": "Color",
"sort_order": 1,
"status": "active",
"value_per_channel": false,
"value_per_locale": true
},
"success": true
}

Get an attribute by ID

Retrieve a single attribute by its unique identifier

Authorizations:

BearerAuth

path Parameters

id

required

string

Attribute ID

Responses

Response samples

200
400
404
500

Content type

application/json

{"data": {"attribute_group": {"code": "TECHNICAL",
"id": "5",
"name": "Technical"
},
"attribute_type": "select",
"code": "COLOR",
"config": { },
"created_at": "2026-01-18T10:30:00Z",
"created_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"description": "Product color attribute",
"id": "15",
"is_unique": false,
"modified_at": "2026-01-18T15:45:00Z",
"modified_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"name": "Color",
"sort_order": 1,
"status": "active",
"value_per_channel": false,
"value_per_locale": true
},
"success": true
}

Delete an attribute

Delete an attribute by ID

Authorizations:

BearerAuth

path Parameters

id

required

string

Attribute ID

Responses

Response samples

400
404
500

Content type

application/json

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

Update an attribute

Update an existing attribute by ID

Authorizations:

BearerAuth

path Parameters

id

required

string

Attribute ID

Request Body schema: application/json
required

Attribute update request

attribute_group_id	string non-empty
attribute_type	string Enum: "text" "text_area" "number" "price" "select" "multi_select" "measurement" "media" "media_group" "boolean" "date" "date_range" "file" "location" "link" "identifier" "tax_class"
code	string <= 50 characters
	object
description	string <= 1000 characters
is_unique	boolean
name	string <= 255 characters
sort_order	integer >= 0
value_per_channel	boolean
value_per_locale	boolean

Responses

Request samples

Payload

Content type

application/json

{"attribute_group_id": "5",
"attribute_type": "select",
"code": "COLOR",
"config": { },
"description": "Updated product color",
"is_unique": false,
"name": "Color",
"sort_order": 1,
"value_per_channel": false,
"value_per_locale": true
}

Response samples

200
400
404
500

Content type

application/json

{"data": {"attribute_group": {"code": "TECHNICAL",
"id": "5",
"name": "Technical"
},
"attribute_type": "select",
"code": "COLOR",
"config": { },
"created_at": "2026-01-18T10:30:00Z",
"created_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"description": "Product color attribute",
"id": "15",
"is_unique": false,
"modified_at": "2026-01-18T15:45:00Z",
"modified_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"name": "Color",
"sort_order": 1,
"status": "active",
"value_per_channel": false,
"value_per_locale": true
},
"success": true
}

Change attribute status

Change an attribute's status (activate or deactivate)

Authorizations:

BearerAuth

path Parameters

id

required

string

Attribute 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": "active"
}

Response samples

200
400
404
500

Content type

application/json

{"data": {"attribute_group": {"code": "TECHNICAL",
"id": "5",
"name": "Technical"
},
"attribute_type": "select",
"code": "COLOR",
"config": { },
"created_at": "2026-01-18T10:30:00Z",
"created_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"description": "Product color attribute",
"id": "15",
"is_unique": false,
"modified_at": "2026-01-18T15:45:00Z",
"modified_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"name": "Color",
"sort_order": 1,
"status": "active",
"value_per_channel": false,
"value_per_locale": true
},
"success": true
}

Attribute Options

List attribute options

List all attribute options for a specific attribute with pagination

Authorizations:

BearerAuth

path Parameters

attributeId

required

string

Attribute ID

query Parameters

page	integer Default: 1 Page number
page_size	integer Default: 20 Page size
search	string Search term for option

Responses

Response samples

200
400
500

Content type

application/json

{"data": {"items": [{"attribute_id": "15",
"code": "#FF0000",
"created_at": "2026-01-18T10:30:00Z",
"created_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"id": "25",
"label": "Red",
"modified_at": "2026-01-18T15:45:00Z",
"modified_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"translations": [{"label": "Red",
"locale": "en_US"
}
]
}
],
"pagination": {"has_next": true,
"page": 0,
"page_size": 0,
"total_items": 0,
"total_pages": 0
}
},
"success": true
}

Create an attribute option

Create a new attribute option for a specific attribute

Authorizations:

BearerAuth

path Parameters

attributeId

required

string

Attribute ID

Request Body schema: application/json
required

Attribute option creation request

code required	string
label required	string

Responses

Request samples

Payload

Content type

application/json

{"code": "#FF0000",
"label": "Red"
}

Response samples

201
400
500

Content type

application/json

{"data": {"attribute_id": "15",
"code": "#FF0000",
"created_at": "2026-01-18T10:30:00Z",
"created_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"id": "25",
"label": "Red",
"modified_at": "2026-01-18T15:45:00Z",
"modified_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"translations": [{"label": "Red",
"locale": "en_US"
}
]
},
"success": true
}

Get an attribute option by ID

Retrieve a single attribute option by its unique identifier

Authorizations:

BearerAuth

path Parameters

attributeId required	string Attribute ID
id required	string Attribute Option ID

Responses

Response samples

200
400
404
500

Content type

application/json

{"data": {"attribute_id": "15",
"code": "#FF0000",
"created_at": "2026-01-18T10:30:00Z",
"created_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"id": "25",
"label": "Red",
"modified_at": "2026-01-18T15:45:00Z",
"modified_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"translations": [{"label": "Red",
"locale": "en_US"
}
]
},
"success": true
}

Delete an attribute option

Delete an attribute option by ID

Authorizations:

BearerAuth

path Parameters

attributeId required	string Attribute ID
id required	string Attribute Option ID

Responses

Response samples

400
404
500

Content type

application/json

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

Update an attribute option

Update an existing attribute option by ID

Authorizations:

BearerAuth

path Parameters

attributeId required	string Attribute ID
id required	string Attribute Option ID

Request Body schema: application/json
required

Attribute option update request

code required	string
label required	string

Responses

Request samples

Payload

Content type

application/json

{"code": "#FF0000",
"label": "Red"
}

Response samples

200
400
404
500

Content type

application/json

{"data": {"attribute_id": "15",
"code": "#FF0000",
"created_at": "2026-01-18T10:30:00Z",
"created_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"id": "25",
"label": "Red",
"modified_at": "2026-01-18T15:45:00Z",
"modified_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"translations": [{"label": "Red",
"locale": "en_US"
}
]
},
"success": true
}

Attribute Option Translations

Get all translations for an attribute option

Retrieve all localized translations for a specific attribute option

Authorizations:

BearerAuth

path Parameters

attributeId required	string Attribute ID
id required	string Attribute Option ID

Responses

Response samples

200
400
404
500

Content type

application/json

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

Update attribute option translations

PATCH: Update multiple translations for an attribute option

Authorizations:

BearerAuth

path Parameters

attributeId required	string Attribute ID
id required	string Attribute Option ID

Request Body schema: application/json
required

Translations data

required

Array of objects (AttributeOptionTranslationInput)

Responses

Request samples

Payload

Content type

application/json

{"translations": [{"label": "Red",
"locale": "en_US"
}
]
}

Response samples

200
400
404
500

Content type

application/json

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

Attribute Translations

Get all translations for an attribute

Retrieve all localized translations for a specific attribute

Authorizations:

BearerAuth

path Parameters

id

required

string

Attribute 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": "Color"
}
]
},
"success": true
}

Update attribute translations

PATCH: Update multiple translations for an attribute

Authorizations:

BearerAuth

path Parameters

id

required

string

Attribute ID

Request Body schema: application/json
required

Translations data

required

Array of objects (AttributeTranslationInput)

Responses

Request samples

Payload

Content type

application/json

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

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": "Color"
}
]
},
"success": true
}

UOM Families

List UOM families

List all UOM families with pagination and filtering

Authorizations:

BearerAuth

query Parameters

page	integer Default: 1 Page number
page_size	integer Default: 10 Page size
status	string Filter by status
search	string Search term for code or name

Responses

Response samples

200
400
500

Content type

application/json

{"data": {"items": [{"base_uom_id": "3",
"code": "WEIGHT",
"created_at": "2026-01-18T10:30:00Z",
"id": "1",
"modified_at": "2026-01-18T15:45:00Z",
"name": "Weight",
"status": "active",
"uom_count": 5
}
],
"pagination": {"has_next": true,
"page": 0,
"page_size": 0,
"total_items": 0,
"total_pages": 0
}
},
"success": true
}

Create a UOM family

Create a new unit of measure family with optional base UOM

Authorizations:

BearerAuth

Request Body schema: application/json
required

UOM family creation request

	object (BaseUOMRequest)
code required	string [ 1 .. 64 ] characters
description	string <= 255 characters
name required	string [ 1 .. 255 ] characters

Responses

Request samples

Payload

Content type

application/json

{"base_uom": {"code": "KG",
"name": "Kilogram",
"symbol": "kg"
},
"code": "WEIGHT",
"description": "Weight measurement units",
"name": "Weight"
}

Response samples

201
400
409
500

Content type

application/json

{"data": {"base_uom_id": "3",
"code": "WEIGHT",
"created_at": "2026-01-18T10:30:00Z",
"description": "Weight measurement units",
"id": "1",
"modified_at": "2026-01-18T15:45:00Z",
"name": "Weight",
"status": "active",
"uom_count": 5
},
"success": true
}

Get a UOM family by ID

Retrieve a single UOM family by its unique identifier

Authorizations:

BearerAuth

path Parameters

id

required

string

UOM Family ID

Responses

Response samples

200
400
404
500

Content type

application/json

{"data": {"base_uom_id": "3",
"code": "WEIGHT",
"created_at": "2026-01-18T10:30:00Z",
"description": "Weight measurement units",
"id": "1",
"modified_at": "2026-01-18T15:45:00Z",
"name": "Weight",
"status": "active",
"uom_count": 5
},
"success": true
}

Delete a UOM family

Delete a UOM family by ID

Authorizations:

BearerAuth

path Parameters

id

required

string

UOM Family ID

Responses

Response samples

400
404
500

Content type

application/json

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

Update a UOM family

Update an existing UOM family by ID

Authorizations:

BearerAuth

path Parameters

id

required

string

UOM Family ID

Request Body schema: application/json
required

UOM family update request

description	string
name	string [ 1 .. 255 ] characters

Responses

Request samples

Payload

Content type

application/json

{"description": "Updated description",
"name": "Weight"
}

Response samples

200
400
404
500

Content type

application/json

{"data": {"base_uom_id": "3",
"code": "WEIGHT",
"created_at": "2026-01-18T10:30:00Z",
"description": "Weight measurement units",
"id": "1",
"modified_at": "2026-01-18T15:45:00Z",
"name": "Weight",
"status": "active",
"uom_count": 5
},
"success": true
}

Change UOM family status

Change a UOM family's status (activate or deactivate)

Authorizations:

BearerAuth

path Parameters

id

required

string

UOM 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": "active"
}

Response samples

200
400
404
500

Content type

application/json

{"data": {"base_uom_id": "3",
"code": "WEIGHT",
"created_at": "2026-01-18T10:30:00Z",
"description": "Weight measurement units",
"id": "1",
"modified_at": "2026-01-18T15:45:00Z",
"name": "Weight",
"status": "active",
"uom_count": 5
},
"success": true
}

UOM Family Translations

Get all translations for a UOM family

Retrieve all localized translations for a specific UOM family

Authorizations:

BearerAuth

path Parameters

id

required

string

UOM 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": "Weight"
}
]
},
"success": true
}

Update UOM family translations

PATCH: Update multiple translations for a UOM family

Authorizations:

BearerAuth

path Parameters

id

required

string

UOM Family ID

Request Body schema: application/json
required

Translations data

required

Array of objects (UOMFamilyTranslationInput)

Responses

Request samples

Payload

Content type

application/json

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

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": "Weight"
}
]
},
"success": true
}

UOMs

List UOMs

List all units of measure with pagination and filtering

Authorizations:

BearerAuth

query Parameters

page	integer Default: 1 Page number
page_size	integer Default: 20 Page size
search	string Search term for code or name
uom_family_id	string Filter by UOM family ID
status	string Filter by status

Responses

Response samples

200
400
500

Content type

application/json

{"data": {"items": [{"code": "KG",
"conversion_factor": 1,
"conversion_offset": 0,
"created_at": "2026-01-18T10:30:00Z",
"id": "3",
"is_base_unit": true,
"modified_at": "2026-01-18T15:45:00Z",
"name": "Kilogram",
"status": "active",
"symbol": "kg",
"translations": [{"locale": "en_US",
"name": "Kilogram"
}
],
"uom_family": {"code": "WEIGHT",
"id": "1",
"name": "Weight"
},
"uom_family_id": "1"
}
],
"pagination": {"has_next": true,
"page": 0,
"page_size": 0,
"total_items": 0,
"total_pages": 0
}
},
"success": true
}

Create a UOM

Create a new unit of measure

Authorizations:

BearerAuth

Request Body schema: application/json
required

UOM creation request

code required	string [ 1 .. 64 ] characters
conversion_factor required	number
conversion_offset	number
description	string <= 255 characters
is_base	boolean
name required	string [ 1 .. 255 ] characters
symbol required	string [ 1 .. 32 ] characters
uom_family_id required	string

Responses

Request samples

Payload

Content type

application/json

{"code": "KG",
"conversion_factor": 1,
"conversion_offset": 0,
"description": "Unit of mass",
"is_base": true,
"name": "Kilogram",
"symbol": "kg",
"uom_family_id": "1"
}

Response samples

201
400
500

Content type

application/json

{"data": {"code": "KG",
"conversion_factor": 1,
"conversion_offset": 0,
"created_at": "2026-01-18T10:30:00Z",
"description": "Unit of mass",
"id": "3",
"is_base_unit": true,
"modified_at": "2026-01-18T15:45:00Z",
"name": "Kilogram",
"status": "active",
"symbol": "kg",
"translations": [{"locale": "en_US",
"name": "Kilogram"
}
],
"uom_family": {"code": "WEIGHT",
"id": "1",
"name": "Weight"
},
"uom_family_id": "1"
},
"success": true
}

Get a UOM by ID

Retrieve a single unit of measure by its unique identifier

Authorizations:

BearerAuth

path Parameters

id

required

string

UOM ID

Responses

Response samples

200
400
404
500

Content type

application/json

{"data": {"code": "KG",
"conversion_factor": 1,
"conversion_offset": 0,
"created_at": "2026-01-18T10:30:00Z",
"description": "Unit of mass",
"id": "3",
"is_base_unit": true,
"modified_at": "2026-01-18T15:45:00Z",
"name": "Kilogram",
"status": "active",
"symbol": "kg",
"translations": [{"locale": "en_US",
"name": "Kilogram"
}
],
"uom_family": {"code": "WEIGHT",
"id": "1",
"name": "Weight"
},
"uom_family_id": "1"
},
"success": true
}

Delete a UOM

Delete a unit of measure by ID

Authorizations:

BearerAuth

path Parameters

id

required

string

UOM ID

Responses

Response samples

400
404
500

Content type

application/json

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

Update a UOM

Update an existing unit of measure by ID

Authorizations:

BearerAuth

path Parameters

id

required

string

UOM ID

Request Body schema: application/json
required

UOM update request

conversion_factor	number
conversion_offset	number
description	string
name	string [ 1 .. 255 ] characters
symbol	string [ 1 .. 32 ] characters

Responses

Request samples

Payload

Content type

application/json

{"conversion_factor": 1,
"conversion_offset": 0,
"description": "Updated unit of mass",
"name": "Kilogram",
"symbol": "kg"
}

Response samples

200
400
404
500

Content type

application/json

{"data": {"code": "KG",
"conversion_factor": 1,
"conversion_offset": 0,
"created_at": "2026-01-18T10:30:00Z",
"description": "Unit of mass",
"id": "3",
"is_base_unit": true,
"modified_at": "2026-01-18T15:45:00Z",
"name": "Kilogram",
"status": "active",
"symbol": "kg",
"translations": [{"locale": "en_US",
"name": "Kilogram"
}
],
"uom_family": {"code": "WEIGHT",
"id": "1",
"name": "Weight"
},
"uom_family_id": "1"
},
"success": true
}

Change UOM status

Change a UOM's status (activate or deactivate)

Authorizations:

BearerAuth

path Parameters

id

required

string

UOM 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": "active"
}

Response samples

200
400
404
500

Content type

application/json

{"data": {"code": "KG",
"conversion_factor": 1,
"conversion_offset": 0,
"created_at": "2026-01-18T10:30:00Z",
"description": "Unit of mass",
"id": "3",
"is_base_unit": true,
"modified_at": "2026-01-18T15:45:00Z",
"name": "Kilogram",
"status": "active",
"symbol": "kg",
"translations": [{"locale": "en_US",
"name": "Kilogram"
}
],
"uom_family": {"code": "WEIGHT",
"id": "1",
"name": "Weight"
},
"uom_family_id": "1"
},
"success": true
}

UOM Translations

Get all translations for a UOM

Retrieve all localized translations for a specific UOM

Authorizations:

BearerAuth

path Parameters

id

required

string

UOM 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": "Kilogram"
}
]
},
"success": true
}

Update UOM translations

PATCH: Update multiple translations for a UOM

Authorizations:

BearerAuth

path Parameters

id

required

string

UOM ID

Request Body schema: application/json
required

Translations data

required

Array of objects (UOMTranslationInput)

Responses

Request samples

Payload

Content type

application/json

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

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": "Kilogram"
}
]
},
"success": true
}

Attribute API (1.0.0)

Attribute Groups

List attribute groups

Authorizations:

query Parameters

Responses

Response samples

Create an attribute group

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get an attribute group by ID

Authorizations:

path Parameters

Responses

Response samples

Delete an attribute group

Authorizations:

path Parameters

Responses

Response samples

Update an attribute group

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Change attribute group status

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Attribute Group Translations

Get all translations for an attribute group

Authorizations:

path Parameters

Responses

Response samples

Update attribute group translations

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Attributes

List attribute types

Authorizations:

Responses

Response samples

List attributes

Authorizations:

query Parameters

Responses

Response samples

Create an attribute

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get an attribute by ID

Authorizations:

path Parameters

Responses

Response samples

Delete an attribute

Authorizations:

path Parameters

Responses

Response samples

Update an attribute

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

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