COMMERCE QUERY

Query API 3.0

ClientProductFlag

Query (v1)

Download OpenAPI description

openapi.json

openapi.yaml

Servers

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

Schemas

Product

idinteger(int32)

The unique identifier of the product.

clientIdinteger(int32)

The client identifier.

manufacturerIdinteger(int32)

The manufacturer identifier.

manufacturerPartNostring[ 0 .. 50 ] charactersrequired

The manufacturer part number.

defaultNamestring or null[ 0 .. 255 ] characters

The default name of the product.

defaultSubHeaderstring or null[ 0 .. 255 ] characters

The default sub header.

defaultSubDescriptionstring or null

The default sub description.

defaultDescriptionHeaderstring or null[ 0 .. 255 ] characters

The default description header.

defaultDescriptionstring or null

The default description of the product.

defaultImagePathstring or null[ 0 .. 255 ] characters

The default image path, not used anymore.

defaultThumbnailImagePathstring or null[ 0 .. 255 ] characters

The default thumbnail image path, not used anymore.

defaultCampaignImagePathstring or null[ 0 .. 255 ] characters

The default campaign image path, not used anymore.

defaultLargeImagePathstring or null[ 0 .. 255 ] characters

The default large image path, not used anymore.

defaultSynonymsstring or null[ 0 .. 500 ] characters

The default synonyms, commonly comma or blank space separated list of words.

sortOrderValueinteger or null(int32)

The sort order, not commonly used.

assortmentIdinteger or null(int32)

The assortment identifier, not commonly used.

assortmentLastUpdatedstring or null(date-time)

The assortment last updated, not commonly used.

assortmentLastUpdatedByinteger or null(int32)

The assortment last updated by, not commonly used.

isVariantboolean

Indicates whether the product is variant.

variantIdinteger or null(int32)

The variant identifier.

aliasstring or null[ 0 .. 255 ] characters

The alias, not commonly used.

defaultTitlestring or null[ 0 .. 255 ] characters

The default title, for SEO purposes.

defaultTagsstring or null

The default tags, not commonly used.

defaultMetaTagsstring or null

The default meta tags, for SEO purposes.

defaultMetaDescriptionstring or null

The default meta description, for SEO purposes.

hideInTopListboolean or null

Indicates whether product is hidden in rankings like popularity logic.

isActiveboolean

Indicates whether the product is active.

stoppedDatestring or null(date-time)

The stopped date, set automatically when the product is disabled or deactivated.

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.

insuranceCurrencyIdinteger or null(int32)

The insurance currency identifier, not commonly used.

insuranceStartPricenumber or null(decimal)

The insurance start price, not commonly used.

insuranceRunningPercentagenumber or null(decimal)

The insurance running percentage, not commonly used.

keystring(guid)

The key.

manufacturerPartNo2string or null[ 0 .. 50 ] characters

The manufacturer part no2, not commonly used.

imageKeystring or null(guid)

The image key.

defaultUniqueUrlNamestring[ 0 .. 500 ] charactersrequired

The default unique url name, a unique URL friendly name for the product, called UniqueName in the admin tool.

stockDisplayBreakPointinteger or null(int32)

The stock display break point, used for determining when to display stock information.

isDangerousGoodsboolean

Indicates whether the product is dangerous goods, used by shipping logic.

codestring or null[ 0 .. 50 ] characters

The common code for variants. All products with same code are considered variants of each other, if left out the product is considered standalone.

isRecurringOrderableboolean or null

Indicates whether the product is recurring orderable, not commonly used.

defaultExternalDescriptionstring or null

The default external description, not commonly used.

unspscCodestring or null[ 0 .. 50 ] characters

The unspsc code, overrides the value from the primary category.

translationRequestedstring or null(date-time)

Indicates if a 3rd party translation has been requested.

translationRequestedByinteger or null(int32)

The translation requested by.

defaultImageAltTextstring or null

The default image alt text.

flagsArray of objects or null(ClientProductFlag)

skusArray of objects or null(ClientProductSku)

categoriesArray of objects or null(ProductCategory)

culturesArray of objects or null(ProductCulture)

familiesArray of objects or null(ProductFamily)

filesArray of objects or null(ProductFile)

parametricsArray of objects or null(ProductParametric)

parametricMultipleArray of objects or null(ProductParametricMultiple)

productRelationsArray of objects or null(ProductRelation)

productRelationRelatedProductArray of objects or null(ProductRelation)

supplierSkusArray of objects or null(SupplierProductSkuClient)

variant(Variant (object or null))

One of:

{
  "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,
    "clientId": 0,
    "defaultName": "string",
    "defaultImagePath": "string",
    "defaultThumbnailImagePath": "string",
    "defaultCampaignImagePath": "string",
    "defaultLargeImagePath": "string",
    "groupId": 0,
    "alias": "string",
    "defaultTitle": "string",
    "defaultTags": "string",
    "defaultMetaTags": "string",
    "defaultMetaDescription": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "imageKey": "string",
    "code": "string",
    "defaultUniqueUrlName": "string",
    "key": "string",
    "defaultImageAltText": "string",
    "variantGroup": { … },
    "products": [ … ],
    "cultures": [ … ]
  }
}

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": {
    "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