COMMERCE QUERY

Query API 3.0

ProductCategory

Query (v1)

Download OpenAPI description

openapi.json

openapi.yaml

Servers

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

Schemas

ProductFlagCulture

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

descriptionstring or null[ 0 .. 500 ] characters

The culture specific description of the product 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(ProductFlag (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,
    "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": [ … ]
  }
}

ProductCategory

productIdinteger(int32)

The product identifier.

clientIdinteger(int32)

The client identifier.

categoryIdinteger(int32)

The category identifier.

isPrimaryboolean

Indicates whether the product category is primary, a product can only have one primary category.

sortOrderinteger or null(int32)

The sort order between categories.

productSortOrderinteger or null(int32)

The products sort order within the category.

isActiveboolean

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

category(Category (object or null))

One of:

product(Product (object or null))

One of:

{
  "productId": 0,
  "clientId": 0,
  "categoryId": 0,
  "isPrimary": true,
  "sortOrder": 0,
  "productSortOrder": 0,
  "isActive": true,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "category": {
    "id": 0,
    "clientId": 0,
    "code": "string",
    "defaultName": "string",
    "defaultDescription": "string",
    "defaultSynonyms": "string",
    "defaultImagePath": "string",
    "unspcCode": "string",
    "businessArea": "string",
    "defaultCommodityCode": "string",
    "defaultIntegrationPartNo": "string",
    "defaultTrackingCodeTypeId": 0,
    "freightClassId": 0,
    "defaultGrossWeight": 0,
    "defaultNetWeight": 0,
    "defaultUnitOfMeasurementId": 0,
    "defaultPackageId": 0,
    "defaultIsReturnable": true,
    "defaultIsDropShipOnly": true,
    "insuranceCurrencyId": 0,
    "insuranceStartPrice": 0,
    "insuranceRunningPercentage": 0,
    "populationRuleId": 0,
    "hideInTopList": true,
    "phoneNumber": "string",
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "competitivePricingMinPercentage": 0,
    "competitivePricingTargetPercentage": 0,
    "defaultVariantGroupId": 0,
    "defaultRecommendedSalesQty": 0,
    "imageKey": "string",
    "defaultFullName": "string",
    "structureSortOrder": 0,
    "defaultStockDisplayBreakPoint": 0,
    "defaultIsRecommendedSalesQtyFixed": true,
    "defaultIsRecurringOrderable": true,
    "cultures": [ … ],
    "categoryHierarchyCategory": [ … ],
    "categoryHierarchyParentCategory": [ … ],
    "parametrics": [ … ],
    "salesAreas": [ … ],
    "categoryStructureItem": [ … ],
    "productCategory": [ … ]
  },
  "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": { … }
  }
}

Category

idinteger(int32)

The unique identifier of the category.

clientIdinteger(int32)

The client identifier.

codestring or null[ 0 .. 50 ] characters

The code of the category.

defaultNamestring[ 0 .. 50 ] charactersrequired

The default name of the category.

defaultDescriptionstring or null

The default description of the category.

defaultSynonymsstring or null[ 0 .. 500 ] characters

The default synonyms.

defaultImagePathstring or null[ 0 .. 255 ] characters

The default image path, not used anymore.

unspcCodestring or null[ 0 .. 50 ] characters

The UNSPC code, can be overriden on product level.

businessAreastring or null[ 0 .. 50 ] characters

The business area.

defaultCommodityCodestring or null[ 0 .. 50 ] characters

The default commodity code, can be overriden on product level.

defaultIntegrationPartNostring or null[ 0 .. 50 ] characters

The default integration part number, can be overriden on product level.

defaultTrackingCodeTypeIdinteger or null(int32)

The default tracking code type identifier, not used anymore.

freightClassIdinteger or null(int32)

The freight class identifier, not used anymore.

defaultGrossWeightnumber or null(decimal)

The default gross weight, can be overriden on product level, called Actual Weight in the admin tool and in other API's.

defaultNetWeightnumber or null(decimal)

The default net weight, can be overriden on product level, not used anymore.

defaultUnitOfMeasurementIdinteger or null(int32)

The default unit of measurement identifier, can be overriden on product level.

defaultPackageIdinteger or null(int32)

The default package identifier, can be overriden on product level, not used anymore.

defaultIsReturnableboolean or null

Indicates whether returnable is enabled by default, can be overriden on product level, not commonly used.

defaultIsDropShipOnlyboolean or null

Indicates whether drop ship only is enabled by default, can be overriden on product level.

insuranceCurrencyIdinteger or null(int32)

The insurance currency identifier, not used anymore.

insuranceStartPricenumber or null(decimal)

The insurance start price, not used anymore.

insuranceRunningPercentagenumber or null(decimal)

The insurance running percentage, not used anymore.

populationRuleIdinteger(int32)

The population rule identifier, not used anymore.

hideInTopListboolean

Indicates whether hide in top list is enabled, can be overriden on product level, disables popularity ranking on the products in the category.

phoneNumberstring or null[ 0 .. 255 ] characters

The phone number.

isActiveboolean

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

competitivePricingMinPercentagenumber or null(decimal)

The competitive pricing min percentage.

competitivePricingTargetPercentagenumber or null(decimal)

The competitive pricing target percentage.

defaultVariantGroupIdinteger or null(int32)

The default variant group identifier, not used anymore.

defaultRecommendedSalesQtynumber or null(decimal)

The default recommended sales quantity, can be overriden on product level.

imageKeystring or null(guid)

The image key.

defaultFullNamestring or null[ 0 .. 500 ] characters

The default full name, automatically generated from the category hierarchy, like: RootName - BranchName - LeafName.

structureSortOrderinteger or null(int64)

The structure sort order, automatically generated sort order based on the category hierarchy.

defaultStockDisplayBreakPointinteger or null(int32)

The default stock display break point, can be overriden on product level.

defaultIsRecommendedSalesQtyFixedboolean or null

Indicates whether recommended sales qty fixed is enabled by default, can be overriden on product level.

defaultIsRecurringOrderableboolean or null

Indicates whether recurring orderable is enabled by default, can be overriden on product level, not commonly used.

culturesArray of objects or null(CategoryCulture)

categoryHierarchyCategoryArray of objects or null(CategoryHierarchy)

categoryHierarchyParentCategoryArray of objects or null(CategoryHierarchy)

parametricsArray of objects or null(CategoryParametric)

salesAreasArray of objects or null(CategorySalesArea)

categoryStructureItemArray of objects or null(CategoryStructureItem)

productCategoryArray of objects or null(ProductCategory)

{
  "id": 0,
  "clientId": 0,
  "code": "string",
  "defaultName": "string",
  "defaultDescription": "string",
  "defaultSynonyms": "string",
  "defaultImagePath": "string",
  "unspcCode": "string",
  "businessArea": "string",
  "defaultCommodityCode": "string",
  "defaultIntegrationPartNo": "string",
  "defaultTrackingCodeTypeId": 0,
  "freightClassId": 0,
  "defaultGrossWeight": 0,
  "defaultNetWeight": 0,
  "defaultUnitOfMeasurementId": 0,
  "defaultPackageId": 0,
  "defaultIsReturnable": true,
  "defaultIsDropShipOnly": true,
  "insuranceCurrencyId": 0,
  "insuranceStartPrice": 0,
  "insuranceRunningPercentage": 0,
  "populationRuleId": 0,
  "hideInTopList": true,
  "phoneNumber": "string",
  "isActive": true,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "competitivePricingMinPercentage": 0,
  "competitivePricingTargetPercentage": 0,
  "defaultVariantGroupId": 0,
  "defaultRecommendedSalesQty": 0,
  "imageKey": "string",
  "defaultFullName": "string",
  "structureSortOrder": 0,
  "defaultStockDisplayBreakPoint": 0,
  "defaultIsRecommendedSalesQtyFixed": true,
  "defaultIsRecurringOrderable": true,
  "cultures": [
    { … }
  ],
  "categoryHierarchyCategory": [
    { … }
  ],
  "categoryHierarchyParentCategory": [
    { … }
  ],
  "parametrics": [
    { … }
  ],
  "salesAreas": [
    { … }
  ],
  "categoryStructureItem": [
    { … }
  ],
  "productCategory": [
    { … }
  ]
}

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations