Skip to content

Documentation ProductService (1.1)

Download OpenAPI description
Languages
Servers
https://customer-slug.api-se.norce.tech/commerce/product/1.1/

Schemas

Schemas

ParametricInfo

Idinteger(int32)

The internal Id of the parametric.

Namestring

The Name of the parametric. MaxLength: 50.

Typestring

The Type of the parametric: ListValue, MultiValue or Value.

Descriptionstring

The Description of the parametric. MaxLength: 500.

Uomstring

The unit of measurement of the values. MaxLength: 50.

IsVariantParametricboolean

Specifies if the current Parametric is for variants only (true) or for the common product (false).

ValueTypestring

The data type of the values for this parametric: Text, Integer, Decimal, Boolean, Html or Date.

Codestring

An externally defined code use to identify this Parametric. MaxLength: 50.

IsHiddenboolean

Indicates if the parametric is hidden or not. This can be used to hide parametrics that are only used in application logic. Only non-hidden parametrics should be displayed in the frontend.

IsGlobalboolean

Indicates if the parametric is global. If it is set as global it exists on all products in all categories.

{ "Id": 0, "Name": "string", "Type": "string", "Description": "string", "Uom": "string", "IsVariantParametric": true, "ValueType": "string", "Code": "string", "IsHidden": true, "IsGlobal": true }

ParametricsSeed

ListSeedstring

A comma separated list of parametric values on the format id:value-id. Id is the parametric id and value id is the parametric value id. Use ListParametricInfo to list all parametric info and ListParametricValues2 for all values as lookup when resolving parametric data. MaxLength: max.

MultipleSeedstring

Same as for ParametricListSeed but any parametric can have multiple values. Use ListParametricInfo to list all parametric info and ListParametricValues2 for all values as lookup when resolving parametric data. MaxLength: max.

ValueSeedstring

Same as for ParametricListSeed but the value is inlined as id:value. Use ListParametricInfo to list all parametric info and ListParametricValues2 for all values as lookup when resolving parametric data. Parametric with values of type html or text are not supported. MaxLength: max.

{ "ListSeed": "string", "MultipleSeed": "string", "ValueSeed": "string" }

ParametricValue

Idinteger(int32)

The internal Id of the parametric value.

Namestring

The Name of the parametric value. MaxLength: 255.

Descriptionstring

The Description of the parametric value. MaxLength: max.

Codestring

An externally defined code use to identify this Parametric value. MaxLength: 50.

ImageKeystring or null(guid)

A unique id for the image at our image server. Url for images are formed like http://[client specific CDN]/{ImageKey}. Preset, height and width can be sent as parameters.

Typestring

MaxLength: 50. Obsolete! - Use ParametricInfo.Type

SortOrderinteger(int32)

Can be specified in Storm Admin for each parametric value.

ParametricIdinteger(int32)

The internal Id of the Parametric that contains this value.

ParametricCodestring

An externally defined code use to identify this Parametric that contains this value. MaxLength: 50.

{ "Id": 0, "Name": "string", "Description": "string", "Code": "string", "ImageKey": "string", "Type": "string", "SortOrder": 0, "ParametricId": 0, "ParametricCode": "string" }

Assortments

Operations

Categories

Operations

Configurations

Operations

Families

Operations

Files

Operations

Filters

Operations

Flags

Operations

InfoTypes

Operations

Manufacturers

Operations

OnHand

Operations

Parametric

Operations

PriceLists

Operations

Products

Operations

Promotions

Operations

Relations

Operations

Reviews

Operations

SkuTypes

Operations

Status

Operations

Variants

Operations

Warehouses

Operations