COMMERCE QUERY

Query API 3.0

VariantType

Query (v1)

Download OpenAPI description

openapi.json

openapi.yaml

Servers

https://norcecommerce.api-se.norce.tech/commerce/query/3.0/

Schemas

ParametricMultipleCulture

multipleIdinteger(int32)

The multiple item identifier.

cultureCodestring or null[ 0 .. 16 ] characters

The culture code (e.g. en-US).

valuestring or null[ 0 .. 255 ] characters

The culture specific value.

descriptionstring or null

The culture specific description of the multiple item.

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.

clientIdinteger or null(int32)

The client identifier.

multiple(ParametricMultiple (object or null))

One of:

{
  "multipleId": 0,
  "cultureCode": "string",
  "value": "string",
  "description": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "clientId": 0,
  "multiple": {
    "id": 0,
    "parametricId": 0,
    "defaultValue": "string",
    "defaultDescription": "string",
    "sortOrder": 0,
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "code": "string",
    "imageKey": "string",
    "imagePath": "string",
    "clientId": 0,
    "parametric": { … },
    "cultures": [ … ],
    "productParametricMultiple": [ … ]
  }
}

VariantType

idinteger(int32)

The unique identifier of the variant type.

clientIdinteger(int32)

The client identifier.

defaultNamestring[ 0 .. 50 ] charactersrequired

The default name of the variant type.

defaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the variant type.

parametricIdinteger or null(int32)

The parametric identifier.

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 variant type. Should be same as the parametric code if ParametricId is set.

parametric(Parametric (object or null))

One of:

variantGroupTypeArray of objects or null(VariantGroupType)

culturesArray of objects or null(VariantTypeCulture)

{
  "id": 0,
  "clientId": 0,
  "defaultName": "string",
  "defaultDescription": "string",
  "parametricId": 0,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "code": "string",
  "parametric": {
    "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,
    "categoryParametric": [ … ],
    "group": { … },
    "cultures": [ … ],
    "parametricList": [ … ],
    "parametricMultiple": [ … ],
    "productParametric": [ … ],
    "variantType": [ … ]
  },
  "variantGroupType": [
    { … }
  ],
  "cultures": [
    { … }
  ]
}

VariantGroupType

groupIdinteger(int32)

The group identifier.

typeIdinteger(int32)

The type identifier.

sortOrderinteger(int32)

The sort order for display purposes.

isActiveboolean

Indicates whether the variant group type 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.

clientIdinteger or null(int32)

The client identifier.

group(VariantGroup (object or null))

One of:

type(VariantType (object or null))

One of:

{
  "groupId": 0,
  "typeId": 0,
  "sortOrder": 0,
  "isActive": true,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "clientId": 0,
  "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",
    "variant": [ … ],
    "cultures": [ … ],
    "groupTypes": [ … ]
  },
  "type": {
    "id": 0,
    "clientId": 0,
    "defaultName": "string",
    "defaultDescription": "string",
    "parametricId": 0,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "code": "string",
    "parametric": { … },
    "variantGroupType": [ … ],
    "cultures": [ … ]
  }
}

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations