COMMERCE QUERY

Query API 3.0

CategoryHierarchy

Query (v1)

Download OpenAPI description

openapi.json

openapi.yaml

Servers

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

Schemas

CategoryCulture

categoryIdinteger(int32)

The category 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 category.

descriptionstring or null

The culture specific description of the category.

synonymsstring or null[ 0 .. 500 ] characters

The culture specific synonyms of the category.

imagePathstring or null[ 0 .. 255 ] characters

The image path, not used anymore.

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.

fullNamestring or null[ 0 .. 500 ] characters

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

imageKeystring or null(guid)

The image key.

clientIdinteger or null(int32)

The client identifier.

category(Category (object or null))

One of:

{
  "categoryId": 0,
  "cultureCode": "string",
  "name": "string",
  "description": "string",
  "synonyms": "string",
  "imagePath": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "fullName": "string",
  "imageKey": "string",
  "clientId": 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": [ … ]
  }
}

CategoryHierarchy

categoryIdinteger(int32)

The category identifier.

clientIdinteger(int32)

The client identifier.

parentCategoryIdinteger(int32)

The parent category identifier.

hierarchyinteger(int32)

The hierarchy.

category(Category (object or null))

One of:

parentCategory(Category (object or null))

One of:

{
  "categoryId": 0,
  "clientId": 0,
  "parentCategoryId": 0,
  "hierarchy": 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": [ … ]
  },
  "parentCategory": {
    "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": [ … ]
  }
}

CategoryParametric

categoryIdinteger(int32)

The category identifier.

clientIdinteger(int32)

The client identifier.

parametricIdinteger(int32)

The parametric identifier.

groupIdinteger or null(int32)

The parametric group identifier.

sortOrderinteger or null(int32)

The sort order for display purposes.

focusSortOrderinteger or null(int32)

The focus sort order, focus is called filter in the admin tool.

isSecondaryboolean

Indicates whether the category parametric is secondary, not commonly used.

isRequiredboolean or null

Indicates whether the category parametric is required, overrides the parametric default.

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.

prioritySortOrderinteger or null(int32)

The priority sort order.

category(Category (object or null))

One of:

group(ParametricGroup (object or null))

One of:

parametric(Parametric (object or null))

One of:

{
  "categoryId": 0,
  "clientId": 0,
  "parametricId": 0,
  "groupId": 0,
  "sortOrder": 0,
  "focusSortOrder": 0,
  "isSecondary": true,
  "isRequired": true,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "prioritySortOrder": 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": [ … ]
  },
  "group": {
    "id": 0,
    "clientId": 0,
    "defaultName": "string",
    "defaultDescription": "string",
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "code": "string",
    "parametrics": [ … ],
    "parametric": [ … ],
    "cultures": [ … ]
  },
  "parametric": {
    "id": 0,
    "clientId": 0,
    "defaultName": "string",
    "defaultDescription": "string",
    "defaultUom": "string",
    "typeId": 0,
    "hasListValues": true,
    "hasMultipleValues": true,
    "isVariantType": true,
    "isRequired": true,
    "isHidden": true,
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "code": "string",
    "codeListKey": "string",
    "isReadOnly": true,
    "editor": "string",
    "isFavorite": true,
    "isPublic": true,
    "groupId": 0,
    "defaultIsVariantUnique": true,
    "showOnTextTab": true,
    "showInList": true,
    "categoryParametric": [ … ],
    "group": { … },
    "cultures": [ … ],
    "parametricList": [ … ],
    "parametricMultiple": [ … ],
    "productParametric": [ … ],
    "variantType": [ … ]
  }
}

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations