MANAGEMENT API (PREVIEW)
/
Category
/
List categories in compact format

Norce Management API (v1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/

Category

Operations

Get category

Request

Path
idinteger(int32)required

Category id

curl -i -X GET \
  'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/category/{id}'

Responses

OK

Body
Idinteger(int32)
Namestring
DefaultNamestring
IsNameInheritedboolean
Descriptionstring
DefaultDescriptionstring
IsDescriptionInheritedboolean
FullNamestring
DefaultFullNamestring
IsFullNameInheritedboolean
ParentIdinteger(int32)
ParentCodestring
ParentNamestring
SortOrderinteger(int32)
IsDisplayOnlyboolean
ImageKeystring(uuid)
Example: "00000000-0000-0000-0000-000000000000"
ImageUrlstring
Codestring
Synonymsstring
DefaultSynonymsstring
IsSynonymsInheritedboolean
UnspcCodestring
BusinessAreastring
CommodityCodestring
IntegrationPartNostring
FreightClassIdinteger(int32)
GrossWeightnumber(double)
VatCodeIdinteger(int32)
InheritedVatCodeIdinteger(int32)
IsVatCodeIdInheritedboolean
InheritedVatCodeNamestring
VatCodeIdInheritedFromstring
VatCodeNamestring
VatCodeValuenumber(double)
InheritedVatCodeValuenumber(double)
VatCodesArray of objects(SalesAreaVatCodeModel)
UnitOfMeasurementIdinteger(int32)
RecommendedSalesQtynumber(double)
IsReturnableboolean
IsDropShipOnlyboolean
PopulationRuleIdinteger(int32)
TrackingCodeTypeIdinteger(int32)
CompetitivePricingMinPercentagenumber(double)
CompetitivePricingTargetPercentagenumber(double)
HideInTopListboolean
StockDisplayBreakPointinteger(int32)
IsRecommendedQtyFixedboolean
IsRecurringOrderableboolean
IsActiveboolean
Changedstring
ChangedBystring
CulturesArray of objects(CategoryCultureModel)
Response
{
  "Id": 0,
  "Name": "string",
  "DefaultName": "string",
  "IsNameInherited": true,
  "Description": "string",
  "DefaultDescription": "string",
  "IsDescriptionInherited": true,
  "FullName": "string",
  "DefaultFullName": "string",
  "IsFullNameInherited": true,
  "ParentId": 0,
  "ParentCode": "string",
  "ParentName": "string",
  "SortOrder": 0,
  "IsDisplayOnly": true,
  "ImageKey": "00000000-0000-0000-0000-000000000000",
  "ImageUrl": "string",
  "Code": "string",
  "Synonyms": "string",
  "DefaultSynonyms": "string",
  "IsSynonymsInherited": true,
  "UnspcCode": "string",
  "BusinessArea": "string",
  "CommodityCode": "string",
  "IntegrationPartNo": "string",
  "FreightClassId": 0,
  "GrossWeight": 0.1,
  "VatCodeId": 0,
  "InheritedVatCodeId": 0,
  "IsVatCodeIdInherited": true,
  "InheritedVatCodeName": "string",
  "VatCodeIdInheritedFrom": "string",
  "VatCodeName": "string",
  "VatCodeValue": 0.1,
  "InheritedVatCodeValue": 0.1,
  "VatCodes": [
    { … }
  ],
  "UnitOfMeasurementId": 0,
  "RecommendedSalesQty": 0.1,
  "IsReturnable": true,
  "IsDropShipOnly": true,
  "PopulationRuleId": 0,
  "TrackingCodeTypeId": 0,
  "CompetitivePricingMinPercentage": 0.1,
  "CompetitivePricingTargetPercentage": 0.1,
  "HideInTopList": true,
  "StockDisplayBreakPoint": 0,
  "IsRecommendedQtyFixed": true,
  "IsRecurringOrderable": true,
  "IsActive": true,
  "Changed": "string",
  "ChangedBy": "string",
  "Cultures": [
    { … }
  ]
}

Update category

Request

Path
idinteger(int32)required

Category id

Body
required

Model to update

Idinteger(int32)
Namestring
DefaultNamestring
IsNameInheritedboolean
Descriptionstring
DefaultDescriptionstring
IsDescriptionInheritedboolean
FullNamestring
DefaultFullNamestring
IsFullNameInheritedboolean
ParentIdinteger(int32)
ParentCodestring
ParentNamestring
SortOrderinteger(int32)
IsDisplayOnlyboolean
ImageKeystring(uuid)
Example: "00000000-0000-0000-0000-000000000000"
ImageUrlstring
Codestring
Synonymsstring
DefaultSynonymsstring
IsSynonymsInheritedboolean
UnspcCodestring
BusinessAreastring
CommodityCodestring
IntegrationPartNostring
FreightClassIdinteger(int32)
GrossWeightnumber(double)
VatCodeIdinteger(int32)
InheritedVatCodeIdinteger(int32)
IsVatCodeIdInheritedboolean
InheritedVatCodeNamestring
VatCodeIdInheritedFromstring
VatCodeNamestring
VatCodeValuenumber(double)
InheritedVatCodeValuenumber(double)
VatCodesArray of objects(SalesAreaVatCodeModel)
UnitOfMeasurementIdinteger(int32)
RecommendedSalesQtynumber(double)
IsReturnableboolean
IsDropShipOnlyboolean
PopulationRuleIdinteger(int32)
TrackingCodeTypeIdinteger(int32)
CompetitivePricingMinPercentagenumber(double)
CompetitivePricingTargetPercentagenumber(double)
HideInTopListboolean
StockDisplayBreakPointinteger(int32)
IsRecommendedQtyFixedboolean
IsRecurringOrderableboolean
IsActiveboolean
Changedstring
ChangedBystring
CulturesArray of objects(CategoryCultureModel)
curl -i -X PUT \
  'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/category/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "Id": 0,
    "Name": "string",
    "DefaultName": "string",
    "IsNameInherited": true,
    "Description": "string",
    "DefaultDescription": "string",
    "IsDescriptionInherited": true,
    "FullName": "string",
    "DefaultFullName": "string",
    "IsFullNameInherited": true,
    "ParentId": 0,
    "ParentCode": "string",
    "ParentName": "string",
    "SortOrder": 0,
    "IsDisplayOnly": true,
    "ImageKey": "00000000-0000-0000-0000-000000000000",
    "ImageUrl": "string",
    "Code": "string",
    "Synonyms": "string",
    "DefaultSynonyms": "string",
    "IsSynonymsInherited": true,
    "UnspcCode": "string",
    "BusinessArea": "string",
    "CommodityCode": "string",
    "IntegrationPartNo": "string",
    "FreightClassId": 0,
    "GrossWeight": 0.1,
    "VatCodeId": 0,
    "InheritedVatCodeId": 0,
    "IsVatCodeIdInherited": true,
    "InheritedVatCodeName": "string",
    "VatCodeIdInheritedFrom": "string",
    "VatCodeName": "string",
    "VatCodeValue": 0.1,
    "InheritedVatCodeValue": 0.1,
    "VatCodes": [
      {
        "SalesAreaId": 0,
        "SalesAreaName": "string",
        "VatCodeId": 0,
        "InheritedVatCodeId": 0,
        "IsVatCodeIdInherited": true,
        "VatCodeIdInheritedFrom": "string",
        "VatCodeName": "string",
        "VatCodeValue": 0.1,
        "InheritedVatCodeName": "string",
        "InheritedVatCodeValue": 0.1
      }
    ],
    "UnitOfMeasurementId": 0,
    "RecommendedSalesQty": 0.1,
    "IsReturnable": true,
    "IsDropShipOnly": true,
    "PopulationRuleId": 0,
    "TrackingCodeTypeId": 0,
    "CompetitivePricingMinPercentage": 0.1,
    "CompetitivePricingTargetPercentage": 0.1,
    "HideInTopList": true,
    "StockDisplayBreakPoint": 0,
    "IsRecommendedQtyFixed": true,
    "IsRecurringOrderable": true,
    "IsActive": true,
    "Changed": "string",
    "ChangedBy": "string",
    "Cultures": [
      {
        "CultureCode": "string",
        "Name": "string",
        "IsNameInherited": true,
        "Description": "string",
        "IsDescriptionInherited": true,
        "Synonyms": "string",
        "IsSynonymsInherited": true,
        "FullName": "string",
        "IsFullNameInherited": true,
        "IsTranslated": true
      }
    ]
  }'

Responses

OK

Body
object
Response
{}

List categories

Request

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/category

Responses

OK

Body
Array [
Idinteger(int32)
Namestring
DefaultNamestring
IsNameInheritedboolean
Descriptionstring
DefaultDescriptionstring
IsDescriptionInheritedboolean
FullNamestring
DefaultFullNamestring
IsFullNameInheritedboolean
ParentIdinteger(int32)
ParentCodestring
ParentNamestring
SortOrderinteger(int32)
IsDisplayOnlyboolean
ImageKeystring(uuid)
Example: "00000000-0000-0000-0000-000000000000"
ImageUrlstring
Codestring
Synonymsstring
DefaultSynonymsstring
IsSynonymsInheritedboolean
UnspcCodestring
BusinessAreastring
CommodityCodestring
IntegrationPartNostring
FreightClassIdinteger(int32)
GrossWeightnumber(double)
VatCodeIdinteger(int32)
InheritedVatCodeIdinteger(int32)
IsVatCodeIdInheritedboolean
InheritedVatCodeNamestring
VatCodeIdInheritedFromstring
VatCodeNamestring
VatCodeValuenumber(double)
InheritedVatCodeValuenumber(double)
VatCodesArray of objects(SalesAreaVatCodeModel)
UnitOfMeasurementIdinteger(int32)
RecommendedSalesQtynumber(double)
IsReturnableboolean
IsDropShipOnlyboolean
PopulationRuleIdinteger(int32)
TrackingCodeTypeIdinteger(int32)
CompetitivePricingMinPercentagenumber(double)
CompetitivePricingTargetPercentagenumber(double)
HideInTopListboolean
StockDisplayBreakPointinteger(int32)
IsRecommendedQtyFixedboolean
IsRecurringOrderableboolean
IsActiveboolean
Changedstring
ChangedBystring
CulturesArray of objects(CategoryCultureModel)
]
Response
[
  {
    "Id": 0,
    "Name": "string",
    "DefaultName": "string",
    "IsNameInherited": true,
    "Description": "string",
    "DefaultDescription": "string",
    "IsDescriptionInherited": true,
    "FullName": "string",
    "DefaultFullName": "string",
    "IsFullNameInherited": true,
    "ParentId": 0,
    "ParentCode": "string",
    "ParentName": "string",
    "SortOrder": 0,
    "IsDisplayOnly": true,
    "ImageKey": "00000000-0000-0000-0000-000000000000",
    "ImageUrl": "string",
    "Code": "string",
    "Synonyms": "string",
    "DefaultSynonyms": "string",
    "IsSynonymsInherited": true,
    "UnspcCode": "string",
    "BusinessArea": "string",
    "CommodityCode": "string",
    "IntegrationPartNo": "string",
    "FreightClassId": 0,
    "GrossWeight": 0.1,
    "VatCodeId": 0,
    "InheritedVatCodeId": 0,
    "IsVatCodeIdInherited": true,
    "InheritedVatCodeName": "string",
    "VatCodeIdInheritedFrom": "string",
    "VatCodeName": "string",
    "VatCodeValue": 0.1,
    "InheritedVatCodeValue": 0.1,
    "VatCodes": [ … ],
    "UnitOfMeasurementId": 0,
    "RecommendedSalesQty": 0.1,
    "IsReturnable": true,
    "IsDropShipOnly": true,
    "PopulationRuleId": 0,
    "TrackingCodeTypeId": 0,
    "CompetitivePricingMinPercentage": 0.1,
    "CompetitivePricingTargetPercentage": 0.1,
    "HideInTopList": true,
    "StockDisplayBreakPoint": 0,
    "IsRecommendedQtyFixed": true,
    "IsRecurringOrderable": true,
    "IsActive": true,
    "Changed": "string",
    "ChangedBy": "string",
    "Cultures": [ … ]
  }
]

Insert category

Request

Body
required

Model to add

Idinteger(int32)
Namestring
DefaultNamestring
IsNameInheritedboolean
Descriptionstring
DefaultDescriptionstring
IsDescriptionInheritedboolean
FullNamestring
DefaultFullNamestring
IsFullNameInheritedboolean
ParentIdinteger(int32)
ParentCodestring
ParentNamestring
SortOrderinteger(int32)
IsDisplayOnlyboolean
ImageKeystring(uuid)
Example: "00000000-0000-0000-0000-000000000000"
ImageUrlstring
Codestring
Synonymsstring
DefaultSynonymsstring
IsSynonymsInheritedboolean
UnspcCodestring
BusinessAreastring
CommodityCodestring
IntegrationPartNostring
FreightClassIdinteger(int32)
GrossWeightnumber(double)
VatCodeIdinteger(int32)
InheritedVatCodeIdinteger(int32)
IsVatCodeIdInheritedboolean
InheritedVatCodeNamestring
VatCodeIdInheritedFromstring
VatCodeNamestring
VatCodeValuenumber(double)
InheritedVatCodeValuenumber(double)
VatCodesArray of objects(SalesAreaVatCodeModel)
UnitOfMeasurementIdinteger(int32)
RecommendedSalesQtynumber(double)
IsReturnableboolean
IsDropShipOnlyboolean
PopulationRuleIdinteger(int32)
TrackingCodeTypeIdinteger(int32)
CompetitivePricingMinPercentagenumber(double)
CompetitivePricingTargetPercentagenumber(double)
HideInTopListboolean
StockDisplayBreakPointinteger(int32)
IsRecommendedQtyFixedboolean
IsRecurringOrderableboolean
IsActiveboolean
Changedstring
ChangedBystring
CulturesArray of objects(CategoryCultureModel)
curl -i -X POST \
  https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/category \
  -H 'Content-Type: application/json' \
  -d '{
    "Id": 0,
    "Name": "string",
    "DefaultName": "string",
    "IsNameInherited": true,
    "Description": "string",
    "DefaultDescription": "string",
    "IsDescriptionInherited": true,
    "FullName": "string",
    "DefaultFullName": "string",
    "IsFullNameInherited": true,
    "ParentId": 0,
    "ParentCode": "string",
    "ParentName": "string",
    "SortOrder": 0,
    "IsDisplayOnly": true,
    "ImageKey": "00000000-0000-0000-0000-000000000000",
    "ImageUrl": "string",
    "Code": "string",
    "Synonyms": "string",
    "DefaultSynonyms": "string",
    "IsSynonymsInherited": true,
    "UnspcCode": "string",
    "BusinessArea": "string",
    "CommodityCode": "string",
    "IntegrationPartNo": "string",
    "FreightClassId": 0,
    "GrossWeight": 0.1,
    "VatCodeId": 0,
    "InheritedVatCodeId": 0,
    "IsVatCodeIdInherited": true,
    "InheritedVatCodeName": "string",
    "VatCodeIdInheritedFrom": "string",
    "VatCodeName": "string",
    "VatCodeValue": 0.1,
    "InheritedVatCodeValue": 0.1,
    "VatCodes": [
      {
        "SalesAreaId": 0,
        "SalesAreaName": "string",
        "VatCodeId": 0,
        "InheritedVatCodeId": 0,
        "IsVatCodeIdInherited": true,
        "VatCodeIdInheritedFrom": "string",
        "VatCodeName": "string",
        "VatCodeValue": 0.1,
        "InheritedVatCodeName": "string",
        "InheritedVatCodeValue": 0.1
      }
    ],
    "UnitOfMeasurementId": 0,
    "RecommendedSalesQty": 0.1,
    "IsReturnable": true,
    "IsDropShipOnly": true,
    "PopulationRuleId": 0,
    "TrackingCodeTypeId": 0,
    "CompetitivePricingMinPercentage": 0.1,
    "CompetitivePricingTargetPercentage": 0.1,
    "HideInTopList": true,
    "StockDisplayBreakPoint": 0,
    "IsRecommendedQtyFixed": true,
    "IsRecurringOrderable": true,
    "IsActive": true,
    "Changed": "string",
    "ChangedBy": "string",
    "Cultures": [
      {
        "CultureCode": "string",
        "Name": "string",
        "IsNameInherited": true,
        "Description": "string",
        "IsDescriptionInherited": true,
        "Synonyms": "string",
        "IsSynonymsInherited": true,
        "FullName": "string",
        "IsFullNameInherited": true,
        "IsTranslated": true
      }
    ]
  }'

Responses

OK

Body
object
Response
{}

List categories in compact format

Request

Query
searchstring
hasCodeboolean
isActiveboolean
curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/category/compact

Responses

OK

Body
Array [
Idinteger(int32)
Namestring
Codestring
]
Response
[
  {
    "Id": 0,
    "Name": "string",
    "Code": "string"
  }
]

List deleted categories

Request

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/category/deleted

Responses

OK

Body
Array [
Idinteger(int32)
Namestring
DefaultNamestring
IsNameInheritedboolean
Descriptionstring
DefaultDescriptionstring
IsDescriptionInheritedboolean
FullNamestring
DefaultFullNamestring
IsFullNameInheritedboolean
ParentIdinteger(int32)
ParentCodestring
ParentNamestring
SortOrderinteger(int32)
IsDisplayOnlyboolean
ImageKeystring(uuid)
Example: "00000000-0000-0000-0000-000000000000"
ImageUrlstring
Codestring
Synonymsstring
DefaultSynonymsstring
IsSynonymsInheritedboolean
UnspcCodestring
BusinessAreastring
CommodityCodestring
IntegrationPartNostring
FreightClassIdinteger(int32)
GrossWeightnumber(double)
VatCodeIdinteger(int32)
InheritedVatCodeIdinteger(int32)
IsVatCodeIdInheritedboolean
InheritedVatCodeNamestring
VatCodeIdInheritedFromstring
VatCodeNamestring
VatCodeValuenumber(double)
InheritedVatCodeValuenumber(double)
VatCodesArray of objects(SalesAreaVatCodeModel)
UnitOfMeasurementIdinteger(int32)
RecommendedSalesQtynumber(double)
IsReturnableboolean
IsDropShipOnlyboolean
PopulationRuleIdinteger(int32)
TrackingCodeTypeIdinteger(int32)
CompetitivePricingMinPercentagenumber(double)
CompetitivePricingTargetPercentagenumber(double)
HideInTopListboolean
StockDisplayBreakPointinteger(int32)
IsRecommendedQtyFixedboolean
IsRecurringOrderableboolean
IsActiveboolean
Changedstring
ChangedBystring
CulturesArray of objects(CategoryCultureModel)
]
Response
[
  {
    "Id": 0,
    "Name": "string",
    "DefaultName": "string",
    "IsNameInherited": true,
    "Description": "string",
    "DefaultDescription": "string",
    "IsDescriptionInherited": true,
    "FullName": "string",
    "DefaultFullName": "string",
    "IsFullNameInherited": true,
    "ParentId": 0,
    "ParentCode": "string",
    "ParentName": "string",
    "SortOrder": 0,
    "IsDisplayOnly": true,
    "ImageKey": "00000000-0000-0000-0000-000000000000",
    "ImageUrl": "string",
    "Code": "string",
    "Synonyms": "string",
    "DefaultSynonyms": "string",
    "IsSynonymsInherited": true,
    "UnspcCode": "string",
    "BusinessArea": "string",
    "CommodityCode": "string",
    "IntegrationPartNo": "string",
    "FreightClassId": 0,
    "GrossWeight": 0.1,
    "VatCodeId": 0,
    "InheritedVatCodeId": 0,
    "IsVatCodeIdInherited": true,
    "InheritedVatCodeName": "string",
    "VatCodeIdInheritedFrom": "string",
    "VatCodeName": "string",
    "VatCodeValue": 0.1,
    "InheritedVatCodeValue": 0.1,
    "VatCodes": [ … ],
    "UnitOfMeasurementId": 0,
    "RecommendedSalesQty": 0.1,
    "IsReturnable": true,
    "IsDropShipOnly": true,
    "PopulationRuleId": 0,
    "TrackingCodeTypeId": 0,
    "CompetitivePricingMinPercentage": 0.1,
    "CompetitivePricingTargetPercentage": 0.1,
    "HideInTopList": true,
    "StockDisplayBreakPoint": 0,
    "IsRecommendedQtyFixed": true,
    "IsRecurringOrderable": true,
    "IsActive": true,
    "Changed": "string",
    "ChangedBy": "string",
    "Cultures": [ … ]
  }
]

Category Parametric

Operations

Customer Flag

Operations

Customer FlagGroup

Operations

Customer InfoType

Operations

Parametric

Operations

Parametric Group

Operations

Parametric List

Operations

Parametric Multiple

Operations

PriceList

Operations

PriceList Population

Operations

PriceList Pricing

Operations

PriceList SupplierPricelist

Operations

PriceList Warehouse

Operations

Product Family

Operations

Product File

Operations

Product Flag

Operations

Product FlagGroup

Operations

Product InfoType

Operations

Product Manufacturer

Operations

Product RelationType

Operations

Product Type

Operations

Product VariantGroup

Operations

Product Warehouse

Operations

Product WarehouseLocation

Operations

Promotion

Operations

Settings Application

Operations

Settings ApplicationCountry

Operations

Settings ApplicationCulture

Operations

Settings ApplicationCurrency

Operations

Settings ApplicationSalesArea

Operations

Settings ClientAssortment

Operations

Settings ClientCurrency

Operations

Settings ClientSalesArea

Operations

Shopping InfoType

Operations

Store

Operations

Store Application

Operations

Store PriceList

Operations

Store Warehouse

Operations

Supplier

Operations

Supplier PriceList

Operations

Supplier PriceListWarehouse

Operations

Supplier Warehouse

Operations

Supplier WarehouseLocation

Operations