COMMERCE QUERY

Query API 3.0

ProductFlagGroup

Query (v1)

Download OpenAPI description

openapi.json

openapi.yaml

Servers

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

Schemas

ProductFlag

idinteger(int32)

The unique identifier of the product flag.

clientIdinteger(int32)

The client identifier.

typeIdinteger(int32)

The type identifier.

groupIdinteger(int32)

The group identifier.

defaultNamestring[ 0 .. 50 ] charactersrequired

The default name of the product flag.

defaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the product flag.

isManuallyEditableboolean

Indicates whether the product flag is manually editable, if false, the flag is read-only in the admin tool.

sortOrderinteger or null(int32)

The sort order for display purposes.

isActiveboolean

Indicates whether the product flag 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 product flag.

clientProductFlagArray of objects or null(ClientProductFlag)

group(ProductFlagGroup (object or null))

One of:

culturesArray of objects or null(ProductFlagCulture)

{
  "id": 0,
  "clientId": 0,
  "typeId": 0,
  "groupId": 0,
  "defaultName": "string",
  "defaultDescription": "string",
  "isManuallyEditable": true,
  "sortOrder": 0,
  "isActive": true,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "code": "string",
  "clientProductFlag": [
    { … }
  ],
  "group": {
    "id": 0,
    "clientId": 0,
    "code": "string",
    "defaultName": "string",
    "defaultDescription": "string",
    "isMultipleChoice": true,
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "isDisplay": true,
    "isFavorite": true,
    "productFlag": [ … ],
    "cultures": [ … ]
  },
  "cultures": [
    { … }
  ]
}

ProductFlagGroup

idinteger(int32)

The unique identifier of the product flag group.

clientIdinteger(int32)

The client identifier.

codestring or null[ 0 .. 50 ] characters

The code of the product flag group.

defaultNamestring[ 0 .. 50 ] charactersrequired

The default name of the product flag group.

defaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the product flag group.

isMultipleChoiceboolean

Indicates whether the product flag group is multiple choice, if true, multiple flags can be selected from the same group, otherwise any flag already set will be cleared automatically when setting a new flag in the same group.

isActiveboolean

Indicates whether the product flag 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.

isDisplayboolean

Indicates whether the product flag group is marked for being visible, not commonly used.

isFavoriteboolean

Indicates whether the product flag group is marked as favorite, used in the admin tool.

productFlagArray of objects or null(ProductFlag)

culturesArray of objects or null(ProductFlagGroupCulture)

{
  "id": 0,
  "clientId": 0,
  "code": "string",
  "defaultName": "string",
  "defaultDescription": "string",
  "isMultipleChoice": true,
  "isActive": true,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "isDisplay": true,
  "isFavorite": true,
  "productFlag": [
    { … }
  ],
  "cultures": [
    { … }
  ]
}

ProductFlagGroupCulture

groupIdinteger(int32)

The flag group 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 product flag group.

descriptionstring or null[ 0 .. 500 ] characters

The culture specific description of the product flag group.

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(ProductFlagGroup (object or null))

One of:

{
  "groupId": 0,
  "cultureCode": "string",
  "name": "string",
  "description": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "clientId": 0,
  "group": {
    "id": 0,
    "clientId": 0,
    "code": "string",
    "defaultName": "string",
    "defaultDescription": "string",
    "isMultipleChoice": true,
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "isDisplay": true,
    "isFavorite": true,
    "productFlag": [ … ],
    "cultures": [ … ]
  }
}

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations