COMMERCE QUERY

Query API 3.0

ParametricList

Query (v1)

Download OpenAPI description

openapi.json

openapi.yaml

Servers

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

Schemas

ParametricCulture

parametricIdinteger(int32)

The parametric identifier.

cultureCodestring or null[ 0 .. 16 ] characters

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

namestring or null[ 0 .. 50 ] characters

The culture specific name of the parametric.

descriptionstring or null[ 0 .. 500 ] characters

The culture specific description of the parametric.

uomstring or null[ 0 .. 50 ] characters

The culture specific unit of measure.

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.

parametric(Parametric (object or null))

One of:

{
  "parametricId": 0,
  "cultureCode": "string",
  "name": "string",
  "description": "string",
  "uom": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "clientId": 0,
  "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": [ … ]
  }
}

ParametricList

idinteger(int32)

The unique identifier of the list item.

parametricIdinteger(int32)

The parametric identifier.

defaultVarcharValuestring[ 0 .. 255 ] charactersrequired

The default varchar value.

defaultDescriptionstring or null

The default description of the parametric list item.

sortOrderinteger or null(int32)

The sort order for display purposes.

isActiveboolean

Indicates whether the parametric list 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 list item.

imageKeystring or null(guid)

The image key.

imagePathstring or null[ 0 .. 255 ] characters

The image path, not used anymore.

clientIdinteger or null(int32)

The client identifier.

parametric(Parametric (object or null))

One of:

culturesArray of objects or null(ParametricListCulture)

productParametricArray of objects or null(ProductParametric)

{
  "id": 0,
  "parametricId": 0,
  "defaultVarcharValue": "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": {
    "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": [ … ]
  },
  "cultures": [
    { … }
  ],
  "productParametric": [
    { … }
  ]
}

ParametricListCulture

listIdinteger(int32)

The list item identifier.

cultureCodestring or null[ 0 .. 16 ] characters

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

varcharValuestring or null[ 0 .. 255 ] characters

The culture specific varchar value.

descriptionstring or null

The culture specific description of the parametric list 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.

list(ParametricList (object or null))

One of:

{
  "listId": 0,
  "cultureCode": "string",
  "varcharValue": "string",
  "description": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "clientId": 0,
  "list": {
    "id": 0,
    "parametricId": 0,
    "defaultVarcharValue": "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": [ … ],
    "productParametric": [ … ]
  }
}

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations