COMMERCE QUERY
/
Query API 3.0
/
Schemas
/
ParametricGroup

Commerce Query API (v3.0)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Playground

https://{slug}.api-se.playground.norce.tech/commerce/query/3.0/

Stage

https://{slug}.api-se.stage.norce.tech/commerce/query/3.0/

Production

https://{slug}.api-se.norce.tech/commerce/query/3.0/

Schemas

CategoryParametric

categoryIdinteger(int32)

The category identifier.

parametricIdinteger(int32)

The parametric identifier.

groupIdinteger or null(int32)

The parametric group identifier.

sortOrderinteger or null(int32)

The sort order for display purposes.

focusSortOrderinteger or null(int32)

The focus sort order, focus is called filter in the admin tool.

isSecondaryboolean

Indicates whether the category parametric is secondary, not commonly used.

isRequiredboolean or null

Indicates whether the category parametric is required, overrides the parametric default.

createdstring(date-time)

The date and time the record was created.

createdByinteger(int32)

The identifier of the user who created the record.

updatedstring or null(date-time)

The date and time the record was last updated.

updatedByinteger or null(int32)

The identifier of the user who last updated the record.

prioritySortOrderinteger or null(int32)

The priority sort order.

{
  "categoryId": 0,
  "parametricId": 0,
  "groupId": 0,
  "sortOrder": 0,
  "focusSortOrder": 0,
  "isSecondary": true,
  "isRequired": true,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "prioritySortOrder": 0
}

ParametricGroup

idinteger(int32)

The unique identifier of the parametric group.

clientIdinteger(int32)

The client identifier.

defaultNamestring[ 0 .. 50 ] charactersrequired

The default name of the parametric group.

defaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the parametric group.

isActiveboolean

Indicates whether the parametric group is active.

createdstring(date-time)

The date and time the record was created.

createdByinteger(int32)

The identifier of the user who created the record.

updatedstring or null(date-time)

The date and time the record was last updated.

updatedByinteger or null(int32)

The identifier of the user who last updated the record.

codestring or null[ 0 .. 50 ] characters

The code of the parametric group.

parametricsArray of objects or null(CategoryParametric)
culturesArray of objects or null(ParametricGroupCulture)
{
  "id": 0,
  "clientId": 0,
  "defaultName": "string",
  "defaultDescription": "string",
  "isActive": true,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "code": "string",
  "parametrics": [
    { … }
  ],
  "cultures": [
    { … }
  ]
}

Parametric

idinteger(int32)

The unique identifier of the parametric.

clientIdinteger(int32)

The client identifier.

defaultNamestring[ 0 .. 50 ] charactersrequired

The default name of the parametric in the default culture.

defaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the parametric in the default culture.

defaultUomstring or null[ 0 .. 50 ] characters

The unit of measure in the default culture.

typeIdinteger(int32)

The type identifier, Text (1), Integer (2), Decimal (3), Boolean (4), HTML (5), Date (6).

hasListValuesboolean

Indicates whether the parametric has list values, is of type List and has at least one list item.

hasMultipleValuesboolean

Indicates whether the parametric has multiple values, is of type Multiple and has at least one multiple item.

isVariantTypeboolean

Indicates whether the parametric is used in at least one variant group (variant type). A parametric can be used in multiple variant groups.

isRequiredboolean

Indicates whether the parametric is required, can be overridden on the CategoryParametric setting.

isHiddenboolean

Indicates whether the parametric should be hidden in front end applications.

isActiveboolean

Indicates whether the parametric is active.

createdstring(date-time)

The date and time the record was created.

createdByinteger(int32)

The identifier of the user who created the record.

updatedstring or null(date-time)

The date and time the record was last updated.

updatedByinteger or null(int32)

The identifier of the user who last updated the record.

codestring or null[ 0 .. 50 ] characters

The code of the parametric.

codeListKeystring or null[ 0 .. 50 ] characters

The code list key, commonly not used.

isReadOnlyboolean

Indicates whether the parametric is read only, disable edit in the admin tool.

editorstring or null[ 0 .. 16 ] characters

The editor, HTML or Text, used by the admin tool to allow for editing the parametric value.

isFavoriteboolean

Indicates whether the parametric is favorite, adds the parametric to the top header of the product page in the admin tool.

isPublicboolean

Indicates whether the parametric is public, similar to IsHidden, but not used anymore, shows same values as IsActive.

groupIdinteger or null(int32)

The parametric group identifier.

defaultIsVariantUniqueboolean

Indicates if the parametric should be set on variant level by default on products.

showOnTextTabboolean

Indicates whether show on text tab is enabled, moved the parametric to the text tab in the admin tool.

showInListboolean

Indicates whether show in list is enabled, makes the parametric available in listings from api calls in commerce service.

aiInstructionstring or null
group(ParametricGroup (object or null))
One of:
culturesArray of objects or null(ParametricCulture)
{
  "id": 0,
  "clientId": 0,
  "defaultName": "string",
  "defaultDescription": "string",
  "defaultUom": "string",
  "typeId": 0,
  "hasListValues": true,
  "hasMultipleValues": true,
  "isVariantType": true,
  "isRequired": true,
  "isHidden": true,
  "isActive": true,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "code": "string",
  "codeListKey": "string",
  "isReadOnly": true,
  "editor": "string",
  "isFavorite": true,
  "isPublic": true,
  "groupId": 0,
  "defaultIsVariantUnique": true,
  "showOnTextTab": true,
  "showInList": true,
  "aiInstruction": "string",
  "group": {
    "id": 0,
    "clientId": 0,
    "defaultName": "string",
    "defaultDescription": "string",
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "code": "string",
    "parametrics": [ … ],
    "cultures": [ … ]
  },
  "cultures": [
    { … }
  ]
}

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations