CategoryParametric

Management API (v1)

The Norce Management API lets you manage configurations and metadata on a client.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers

https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/

Schemas

Settings ApplicationCountry

Operations

Settings ApplicationCulture

Operations

Settings ApplicationCurrency

Operations

Settings ApplicationSalesArea

Operations

Settings Application

Operations

Category

Operations

CategoryParametric

Operations

List category parametrics

Request

Path
categoryIdinteger(int32)required

Category id

Query
isRequiredboolean

Only required parameters. Defaults to false

Default false
Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

curl -i -X GET \
  'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/category/{categoryId}/parametric' \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the list of category parametrics, if any exists

Bodyapplication/jsonArray [
Idinteger(int32)required

The parametric identifier.

Example: 15
CategoryIdinteger or null(int32)

The category identifier this parametric is associated with.

Example: 11
Namestring or null[ 0 .. 50 ] characters

The parametric name.

Example: "Machines - Cutting size"
Codestring or null[ 0 .. 50 ] characters

The parametric code.

Example: "p_machines_cutting_size"
Uomstring or null[ 0 .. 50 ] characters

Unit of measurement for the parametric value.

Descriptionstring or null[ 0 .. 500 ] characters

A longer description for the parametric explaining it in more detail.

Typestring or null

The type of parametric. Valid values: text, html, int, decimal, date, boolean, list, multiple.

Example: "list"
TypeIdinteger(int32)

Obsolete, use Type property instead.

GroupIdinteger or null(int32)

The identifier of the parametric group this parametric belongs to. This can be the default group from the parametric definition or a specific group assigned for this category.

Example: 1
GroupNamestring or null[ 0 .. 50 ] characters

The name of the parametric group this parametric belongs to.

Example: "Specifications"
GroupDescriptionstring or null[ 0 .. 500 ] characters

The description of the parametric group this parametric belongs to.

Example: "Group of important specifications"
SortOrderinteger or null(int32)

The sort order for this parametric within the category.

Example: 1
FocusSortOrderinteger or null(int32)

The filter sort order for this parametric. Has value if the parametric is promoted to a filter in the category.

Example: 1
PrioritySortOrderinteger or null(int32)

Obsolete, not used anymore.

IsSecondaryboolean

Indicates whether this parametric is marked as secondary within the category. Used in front-end displays to de-emphasize less important attributes.

IsRequiredboolean or null

Indicates whether this parametric is required when assigned to products in this category. Overrides the global parametric setting if specified.

IsHiddenboolean

Indicates whether this parametric is hidden. Used in front-end displays to completely hide the attribute from view.

IsPublicboolean

Inherited from Parametric, indicates whether this parametric is Global.

DefaultIsVariantUniqueboolean

Inherited from Parametric, Indicates that the parametric will default to variants when merging products in this category.

Example: true
HasListValuesboolean

Indicated if the parametric has list values (Type = list, and has at least one list value defined).

HasMultipleValuesboolean

Indicated if the parametric has multiple values (Type = multiple, and has at least one list value defined).

IsActiveboolean

False if the parametric link is soft deleted, Indicates whether this parametric association is active for the category.

Example: true
Changedstring or null

The date and time when the CategoryParametric entity was last changed.

Example: "04/14/2025 15:19"
ChangedBystring or null

The name of the user who last changed the CategoryParametric entity.

Example: "Admin User"
]
Response
application/json
[
  {
    "Id": 15,
    "CategoryId": 11,
    "Name": "Machines - Cutting size",
    "Code": "p_machines_cutting_size",
    "Uom": "",
    "Description": "",
    "Type": "list",
    "TypeId": 0,
    "GroupId": 1,
    "GroupName": "Specifications",
    "GroupDescription": "Group of important specifications",
    "SortOrder": 1,
    "FocusSortOrder": 1,
    "PrioritySortOrder": null,
    "IsSecondary": false,
    "IsRequired": false,
    "IsHidden": false,
    "IsPublic": false,
    "DefaultIsVariantUnique": true,
    "HasListValues": false,
    "HasMultipleValues": false,
    "IsActive": true,
    "Changed": "04/14/2025 15:19",
    "ChangedBy": "Admin User"
  }
]

Update category parametrics

Request

Update a complete list of parametrics assigned to a category

Path
categoryIdinteger(int32)required

The identifier of the category that will be updated

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

a list of category parametrics, empty list will remove all parametrics from the category

Array [
Idinteger(int32)required

The parametric identifier.

Example: 15
CategoryIdinteger or null(int32)

The category identifier this parametric is associated with.

Example: 11
Namestring or null[ 0 .. 50 ] characters

The parametric name.

Example: "Machines - Cutting size"
Codestring or null[ 0 .. 50 ] characters

The parametric code.

Example: "p_machines_cutting_size"
Uomstring or null[ 0 .. 50 ] characters

Unit of measurement for the parametric value.

Descriptionstring or null[ 0 .. 500 ] characters

A longer description for the parametric explaining it in more detail.

Typestring or null

The type of parametric. Valid values: text, html, int, decimal, date, boolean, list, multiple.

Example: "list"
TypeIdinteger(int32)

Obsolete, use Type property instead.

GroupIdinteger or null(int32)

The identifier of the parametric group this parametric belongs to. This can be the default group from the parametric definition or a specific group assigned for this category.

Example: 1
GroupNamestring or null[ 0 .. 50 ] characters

The name of the parametric group this parametric belongs to.

Example: "Specifications"
GroupDescriptionstring or null[ 0 .. 500 ] characters

The description of the parametric group this parametric belongs to.

Example: "Group of important specifications"
SortOrderinteger or null(int32)

The sort order for this parametric within the category.

Example: 1
FocusSortOrderinteger or null(int32)

The filter sort order for this parametric. Has value if the parametric is promoted to a filter in the category.

Example: 1
PrioritySortOrderinteger or null(int32)

Obsolete, not used anymore.

IsSecondaryboolean

Indicates whether this parametric is marked as secondary within the category. Used in front-end displays to de-emphasize less important attributes.

IsRequiredboolean or null

Indicates whether this parametric is required when assigned to products in this category. Overrides the global parametric setting if specified.

IsHiddenboolean

Indicates whether this parametric is hidden. Used in front-end displays to completely hide the attribute from view.

IsPublicboolean

Inherited from Parametric, indicates whether this parametric is Global.

DefaultIsVariantUniqueboolean

Inherited from Parametric, Indicates that the parametric will default to variants when merging products in this category.

Example: true
HasListValuesboolean

Indicated if the parametric has list values (Type = list, and has at least one list value defined).

HasMultipleValuesboolean

Indicated if the parametric has multiple values (Type = multiple, and has at least one list value defined).

IsActiveboolean

False if the parametric link is soft deleted, Indicates whether this parametric association is active for the category.

Example: true
Changedstring or null

The date and time when the CategoryParametric entity was last changed.

Example: "04/14/2025 15:19"
ChangedBystring or null

The name of the user who last changed the CategoryParametric entity.

Example: "Admin User"
]
curl -i -X PUT \
  'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/category/{categoryId}/parametric' \
  -H 'Content-Type: application/json' \
  -H 'account-id: 0' \
  -H 'application-id: 0' \
  -d '[
    {
      "Id": 15,
      "CategoryId": 11,
      "Name": "Machines - Cutting size",
      "Code": "p_machines_cutting_size",
      "Uom": "",
      "Description": "",
      "Type": "list",
      "TypeId": 0,
      "GroupId": 1,
      "GroupName": "Specifications",
      "GroupDescription": "Group of important specifications",
      "SortOrder": 1,
      "FocusSortOrder": 1,
      "PrioritySortOrder": null,
      "IsSecondary": false,
      "IsRequired": false,
      "IsHidden": false,
      "IsPublic": false,
      "DefaultIsVariantUnique": true,
      "HasListValues": false,
      "HasMultipleValues": false,
      "IsActive": true,
      "Changed": "04/14/2025 15:19",
      "ChangedBy": "Admin User"
    }
  ]'

Responses

If the category parametrics were successfully updated

Bodyapplication/json
integer(int32)
Response
application/json
0

Copy parametrics to all child categories to the specified category

Request

Note: This operation will replace all existing parametrics in the child categories with the provided list. Use with caution to avoid unintentional meta data corruption.

Path
categoryIdinteger(int32)required

Parent category id

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

a list of category parametrics that will replace the child category parametrics

Array [
Idinteger(int32)required

The parametric identifier.

Example: 15
CategoryIdinteger or null(int32)

The category identifier this parametric is associated with.

Example: 11
Namestring or null[ 0 .. 50 ] characters

The parametric name.

Example: "Machines - Cutting size"
Codestring or null[ 0 .. 50 ] characters

The parametric code.

Example: "p_machines_cutting_size"
Uomstring or null[ 0 .. 50 ] characters

Unit of measurement for the parametric value.

Descriptionstring or null[ 0 .. 500 ] characters

A longer description for the parametric explaining it in more detail.

Typestring or null

The type of parametric. Valid values: text, html, int, decimal, date, boolean, list, multiple.

Example: "list"
TypeIdinteger(int32)

Obsolete, use Type property instead.

GroupIdinteger or null(int32)

The identifier of the parametric group this parametric belongs to. This can be the default group from the parametric definition or a specific group assigned for this category.

Example: 1
GroupNamestring or null[ 0 .. 50 ] characters

The name of the parametric group this parametric belongs to.

Example: "Specifications"
GroupDescriptionstring or null[ 0 .. 500 ] characters

The description of the parametric group this parametric belongs to.

Example: "Group of important specifications"
SortOrderinteger or null(int32)

The sort order for this parametric within the category.

Example: 1
FocusSortOrderinteger or null(int32)

The filter sort order for this parametric. Has value if the parametric is promoted to a filter in the category.

Example: 1
PrioritySortOrderinteger or null(int32)

Obsolete, not used anymore.

IsSecondaryboolean

Indicates whether this parametric is marked as secondary within the category. Used in front-end displays to de-emphasize less important attributes.

IsRequiredboolean or null

Indicates whether this parametric is required when assigned to products in this category. Overrides the global parametric setting if specified.

IsHiddenboolean

Indicates whether this parametric is hidden. Used in front-end displays to completely hide the attribute from view.

IsPublicboolean

Inherited from Parametric, indicates whether this parametric is Global.

DefaultIsVariantUniqueboolean

Inherited from Parametric, Indicates that the parametric will default to variants when merging products in this category.

Example: true
HasListValuesboolean

Indicated if the parametric has list values (Type = list, and has at least one list value defined).

HasMultipleValuesboolean

Indicated if the parametric has multiple values (Type = multiple, and has at least one list value defined).

IsActiveboolean

False if the parametric link is soft deleted, Indicates whether this parametric association is active for the category.

Example: true
Changedstring or null

The date and time when the CategoryParametric entity was last changed.

Example: "04/14/2025 15:19"
ChangedBystring or null

The name of the user who last changed the CategoryParametric entity.

Example: "Admin User"
]
curl -i -X PUT \
  'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/category/{categoryId}/parametric/copy-to-children' \
  -H 'Content-Type: application/json' \
  -H 'account-id: 0' \
  -H 'application-id: 0' \
  -d '[
    {
      "Id": 15,
      "CategoryId": 11,
      "Name": "Machines - Cutting size",
      "Code": "p_machines_cutting_size",
      "Uom": "",
      "Description": "",
      "Type": "list",
      "TypeId": 0,
      "GroupId": 1,
      "GroupName": "Specifications",
      "GroupDescription": "Group of important specifications",
      "SortOrder": 1,
      "FocusSortOrder": 1,
      "PrioritySortOrder": null,
      "IsSecondary": false,
      "IsRequired": false,
      "IsHidden": false,
      "IsPublic": false,
      "DefaultIsVariantUnique": true,
      "HasListValues": false,
      "HasMultipleValues": false,
      "IsActive": true,
      "Changed": "04/14/2025 15:19",
      "ChangedBy": "Admin User"
    }
  ]'

Responses

If the category parametrics were successfully copied to child categories

Settings ClientAssortment

Operations

Settings ClientCurrency

Operations

Settings ClientSalesArea

Operations

Customer FlagGroup

Operations

Customer Flag

Operations

Customer InfoType

Operations

Product Family

Operations

Product File

Operations

Product Manufacturer

Operations

Parametric Group

Operations

Parametric List

Operations

Parametric Multiple

Operations

Parametric

Operations

PriceList Population

Operations

PriceList Pricing

Operations

PriceList

Operations

PriceList SupplierPriceList

Operations

PriceList Warehouse

Operations

Product FlagGroup

Operations

Product Flag

Operations

Product InfoType

Operations

Product Type

Operations

Promotion

Operations

Product RelationType

Operations

PriceList RoundingRule

Operations

Shopping InfoType

Operations

Store Application

Operations

Store PriceList

Operations

Store

Operations

Store Warehouse

Operations

Supplier PriceList

Operations

Supplier PriceListWarehouse

Operations

Supplier

Operations

Supplier Warehouse

Operations

Supplier WarehouseLocation

Operations

Product VariantGroup

Operations

Product WarehouseLocation

Operations

Product Warehouse

Operations