COMMERCE QUERY

Query API 3.0

CustomerFlagGroup

Query (v1)

Download OpenAPI description

openapi.json

openapi.yaml

Servers

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

Schemas

CustomerFlagCulture

flagIdinteger(int32)

The flag 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 customer flag.

descriptionstring or null[ 0 .. 500 ] characters

The culture specific description of the customer flag.

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.

flag(CustomerFlag (object or null))

One of:

{
  "flagId": 0,
  "cultureCode": "string",
  "name": "string",
  "description": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "clientId": 0,
  "flag": {
    "id": 0,
    "clientId": 0,
    "groupId": 0,
    "defaultName": "string",
    "defaultDescription": "string",
    "availableOnCustomer": true,
    "availableOnCompany": true,
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "isDefault": true,
    "externalReference": "string",
    "sortOrder": 0,
    "clientCompanyFlag": [ … ],
    "clientCustomerFlag": [ … ],
    "cultures": [ … ],
    "group": { … }
  }
}

CustomerFlagGroup

idinteger(int32)

The unique identifier of the customer flag group.

clientIdinteger(int32)

The client identifier.

defaultNamestring or null[ 0 .. 50 ] characters

The default name of the customer flag group.

defaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the customer flag group.

isMultipleChoiceboolean

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

customerFlagArray of objects or null(CustomerFlag)

culturesArray of objects or null(CustomerFlagGroupCulture)

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

CustomerFlagGroupCulture

groupIdinteger(int32)

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

descriptionstring or null[ 0 .. 500 ] characters

The culture specific description of the customer 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(CustomerFlagGroup (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,
    "defaultName": "string",
    "defaultDescription": "string",
    "isMultipleChoice": true,
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "customerFlag": [ … ],
    "cultures": [ … ]
  }
}

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations