COMMERCE QUERY

Query API 3.0

ClientProductFlag

Commerce Query API (v3.0)

Download OpenAPI description

openapi.json

openapi.yaml

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

ProductPopularity

product(Product (object or null))

One of:

idinteger(int32)

The unique identifier of the popularity rank of the product.

productIdinteger(int32)

The product identifier.

clientIdinteger(int32)

The client identifier.

applicationIdinteger or null(int32)

The application identifier, if the popularity is application-specific.

sourceIdinteger(int32)

The source identifier, not commonly used.

categoryRankinteger or null(int32)

The rank on its category.

categoryRankMaxinteger or null(int32)

The max rank value for the category.

totalRankinteger(int32)

The max total rank in the product catalog.

ratingnumber or null(decimal)

The rating of the product.

updatedstring(date-time)

The date and time the record was last updated.

updatedByinteger(int32)

The identifier of the user who last updated the record.

valuenumber or null(decimal)

The rank value for the product.

{
  "product": {
    "popularities": [ … ],
    "id": 0,
    "clientId": 0,
    "manufacturerId": 0,
    "manufacturerPartNo": "string",
    "defaultName": "string",
    "defaultSubHeader": "string",
    "defaultSubDescription": "string",
    "defaultDescriptionHeader": "string",
    "defaultDescription": "string",
    "defaultImagePath": "string",
    "defaultThumbnailImagePath": "string",
    "defaultCampaignImagePath": "string",
    "defaultLargeImagePath": "string",
    "defaultSynonyms": "string",
    "sortOrderValue": 0,
    "assortmentId": 0,
    "assortmentLastUpdated": "2019-08-24T14:15:22Z",
    "assortmentLastUpdatedBy": 0,
    "isVariant": true,
    "variantId": 0,
    "alias": "string",
    "defaultTitle": "string",
    "defaultTags": "string",
    "defaultMetaTags": "string",
    "defaultMetaDescription": "string",
    "hideInTopList": true,
    "isActive": true,
    "stoppedDate": "2019-08-24T14:15:22Z",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "insuranceCurrencyId": 0,
    "insuranceStartPrice": 0,
    "insuranceRunningPercentage": 0,
    "key": "string",
    "manufacturerPartNo2": "string",
    "imageKey": "string",
    "defaultUniqueUrlName": "string",
    "stockDisplayBreakPoint": 0,
    "isDangerousGoods": true,
    "code": "string",
    "isRecurringOrderable": true,
    "defaultExternalDescription": "string",
    "unspscCode": "string",
    "translationRequested": "2019-08-24T14:15:22Z",
    "translationRequestedBy": 0,
    "defaultImageAltText": "string",
    "flags": [ … ],
    "skus": [ … ],
    "categories": [ … ],
    "cultures": [ … ],
    "families": [ … ],
    "files": [ … ],
    "parametrics": [ … ],
    "parametricMultiple": [ … ],
    "productRelations": [ … ],
    "productRelationRelatedProduct": [ … ],
    "supplierSkus": [ … ],
    "variant": { … }
  },
  "id": 0,
  "productId": 0,
  "clientId": 0,
  "applicationId": 0,
  "sourceId": 0,
  "categoryRank": 0,
  "categoryRankMax": 0,
  "totalRank": 0,
  "rating": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "value": 0
}

ClientProductFlag

productIdinteger(int32)

The product identifier.

clientIdinteger(int32)

The client identifier.

flagIdinteger(int32)

The flag identifier.

isActiveboolean

Indicates whether the client product flag is active.

stoppedDatestring or null(date-time)

The stopped date.

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.

flag(ProductFlag (object or null))

One of:

product(Product (object or null))

One of:

{
  "productId": 0,
  "clientId": 0,
  "flagId": 0,
  "isActive": true,
  "stoppedDate": "2019-08-24T14:15:22Z",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "flag": {
    "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": { … },
    "cultures": [ … ]
  },
  "product": {
    "popularities": [ … ],
    "id": 0,
    "clientId": 0,
    "manufacturerId": 0,
    "manufacturerPartNo": "string",
    "defaultName": "string",
    "defaultSubHeader": "string",
    "defaultSubDescription": "string",
    "defaultDescriptionHeader": "string",
    "defaultDescription": "string",
    "defaultImagePath": "string",
    "defaultThumbnailImagePath": "string",
    "defaultCampaignImagePath": "string",
    "defaultLargeImagePath": "string",
    "defaultSynonyms": "string",
    "sortOrderValue": 0,
    "assortmentId": 0,
    "assortmentLastUpdated": "2019-08-24T14:15:22Z",
    "assortmentLastUpdatedBy": 0,
    "isVariant": true,
    "variantId": 0,
    "alias": "string",
    "defaultTitle": "string",
    "defaultTags": "string",
    "defaultMetaTags": "string",
    "defaultMetaDescription": "string",
    "hideInTopList": true,
    "isActive": true,
    "stoppedDate": "2019-08-24T14:15:22Z",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "insuranceCurrencyId": 0,
    "insuranceStartPrice": 0,
    "insuranceRunningPercentage": 0,
    "key": "string",
    "manufacturerPartNo2": "string",
    "imageKey": "string",
    "defaultUniqueUrlName": "string",
    "stockDisplayBreakPoint": 0,
    "isDangerousGoods": true,
    "code": "string",
    "isRecurringOrderable": true,
    "defaultExternalDescription": "string",
    "unspscCode": "string",
    "translationRequested": "2019-08-24T14:15:22Z",
    "translationRequestedBy": 0,
    "defaultImageAltText": "string",
    "flags": [ … ],
    "skus": [ … ],
    "categories": [ … ],
    "cultures": [ … ],
    "families": [ … ],
    "files": [ … ],
    "parametrics": [ … ],
    "parametricMultiple": [ … ],
    "productRelations": [ … ],
    "productRelationRelatedProduct": [ … ],
    "supplierSkus": [ … ],
    "variant": { … }
  }
}

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": [
    { … }
  ]
}

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations