The Norce Management API lets you manage configurations and metadata on a client.
The Norce Management API lets you manage configurations and metadata on a client.
https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/
Application model, represents a storefront for end customers to visit and purchase from, configured with currencies, countries, cultures, sales areas, payment methods, shipping methods, products, and much more.
The base URL of the product catalog for the application, used together with a product unique identifier to get the product page from the shop. The allowed "wildcards" are {uniqueurl}, {productid} and {partno}, e.g. "https://demo.shop.com/products/{productId}", "https://demo.shop.com/products/{partNo}" or "https://demo.shop.com/products/{uniqueUrl}"
{ "Id": 0, "Key": "string", "Name": "string", "Description": "string", "HostClientId": 0, "Url": "string", "ProductUrl": "string", "IsActive": true, "Changed": "string", "ChangedBy": "string" }
Category model, represents a product category used to group products together in a hierarchy, with support for localized names and descriptions, default values for its products, vat codes (per sales area), and various other settings. The Category contains a list of CategoryCulture models for each localized properties.
If true, the specific language doesn't have its own name and instead inherits from the default name.
If true, the description is inherited from the default language rather than being its own text.
Concatenated category name based on hierarchy. Format: root category - branch category - leaf category (for three levels).
If true, the full name is inherited from the default language rather than being its own text.
The parent category's ID. Set this when placing a new category in the hierarchy.
Decides where the category is positioned relative to other categories at the same level under the same parent.
Image code from Norce image store for a category image. Not commonly used anymore.
Category code with string length of 50. Important to set and should be unique in the category tree.
Comma-separated list of phrases or words that can be indexed in the search functionality.
If true, the synonyms are inherited from the default language rather than being its own text.
Code field for storing global classification system according to UNSPSC standard.
Code field that can be used for business area classification.
External identifier for all products in the category. Optional field used to identify all products in one category in other systems.
Default VAT code for the current sales area (from the application) for all products in the category.
Explains where the VAT code is inherited from. Can be from the client setting or from the Norce default settings.
Different VAT codes for each sales area. If a client sales area is missing, the VAT code is inherited from client settings.
Default unit of measurement ID for all products in the category. Possible values: 1 (pcs), 2 (h), 3 (kg), 4 (l), 5 (pairs), 6 (sqm), 7 (m), 8 (boxes), 9 (rolls)
Default recommended sales quantity for all products in the category.
Default value indicating whether products in the category are returnable.
Default minimum margin on competitor pricing rules for products in the category. Should only be used if competitor pricing is activated.
Default target margin on competitor pricing rules for products in the category. Should only be used if competitor pricing is activated.
Availability threshold used for specific delivery promises at low stock levels.
Flag that forces Norce to set order quantities as multiples of the recommended sales quantity.
Flag marking products or whole categories as recurring products that can be bought in subscriptions.
False if the category is soft deleted, making it hidden and non-functional but easily reactivatable.
The name of the user who last changed the Category entity, null if never changed
{ "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": "string", "ImageUrl": "string", "Code": "string", "Synonyms": "string", "DefaultSynonyms": "string", "IsSynonymsInherited": true, "UnspcCode": "string", "BusinessArea": "string", "CommodityCode": "string", "IntegrationPartNo": "string", "FreightClassId": 0, "GrossWeight": 0, "VatCodeId": 0, "InheritedVatCodeId": 0, "IsVatCodeIdInherited": true, "InheritedVatCodeName": "string", "VatCodeIdInheritedFrom": "string", "VatCodeName": "string", "VatCodeValue": 0, "InheritedVatCodeValue": 0, "VatCodes": [ { … } ], "UnitOfMeasurementId": 0, "RecommendedSalesQty": 0, "IsReturnable": true, "IsDropShipOnly": true, "PopulationRuleId": 0, "TrackingCodeTypeId": 0, "CompetitivePricingMinPercentage": 0, "CompetitivePricingTargetPercentage": 0, "HideInTopList": true, "StockDisplayBreakPoint": 0, "IsRecommendedQtyFixed": true, "IsRecurringOrderable": true, "IsActive": true, "Changed": "string", "ChangedBy": "string", "Cultures": [ { … } ] }
Sales area VAT code model, used for displaying and managing VAT codes per sales area. Represents the relationship between sales areas and their associated VAT codes, including inheritance from default settings.
The VAT code identifier specifically configured for this sales area. If null, the inherited VAT code will be used
The VAT code identifier that is inherited from the sales area's default configuration
Indicates whether the VAT code is inherited from the default configuration rather than being explicitly set for this sales area
Describes the source from which the VAT code is inherited (e.g., "Application", "System")
The tax rate value as a decimal for the VAT code currently assigned to this sales area
The display name of the inherited VAT code that would be used if no specific VAT code is configured
{ "SalesAreaId": 0, "SalesAreaName": "string", "VatCodeId": 0, "InheritedVatCodeId": 0, "IsVatCodeIdInherited": true, "VatCodeIdInheritedFrom": "string", "VatCodeName": "string", "VatCodeValue": 0, "InheritedVatCodeName": "string", "InheritedVatCodeValue": 0 }