Management API (v1)

The Norce Management API lets you manage configurations and metadata on a client.

Download OpenAPI description
Languages
Servers

https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/

Schemas

Settings ApplicationCountry

Operations

Settings ApplicationCulture

Operations

Settings ApplicationCurrency

Operations

Settings ApplicationSalesArea

Operations

Settings Application

Operations

Category

Operations

CategoryParametric

Operations

Settings ClientAssortment

Operations

Settings ClientCurrency

Operations

Settings ClientSalesArea

Operations

Customer FlagGroup

Operations

Customer Flag

Operations

Customer InfoType

Operations

Product Family

Operations

Product File

Operations

Product Manufacturer

Operations

Parametric Group

Operations

Parametric List

Operations

Parametric Multiple

Operations

Parametric

Operations

Get a parametric

Request

Get a specific parametric by its internal Id

Path
idinteger(int32)required

Parametric id

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

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

Responses

Returns the Parametric

Bodyapplication/json
Idinteger(int32)

Internal identifier for the parametric. Client-specific.

Namestring or null[ 0 .. 50 ] characters

The parametric name in a specific language.

DefaultNamestring or null[ 0 .. 50 ] characters

The parametric name for the default language.

IsNameInheritedboolean

If true, the specific language doesn't have its own name and instead inherits from the default name.

Descriptionstring or null[ 0 .. 500 ] characters

A longer description for the parametric explaining it in more detail.

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The parametric description in the default language.

IsDescriptionInheritedboolean

If true, the description is inherited from the default language rather than being its own text.

Uomstring or null[ 0 .. 50 ] characters

Unit of measurement for the parametric value. This is a text field allowing any unit to be specified. Used in presentation views in front-end.

DefaultUomstring or null[ 0 .. 50 ] characters

The unit of measurement in the default language.

IsUomInheritedboolean

If true, the unit of measurement is inherited from the default language.

Typestringnon-emptyrequired

The type of parametric. Valid values: text, html, int, decimal, date, boolean, list, multiple.

TypeNamestring or null

Human-readable name for the parametric type. (e.g., Text, HTML, Integer, Decimal, Date, Boolean, List, Multiple list).

GroupIdinteger or null(int32)

The identifier of the parametric group this parametric belongs to.

GroupNamestring or null

The name of the parametric group this parametric belongs to.

IsRequiredboolean

Indicates whether this parametric is required when assigned to a product. If true, this parametrics is marked as mandatory in admin and front-end interfaces.

IsFavoriteboolean

Indicates whether this parametric is marked as a favorite for quick access in the Admin interface.

IsReadOnlyboolean

Indicates whether this parametric is read-only and cannot be modified in the Admin interface. Can still be changed programmatically, using connect API.

IsHiddenboolean

Indicates whether this parametric is hidden from the user interface. If true, it will be marked as hidden in front-end facing api models.

IsPublicboolean

Called "Global" in the Admin interface. Indicates whether this parametric is by default available on all categories (on all products).

DefaultIsVariantUniqueboolean

Indicates that the parametric will default to variants when merging products.

IsActiveboolean

False if the parametric is soft deleted, removes it from the admin interface and non-functional but easily reactivatable. Note that product data on this parametric is not deleted but not accessible through normal means, until reactivated.

Editorstring or null[ 0 .. 16 ] characters

The editor type used for input of this parametric. Type must be "html" and the choices are e.g. "text" and "html". Only used in Admin interface.

Codestring or null[ 0 .. 50 ] characters

Parametric code with string length of 50. Important to set and should be unique across all parametrics.

CodeListKeystring or null[ 0 .. 50 ] characters

Deprecated functionality, used as a collection identifier from external product sources.

Changedstring or null

The date and time when the Parametric entity was last changed.

ChangedBystring or null

The name of the user who last changed the Parametric entity, null if never changed.

CulturesArray of objects(ParametricCultureModel)

List of all culture-specific text fields for the parametric.

ShowOnTextTabboolean

Indicates whether this parametric should be shown on the text tab in the Admin interface.

ShowInListboolean

Makes this parametric available when listing products through the API. Only valid for List and multiple list types.

Response
application/json
{ "Id": 0, "Name": "string", "DefaultName": "string", "IsNameInherited": true, "Description": "string", "DefaultDescription": "string", "IsDescriptionInherited": true, "Uom": "string", "DefaultUom": "string", "IsUomInherited": true, "Type": "string", "TypeName": "string", "GroupId": 0, "GroupName": "string", "IsRequired": true, "IsFavorite": true, "IsReadOnly": true, "IsHidden": true, "IsPublic": true, "DefaultIsVariantUnique": true, "IsActive": true, "Editor": "string", "Code": "string", "CodeListKey": "string", "Changed": "string", "ChangedBy": "string", "Cultures": [ {} ], "ShowOnTextTab": true, "ShowInList": true }

Update a parametric

Request

Update an existing parametric

Path
idinteger(int32)required

Parametric id

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

Parametric to update

Idinteger(int32)

Internal identifier for the parametric. Client-specific.

Namestring or null[ 0 .. 50 ] characters

The parametric name in a specific language.

DefaultNamestring or null[ 0 .. 50 ] characters

The parametric name for the default language.

IsNameInheritedboolean

If true, the specific language doesn't have its own name and instead inherits from the default name.

Descriptionstring or null[ 0 .. 500 ] characters

A longer description for the parametric explaining it in more detail.

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The parametric description in the default language.

IsDescriptionInheritedboolean

If true, the description is inherited from the default language rather than being its own text.

Uomstring or null[ 0 .. 50 ] characters

Unit of measurement for the parametric value. This is a text field allowing any unit to be specified. Used in presentation views in front-end.

DefaultUomstring or null[ 0 .. 50 ] characters

The unit of measurement in the default language.

IsUomInheritedboolean

If true, the unit of measurement is inherited from the default language.

Typestringnon-emptyrequired

The type of parametric. Valid values: text, html, int, decimal, date, boolean, list, multiple.

TypeNamestring or null

Human-readable name for the parametric type. (e.g., Text, HTML, Integer, Decimal, Date, Boolean, List, Multiple list).

GroupIdinteger or null(int32)

The identifier of the parametric group this parametric belongs to.

GroupNamestring or null

The name of the parametric group this parametric belongs to.

IsRequiredboolean

Indicates whether this parametric is required when assigned to a product. If true, this parametrics is marked as mandatory in admin and front-end interfaces.

IsFavoriteboolean

Indicates whether this parametric is marked as a favorite for quick access in the Admin interface.

IsReadOnlyboolean

Indicates whether this parametric is read-only and cannot be modified in the Admin interface. Can still be changed programmatically, using connect API.

IsHiddenboolean

Indicates whether this parametric is hidden from the user interface. If true, it will be marked as hidden in front-end facing api models.

IsPublicboolean

Called "Global" in the Admin interface. Indicates whether this parametric is by default available on all categories (on all products).

DefaultIsVariantUniqueboolean

Indicates that the parametric will default to variants when merging products.

IsActiveboolean

False if the parametric is soft deleted, removes it from the admin interface and non-functional but easily reactivatable. Note that product data on this parametric is not deleted but not accessible through normal means, until reactivated.

Editorstring or null[ 0 .. 16 ] characters

The editor type used for input of this parametric. Type must be "html" and the choices are e.g. "text" and "html". Only used in Admin interface.

Codestring or null[ 0 .. 50 ] characters

Parametric code with string length of 50. Important to set and should be unique across all parametrics.

CodeListKeystring or null[ 0 .. 50 ] characters

Deprecated functionality, used as a collection identifier from external product sources.

Changedstring or null

The date and time when the Parametric entity was last changed.

ChangedBystring or null

The name of the user who last changed the Parametric entity, null if never changed.

CulturesArray of objects(ParametricCultureModel)

List of all culture-specific text fields for the parametric.

ShowOnTextTabboolean

Indicates whether this parametric should be shown on the text tab in the Admin interface.

ShowInListboolean

Makes this parametric available when listing products through the API. Only valid for List and multiple list types.

curl -i -X PUT \
  'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/parametric/{id}' \
  -H 'Content-Type: application/json' \
  -H 'account-id: 0' \
  -H 'application-id: 0' \
  -d '{
    "Id": 0,
    "Name": "string",
    "DefaultName": "string",
    "IsNameInherited": true,
    "Description": "string",
    "DefaultDescription": "string",
    "IsDescriptionInherited": true,
    "Uom": "string",
    "DefaultUom": "string",
    "IsUomInherited": true,
    "Type": "string",
    "TypeName": "string",
    "GroupId": 0,
    "GroupName": "string",
    "IsRequired": true,
    "IsFavorite": true,
    "IsReadOnly": true,
    "IsHidden": true,
    "IsPublic": true,
    "DefaultIsVariantUnique": true,
    "IsActive": true,
    "Editor": "string",
    "Code": "string",
    "CodeListKey": "string",
    "Changed": "string",
    "ChangedBy": "string",
    "Cultures": [
      {
        "CultureCode": "string",
        "Name": "string",
        "IsNameInherited": true,
        "Description": "string",
        "IsDescriptionInherited": true,
        "Uom": "string",
        "IsUomInherited": true,
        "IsTranslated": true
      }
    ],
    "ShowOnTextTab": true,
    "ShowInList": true
  }'

Responses

If the parametric was successfully updated

Bodyapplication/json
integer(int32)
Response
application/json
0

List active parametrics

Request

Get a list of all active parametrics on the client

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/parametric \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the list of parametrics, if any exists

Bodyapplication/jsonArray [
Idinteger(int32)

Internal identifier for the parametric. Client-specific.

Namestring or null[ 0 .. 50 ] characters

The parametric name in a specific language.

DefaultNamestring or null[ 0 .. 50 ] characters

The parametric name for the default language.

IsNameInheritedboolean

If true, the specific language doesn't have its own name and instead inherits from the default name.

Descriptionstring or null[ 0 .. 500 ] characters

A longer description for the parametric explaining it in more detail.

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The parametric description in the default language.

IsDescriptionInheritedboolean

If true, the description is inherited from the default language rather than being its own text.

Uomstring or null[ 0 .. 50 ] characters

Unit of measurement for the parametric value. This is a text field allowing any unit to be specified. Used in presentation views in front-end.

DefaultUomstring or null[ 0 .. 50 ] characters

The unit of measurement in the default language.

IsUomInheritedboolean

If true, the unit of measurement is inherited from the default language.

Typestringnon-emptyrequired

The type of parametric. Valid values: text, html, int, decimal, date, boolean, list, multiple.

TypeNamestring or null

Human-readable name for the parametric type. (e.g., Text, HTML, Integer, Decimal, Date, Boolean, List, Multiple list).

GroupIdinteger or null(int32)

The identifier of the parametric group this parametric belongs to.

GroupNamestring or null

The name of the parametric group this parametric belongs to.

IsRequiredboolean

Indicates whether this parametric is required when assigned to a product. If true, this parametrics is marked as mandatory in admin and front-end interfaces.

IsFavoriteboolean

Indicates whether this parametric is marked as a favorite for quick access in the Admin interface.

IsReadOnlyboolean

Indicates whether this parametric is read-only and cannot be modified in the Admin interface. Can still be changed programmatically, using connect API.

IsHiddenboolean

Indicates whether this parametric is hidden from the user interface. If true, it will be marked as hidden in front-end facing api models.

IsPublicboolean

Called "Global" in the Admin interface. Indicates whether this parametric is by default available on all categories (on all products).

DefaultIsVariantUniqueboolean

Indicates that the parametric will default to variants when merging products.

IsActiveboolean

False if the parametric is soft deleted, removes it from the admin interface and non-functional but easily reactivatable. Note that product data on this parametric is not deleted but not accessible through normal means, until reactivated.

Editorstring or null[ 0 .. 16 ] characters

The editor type used for input of this parametric. Type must be "html" and the choices are e.g. "text" and "html". Only used in Admin interface.

Codestring or null[ 0 .. 50 ] characters

Parametric code with string length of 50. Important to set and should be unique across all parametrics.

CodeListKeystring or null[ 0 .. 50 ] characters

Deprecated functionality, used as a collection identifier from external product sources.

Changedstring or null

The date and time when the Parametric entity was last changed.

ChangedBystring or null

The name of the user who last changed the Parametric entity, null if never changed.

CulturesArray of objects(ParametricCultureModel)

List of all culture-specific text fields for the parametric.

ShowOnTextTabboolean

Indicates whether this parametric should be shown on the text tab in the Admin interface.

ShowInListboolean

Makes this parametric available when listing products through the API. Only valid for List and multiple list types.

]
Response
application/json
[ { "Id": 0, "Name": "string", "DefaultName": "string", "IsNameInherited": true, "Description": "string", "DefaultDescription": "string", "IsDescriptionInherited": true, "Uom": "string", "DefaultUom": "string", "IsUomInherited": true, "Type": "string", "TypeName": "string", "GroupId": 0, "GroupName": "string", "IsRequired": true, "IsFavorite": true, "IsReadOnly": true, "IsHidden": true, "IsPublic": true, "DefaultIsVariantUnique": true, "IsActive": true, "Editor": "string", "Code": "string", "CodeListKey": "string", "Changed": "string", "ChangedBy": "string", "Cultures": [], "ShowOnTextTab": true, "ShowInList": true } ]

Add a parametric

Request

Add a new parametric to the client

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

Parametric to add

Idinteger(int32)

Internal identifier for the parametric. Client-specific.

Namestring or null[ 0 .. 50 ] characters

The parametric name in a specific language.

DefaultNamestring or null[ 0 .. 50 ] characters

The parametric name for the default language.

IsNameInheritedboolean

If true, the specific language doesn't have its own name and instead inherits from the default name.

Descriptionstring or null[ 0 .. 500 ] characters

A longer description for the parametric explaining it in more detail.

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The parametric description in the default language.

IsDescriptionInheritedboolean

If true, the description is inherited from the default language rather than being its own text.

Uomstring or null[ 0 .. 50 ] characters

Unit of measurement for the parametric value. This is a text field allowing any unit to be specified. Used in presentation views in front-end.

DefaultUomstring or null[ 0 .. 50 ] characters

The unit of measurement in the default language.

IsUomInheritedboolean

If true, the unit of measurement is inherited from the default language.

Typestringnon-emptyrequired

The type of parametric. Valid values: text, html, int, decimal, date, boolean, list, multiple.

TypeNamestring or null

Human-readable name for the parametric type. (e.g., Text, HTML, Integer, Decimal, Date, Boolean, List, Multiple list).

GroupIdinteger or null(int32)

The identifier of the parametric group this parametric belongs to.

GroupNamestring or null

The name of the parametric group this parametric belongs to.

IsRequiredboolean

Indicates whether this parametric is required when assigned to a product. If true, this parametrics is marked as mandatory in admin and front-end interfaces.

IsFavoriteboolean

Indicates whether this parametric is marked as a favorite for quick access in the Admin interface.

IsReadOnlyboolean

Indicates whether this parametric is read-only and cannot be modified in the Admin interface. Can still be changed programmatically, using connect API.

IsHiddenboolean

Indicates whether this parametric is hidden from the user interface. If true, it will be marked as hidden in front-end facing api models.

IsPublicboolean

Called "Global" in the Admin interface. Indicates whether this parametric is by default available on all categories (on all products).

DefaultIsVariantUniqueboolean

Indicates that the parametric will default to variants when merging products.

IsActiveboolean

False if the parametric is soft deleted, removes it from the admin interface and non-functional but easily reactivatable. Note that product data on this parametric is not deleted but not accessible through normal means, until reactivated.

Editorstring or null[ 0 .. 16 ] characters

The editor type used for input of this parametric. Type must be "html" and the choices are e.g. "text" and "html". Only used in Admin interface.

Codestring or null[ 0 .. 50 ] characters

Parametric code with string length of 50. Important to set and should be unique across all parametrics.

CodeListKeystring or null[ 0 .. 50 ] characters

Deprecated functionality, used as a collection identifier from external product sources.

Changedstring or null

The date and time when the Parametric entity was last changed.

ChangedBystring or null

The name of the user who last changed the Parametric entity, null if never changed.

CulturesArray of objects(ParametricCultureModel)

List of all culture-specific text fields for the parametric.

ShowOnTextTabboolean

Indicates whether this parametric should be shown on the text tab in the Admin interface.

ShowInListboolean

Makes this parametric available when listing products through the API. Only valid for List and multiple list types.

curl -i -X POST \
  https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/parametric \
  -H 'Content-Type: application/json' \
  -H 'account-id: 0' \
  -H 'application-id: 0' \
  -d '{
    "Id": 0,
    "Name": "string",
    "DefaultName": "string",
    "IsNameInherited": true,
    "Description": "string",
    "DefaultDescription": "string",
    "IsDescriptionInherited": true,
    "Uom": "string",
    "DefaultUom": "string",
    "IsUomInherited": true,
    "Type": "string",
    "TypeName": "string",
    "GroupId": 0,
    "GroupName": "string",
    "IsRequired": true,
    "IsFavorite": true,
    "IsReadOnly": true,
    "IsHidden": true,
    "IsPublic": true,
    "DefaultIsVariantUnique": true,
    "IsActive": true,
    "Editor": "string",
    "Code": "string",
    "CodeListKey": "string",
    "Changed": "string",
    "ChangedBy": "string",
    "Cultures": [
      {
        "CultureCode": "string",
        "Name": "string",
        "IsNameInherited": true,
        "Description": "string",
        "IsDescriptionInherited": true,
        "Uom": "string",
        "IsUomInherited": true,
        "IsTranslated": true
      }
    ],
    "ShowOnTextTab": true,
    "ShowInList": true
  }'

Responses

If the parametric was successfully added

Bodyapplication/json
integer(int32)
Response
application/json
0

List deleted parametrics

Request

Get a list of all deleted parametrics on the client, update a deleted parametric with IsActive = true to activate it again

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/parametric/deleted \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the list of deleted parametrics, if any exists

Bodyapplication/jsonArray [
Idinteger(int32)

Internal identifier for the parametric. Client-specific.

Namestring or null[ 0 .. 50 ] characters

The parametric name in a specific language.

DefaultNamestring or null[ 0 .. 50 ] characters

The parametric name for the default language.

IsNameInheritedboolean

If true, the specific language doesn't have its own name and instead inherits from the default name.

Descriptionstring or null[ 0 .. 500 ] characters

A longer description for the parametric explaining it in more detail.

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The parametric description in the default language.

IsDescriptionInheritedboolean

If true, the description is inherited from the default language rather than being its own text.

Uomstring or null[ 0 .. 50 ] characters

Unit of measurement for the parametric value. This is a text field allowing any unit to be specified. Used in presentation views in front-end.

DefaultUomstring or null[ 0 .. 50 ] characters

The unit of measurement in the default language.

IsUomInheritedboolean

If true, the unit of measurement is inherited from the default language.

Typestringnon-emptyrequired

The type of parametric. Valid values: text, html, int, decimal, date, boolean, list, multiple.

TypeNamestring or null

Human-readable name for the parametric type. (e.g., Text, HTML, Integer, Decimal, Date, Boolean, List, Multiple list).

GroupIdinteger or null(int32)

The identifier of the parametric group this parametric belongs to.

GroupNamestring or null

The name of the parametric group this parametric belongs to.

IsRequiredboolean

Indicates whether this parametric is required when assigned to a product. If true, this parametrics is marked as mandatory in admin and front-end interfaces.

IsFavoriteboolean

Indicates whether this parametric is marked as a favorite for quick access in the Admin interface.

IsReadOnlyboolean

Indicates whether this parametric is read-only and cannot be modified in the Admin interface. Can still be changed programmatically, using connect API.

IsHiddenboolean

Indicates whether this parametric is hidden from the user interface. If true, it will be marked as hidden in front-end facing api models.

IsPublicboolean

Called "Global" in the Admin interface. Indicates whether this parametric is by default available on all categories (on all products).

DefaultIsVariantUniqueboolean

Indicates that the parametric will default to variants when merging products.

IsActiveboolean

False if the parametric is soft deleted, removes it from the admin interface and non-functional but easily reactivatable. Note that product data on this parametric is not deleted but not accessible through normal means, until reactivated.

Editorstring or null[ 0 .. 16 ] characters

The editor type used for input of this parametric. Type must be "html" and the choices are e.g. "text" and "html". Only used in Admin interface.

Codestring or null[ 0 .. 50 ] characters

Parametric code with string length of 50. Important to set and should be unique across all parametrics.

CodeListKeystring or null[ 0 .. 50 ] characters

Deprecated functionality, used as a collection identifier from external product sources.

Changedstring or null

The date and time when the Parametric entity was last changed.

ChangedBystring or null

The name of the user who last changed the Parametric entity, null if never changed.

CulturesArray of objects(ParametricCultureModel)

List of all culture-specific text fields for the parametric.

ShowOnTextTabboolean

Indicates whether this parametric should be shown on the text tab in the Admin interface.

ShowInListboolean

Makes this parametric available when listing products through the API. Only valid for List and multiple list types.

]
Response
application/json
[ { "Id": 0, "Name": "string", "DefaultName": "string", "IsNameInherited": true, "Description": "string", "DefaultDescription": "string", "IsDescriptionInherited": true, "Uom": "string", "DefaultUom": "string", "IsUomInherited": true, "Type": "string", "TypeName": "string", "GroupId": 0, "GroupName": "string", "IsRequired": true, "IsFavorite": true, "IsReadOnly": true, "IsHidden": true, "IsPublic": true, "DefaultIsVariantUnique": true, "IsActive": true, "Editor": "string", "Code": "string", "CodeListKey": "string", "Changed": "string", "ChangedBy": "string", "Cultures": [], "ShowOnTextTab": true, "ShowInList": true } ]

PriceList Population

Operations

PriceList Pricing

Operations

PriceList

Operations

PriceList SupplierPriceList

Operations

PriceList Warehouse

Operations

Product FlagGroup

Operations

Product Flag

Operations

Product InfoType

Operations

Product Type

Operations

Promotion

Operations

Product RelationType

Operations

PriceList RoundingRule

Operations

Shopping InfoType

Operations

Store Application

Operations

Store PriceList

Operations

Store

Operations

Store Warehouse

Operations

Supplier PriceList

Operations

Supplier PriceListWarehouse

Operations

Supplier

Operations

Supplier Warehouse

Operations

Supplier WarehouseLocation

Operations

Product VariantGroup

Operations

Product WarehouseLocation

Operations

Product Warehouse

Operations