Last updated

Product Service schemas

The Products namespace is concerned with product catalog data. Products, Prices, Availability etc.

Assortments

No entities. See IdValue

Categories

CategoryParametric

Represents a parametric defined for a Category.

Idinteger or null(int32)

The internal Id of the Parametric.

Namestring or null

The internal Id of the Parametric.

GroupIdinteger or null(int32)

The internal Id of the ParametricGroup.

GroupNamestring or null

The Name of the ParametricGroup.

SortOrderinteger or null(int32)

Use this to sort the parametric. The value is fetched from the category's sort order for the parametric values.

IsGlobalboolean or null

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

Configurations

ConfigurationItem

Represents an Item much like any package item. ConfigurationItems contains groups of configurable items instead of fixed items.

PartNostring or null

The PartNo of the ConfigurationItem.

GroupsArray of objects or null(ConfigurationItemGroup)

A list of ConfigurationItemGroups where each group contains selectable items.

ConfigurationItemGroup

Represents a selectable Item in a ConfigurationItem. The group contains all selectable items for this group.

Idinteger or null(int32)

The internal Id of the ConfigurationItemGroup.

Namestring or null

The Name of the ConfigurationItemGroup.

IsOptionalboolean or null

Indicates if any item from Items must be selected or not.

IsMultiSelectionboolean or null

Indicates if more than one item in Items must be selected or not.

SortOrderinteger or null(int32)

The SortOrder of the ConfigurationItemGroup within the ConfigurationItem.

ItemsArray of objects or null(ConfigurationItemGroupItem)

A list of ConfigurationItemGroupItems where each item is a selectable product.

ConfigurationItemGroupItem

Represents a selectable Item in a ConfigurationItemGroup, i.e a Product. The Item is what the user selects in the configuration.

ProductIdinteger or null(int32)

The internal product id of the Product.

PartNostring or null

The PartNo of the Product.

Namestring or null

The Name of the Product. When Product is a VariantType, this will be the value of the variant parameter(s).

Descriptionstring or null

The Description of the Product.

SortOrderinteger or null(int32)

The SortOrder of the Item within the group.

Quantitynumber or null(decimal)

The Quantity of the Item.

Pricenumber or null(decimal)

The Price of the Item.

PriceListIdinteger or null(int32)

The internal pricelist id of the Item.

VatRatenumber or null(decimal)

A rate to multiply with price to get price inc VAT. 25% VAT equals a VatRate of 1.25.

ImageKeystring or null(uuid)

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.

UniqueNamestring or null

A unique name that can be used in Urls and to get a Product. GetProduct and GetProductByUniqueName gets the same Product.

Families

Family

Grouping of products cross Categories. It can be use to group products that are related to each other only by name, i.e family.

Idinteger or null(int32)

The internal Id of the Family.

Namestring or null

The Name of the Family.

Descriptionstring or null

The Description of the Family.

ImageKeystring or null(uuid)

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.

Codestring or null

The external Code of the Family.

Files

ProductFile

Files related to Product.

Idinteger or null(int32)

This is the file internal id and it defines the kind of file it is. Not to be confused with entity ids. Values are application specific and should be like 'Front image', 'Back image'. See ListFileTypeIds for possible values.

Typeinteger or null(int32)

This is the FileTypeId mapped from Norce's predefined types. Types maps to mime types.

Namestring or null

This is the Name of the product file.

Descriptionstring or null

This is the Description of the product file.

Keystring or null(uuid)

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

Extensionstring or null

This is the file type extension for the current file. Can be used to append after image key in url.

Codestring or null

This is the file's external Code. Can be use as is for grouping files if Id is not adequate. Or any other application specific purpose.

SortOrderinteger or null(int32)

This is the sortorder of the file within its file type Id.

ImageAltTextstring or null

Image alt text

Pathstring or nullDeprecated

Filters

Filter

Used to render filter options for product lists. See FilterList and ListProductFilter methods for details.

Namestring or null

The Name of the filter. Available names are: catf, mfrf, flgf, ohf, prcf and parf. These are a short notation of the actual types. Used in filter specifications as filter name.

Typestring or null

The Type of the filter. Available types are: Category, Manufacturer, Flag, OnHand, Price and Parametric.

ItemsArray of objects or null(IFilterItem)

A list of specific FilterItems for the Filter. The items are the actual values for each type of Filter.

FilterBoolItem

Special FilterItem with a boolean value used for parametric filters. FilterBool can be rendered with a CheckBox in the Application. Ex. for filter within a parf filter: 'V123_1-1' when value parametric 123 should have a value of 1 (true).

Idstring or null

The internal id of the FilterItem. Values are dependent on the type of the filter. This will be the internal id of a catergory if the Filter is a Category filter. Not used for OnHand and Price filters.

Namestring or null
$typestring or null
Enum"FilterItem""FilterBoolItem""FilterPriceItem""FilterListItem""FilterMultiItem""FilterRangeItem"
Discriminator
Valuestring or null

The Value of the FilterItem.

Typestring or null

The Type of the Item. This is the data type, such as int, string, decimal and DateTime.

Uomstring or null

Unit of measurement for the value, if specified.

Countinteger(int32)

A count of SKUs matched by the FilterItem.

Descriptionstring or null

A description of the value.

Codestring or null

A Client specific code for the value.

SortOrderinteger or null(int32)

SortOrder for the FilterItem. Only used for parametric filter values and can be specified in Norce Admin for list values or multi values. Can be used to sort the values. Default sort order is Name.

FilterItem

The actual value for the items property of Filter. Used as filter specification values. Selected values should be comma separated in a filter specification. Ex: 'catf|123,124'

Idstring or null

The internal id of the FilterItem. Values are dependent on the type of the filter. This will be the internal id of a catergory if the Filter is a Category filter. Not used for OnHand and Price filters.

Namestring or null
$typestring or null
Enum"FilterItem""FilterBoolItem""FilterPriceItem""FilterListItem""FilterMultiItem""FilterRangeItem"
Discriminator
Valuestring or null

The Value of the FilterItem.

Typestring or null

The Type of the Item. This is the data type, such as int, string, decimal and DateTime.

Uomstring or null

Unit of measurement for the value, if specified.

Countinteger(int32)

A count of SKUs matched by the FilterItem.

Descriptionstring or null

A description of the value.

Codestring or null

A Client specific code for the value.

SortOrderinteger or null(int32)

SortOrder for the FilterItem. Only used for parametric filter values and can be specified in Norce Admin for list values or multi values. Can be used to sort the values. Default sort order is Name.

FilterListItem

Special FilterItem for parametric filters which have single select values. Ex. for filter: 'L123_456' when list value parametric 123 should have value id 456. Use '' or '!' to separate or:ed values: 'L123_456L123_457'

Idstring or null

The internal id of the FilterItem. Values are dependent on the type of the filter. This will be the internal id of a catergory if the Filter is a Category filter. Not used for OnHand and Price filters.

Namestring or null
$typestring or null
Enum"FilterItem""FilterBoolItem""FilterPriceItem""FilterListItem""FilterMultiItem""FilterRangeItem"
Discriminator
Valuestring or null

The Value of the FilterItem.

Typestring or null

The Type of the Item. This is the data type, such as int, string, decimal and DateTime.

Uomstring or null

Unit of measurement for the value, if specified.

Countinteger(int32)

A count of SKUs matched by the FilterItem.

Descriptionstring or null

A description of the value.

Codestring or null

A Client specific code for the value.

SortOrderinteger or null(int32)

SortOrder for the FilterItem. Only used for parametric filter values and can be specified in Norce Admin for list values or multi values. Can be used to sort the values. Default sort order is Name.

FilterMultiItem

Special FilterItem for parametric filters which have multi select values. Ex. for filter: 'M123_456' when multi parametric 123 should have value id 456. Use '' or '!' to separate or:ed values: 'M123_456M123_457'.

Idstring or null

The internal id of the FilterItem. Values are dependent on the type of the filter. This will be the internal id of a catergory if the Filter is a Category filter. Not used for OnHand and Price filters.

Namestring or null
$typestring or null
Enum"FilterItem""FilterBoolItem""FilterPriceItem""FilterListItem""FilterMultiItem""FilterRangeItem"
Discriminator
Valuestring or null

The Value of the FilterItem.

Typestring or null

The Type of the Item. This is the data type, such as int, string, decimal and DateTime.

Uomstring or null

Unit of measurement for the value, if specified.

Countinteger(int32)

A count of SKUs matched by the FilterItem.

Descriptionstring or null

A description of the value.

Codestring or null

A Client specific code for the value.

SortOrderinteger or null(int32)

SortOrder for the FilterItem. Only used for parametric filter values and can be specified in Norce Admin for list values or multi values. Can be used to sort the values. Default sort order is Name.

FilterPriceItem

Used as Item for filter type Price. FilterPriceItem can be rendered with a slide bar in the Application. Ex. for filter: 'prcf|true_10-20' when price should be between 10 to 20 inc vat.

Idstring or null

The internal id of the FilterItem. Values are dependent on the type of the filter. This will be the internal id of a catergory if the Filter is a Category filter. Not used for OnHand and Price filters.

Namestring or null
$typestring or null
Enum"FilterItem""FilterBoolItem""FilterPriceItem""FilterListItem""FilterMultiItem""FilterRangeItem"
Discriminator
Valuestring or null

The Value of the FilterItem.

Typestring or null

The Type of the Item. This is the data type, such as int, string, decimal and DateTime.

Uomstring or null

Unit of measurement for the value, if specified.

Countinteger(int32)

A count of SKUs matched by the FilterItem.

Descriptionstring or null

A description of the value.

Codestring or null

A Client specific code for the value.

SortOrderinteger or null(int32)

SortOrder for the FilterItem. Only used for parametric filter values and can be specified in Norce Admin for list values or multi values. Can be used to sort the values. Default sort order is Name.

FilterRangeItem

Special FilterItem with a range defined by a min and max value for parametric filters. FilterRangeItems can be rendered with a slide bar in the Application. Ex. for filter: 'V123_1.4-2.5' when value parametric should be between 1.4 and 2.5.

Idstring or null

The internal id of the FilterItem. Values are dependent on the type of the filter. This will be the internal id of a catergory if the Filter is a Category filter. Not used for OnHand and Price filters.

Namestring or null
$typestring or null
Enum"FilterItem""FilterBoolItem""FilterPriceItem""FilterListItem""FilterMultiItem""FilterRangeItem"
Discriminator
Valuestring or null

The Value of the FilterItem.

Typestring or null

The Type of the Item. This is the data type, such as int, string, decimal and DateTime.

Uomstring or null

Unit of measurement for the value, if specified.

Countinteger(int32)

A count of SKUs matched by the FilterItem.

Descriptionstring or null

A description of the value.

Codestring or null

A Client specific code for the value.

SortOrderinteger or null(int32)

SortOrder for the FilterItem. Only used for parametric filter values and can be specified in Norce Admin for list values or multi values. Can be used to sort the values. Default sort order is Name.

ProductItemFilterValues

ProductIdinteger or null(int32)

Internal product id.

GroupByKeystring or null

A key that can be used to group items on product. It is equal to the ProductId for non-variants and equals 'v'+variantId for variants. Should only be used when fetching product lists as variants.

CategoryIdinteger or null(int32)

Internal category id.

ManufacturerIdinteger or null(int32)

Internal manufacturer id.

FlagIdSeedstring or null

A comma separated list of flag internal ids.

Pricenumber or null(decimal)

Best price excluding VAT.

VatRatenumber or null(decimal)

A rate to multiply with price to get price inc VAT. 25% VAT equals a VatRate of 1.25.

OnHandobject or null

Information about OnHand for a given SKU. There are generally three different types of OnHand in Norce. One for the Web, one for the chosen supplier and one for any specified Store.

OnHandStoreobject or null

Information about OnHand for a given SKU. There are generally three different types of OnHand in Norce. One for the Web, one for the chosen supplier and one for any specified Store.

OnHandSupplierobject or null

Information about OnHand for a given SKU. There are generally three different types of OnHand in Norce. One for the Web, one for the chosen supplier and one for any specified Store.

ParametricListSeedstring or null
ParametricMultipleSeedstring or null
ParametricValueSeedstring or null

ParametricValueSeed contains a comma separated list of id-value pairs separated by colon. Ex: 4711:32,4712:5. Id is the ParametricId and Value is either a ListValueId, MultipleValueId or the actual value depending on the parametric type. Note that parametric values with string or html types are not included here since we cannot know if they contain any of the separators. Use ListParametricInfo to list all parametric info and ListParametricValues2 for all values as lookup when resolving parametric data.

Flags

Flag

Used in FlagList when returning product flags.

Idinteger or null(int32)

The internal Id of the Flag.

Namestring or null

The Name of the Flag.

Groupinteger or null(int32)

The GroupId of the Flag.

IsSelectedboolean or null

Indicates if the Flag is selected or not.

FlagGroup

Used to group different flags together.

Idinteger or null(int32)

The internal Id of the flagGroup.

Namestring or null

The Name of the flagGroup.

Descriptionstring or null

The Description of the flagGroup.

Codestring or null

The external Code for the flagGroup.

InfoTypes

No entities. See IdNameDescriptions

Manufacturers

Manufacturer

Contains basic data about Manufacturers in Norce. It is returned from GetManufacturer.

Idinteger or null(int32)

The internal Id of the Manufacturer.

Namestring or null

The Name of the Manufacturer.

OrgNostring or null

The organizational number of the Manufacturer.

WebSitestring or null

The url to the Manufacturer's web site.

SupportUrlstring or null

The url to the Manufacturer's support page on their web site.

SupportEmailstring or null

The email address to the Manufacturer's support.

SupportPhonestring or null

The phone number to the Manufacturer's support.

SupportOpenHoursstring or null

The opening hours for the Manufacturer's support.

SupportPolicystring or null

The url to the Manufacturer's support policy web page.

SupportDescriptionstring or null

The url to the Manufacturer's support description web page.

Keystring or null(uuid)

The system wide unique Key of the Manufacturer.

LogoKeystring or null(uuid)

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

UniqueNamestring or null

A unique name that can be used in Urls and to get this entity. GetManufacturer and GetManufacturerByUniqueName gets the same Manufacturer.

LogoPathstring or nullDeprecated

ManufacturerItem

Contains minimum data about Manufacturers in Norce shown in lists of Manufacturers. It is returned from ListManufacturer.

Idinteger or null(int32)

The internal Id of the Manufacturer.

Namestring or null

The Name of the Manufacturer.

Keystring or null(uuid)

The system wide unique Key of the Manufacturer.

ProductCountinteger or null(int32)
UniqueNamestring or null

A unique name that can be used in Urls and to get a Manufacturer. GetManufacturer and GetManufacturerByUniqueName gets the same Manufacturer.

LogoKeystring or null(uuid)

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

ManufacturerItemPagedList

PagedList of ManufacturerItems. The Items property contains all current items, depending on paging, and the ItemCount the total number of items.

ItemCountinteger or null(int32)

The total item count. Can be used to manage paging. Use PageSize to calculate number of pages.

ItemsArray of objects or null(ManufacturerItem)

Current list of ManufacturerItems for the current page if paging is used. Otherwise all items will be in the list.

ProductManufacturer

Idinteger or null(int32)

Internal id of manufacturer.

Namestring or null
PartNostring or null
LogoKeystring or null(uuid)

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

UniqueNamestring or null

A unique name that can be used in Urls and to get a Manufacturer. GetManufacturer and GetManufacturerByUniqueName gets the same Manufacturer.

LogoPathstring or nullDeprecated

The current node in the navigation. This is used when navigation is specified in Norce. Will be deprecated in the future.

Keystring or null(uuid)

Key is unique for the NavigationNode and used when listing the content displayed for the node.

Hierarchystring or null

Hierarchy represents the current navigation path within the NavigationNode structure. Hierarchy is used to get the sub nodes for current node.

TypeIdinteger or null(int32)

TypeId defines the content type of the NavigationNode.

Namestring or null

The display name of the NavigationNode.

TargetPathstring or null

The target path, if any, for the NavigationNode. This can be a direct link to any page that defines the content for the node. Depending on TypeId.

ManufacturerSeedstring or null

The manufacturer seed, if any, for the NavigationNode.

CategorySeedstring or null

The category seed, if any, for the NavigationNode.

FlagIdSeedstring or null

A comma separated list of flag internal ids, if any, for the NavigationNode.

ImageKeystring or null(uuid)

The image key for the first underlying category, if any. Url for images are formed like http://[client specific CDN]/{ImageKey}. Preset, height and width can be sent as parameters.

Descriptionstring or null

The description for the first underlying category, if any.

ProductCountinteger or null(int32)

A count of existing products under this node. It will have a value if fetched from an operation which calculates the value, null otherwise.

The root structure used for navigating the site. One application can have more than one structure. This is used when navigation is specified in Norce. Will be deprecated in the future.

Idinteger or null(int32)

The internal Id is used to get the NavigationNodeList for this structure.

Namestring or null

The Name of the NavigationStructure.

Descriptionstring or null

The Description of the NavigationStructure.

IsDefaultboolean or null

Indicates if the NavigationStructure is a default structure or not.

OnHand

OnHand

Information about OnHand for a given SKU. There are generally three different types of OnHand in Norce. One for the Web, one for the chosen supplier and one for any specified Store.

Valuenumber or null(decimal)

The aggregated value from all warehouses and locations in the current context (Web, Supplier or Store).

IncomingValuenumber or null(decimal)

The incoming quantity on the next delivery.

NextDeliveryDatestring or null(date-time)

The next delivery data from supplier to client warehouse.

LeadtimeDayCountinteger or null(int32)

The number of days it takes to ship from the supplier.

LastCheckedstring or null(date-time)

When onHand info was last checked. Null if never.

IsActiveboolean or null

Indicate if the product is stocked in a store.

IsReturnableboolean or null

Indicate if the product is returnable in a store.

InfoArray of objects or null(IdValue)

List of IdValues for the OnHand data for this sku warehouse location combination. This will always be null unless fetched with any of the ProductOnHand methods.

ProductOnHand

An entity that represents the OnHand for a product/variant.

ProductIdinteger or null(int32)

The product internal id for the current product/variant. If the entity is fetched by productId it will be that productId. If the product is fetched by partNo it will be the productId for that variant.

WarehousesArray of objects or null(Warehouse)

A list of warehouses with OnHand for the product.

VariantsArray of objects or null(ProductOnHand)

An optional list of ProductOnHand for all variants if fetched by productId. Null when fetched for a variant or a basket.

Parametric

ParametricGroup

Information about a ParametricGroup. A ParametricGroup can be used to group different parametrics together.

Idinteger or null(int32)

The internal Id of the parametricGroup.

Namestring or null

The Name of the parametricGroup.

Descriptionstring or null

The Description of the parametricGroup.

Codestring or null

The external Code for the parametricGroup.

ParametricInfo

Metadata for a Parametric. This data can be cached for lookup use.

Idinteger or null(int32)

The internal Id of the parametric.

Namestring or null

The Name of the parametric.

Typeinteger or null(int32)

1 = ListValue, 2 = MultiValue, 3 = Value

Enum123
Descriptionstring or null

The Description of the parametric.

Uomstring or null

The unit of measurement of the values.

IsVariantParametricboolean or null

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

ValueTypeinteger or null(int32)

1 = Text, 2 = Integer, 3 = Decimal, 4 = Boolean, 5 = Html, 6 = Date

Enum123456
Codestring or null

An externally defined code use to identify this Parametric.

IsHiddenboolean or null

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 or null

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

ParametricsSeed

ListSeedstring or null

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.

MultipleSeedstring or null

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.

ValueSeedstring or null

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.

ParametricValue

Metadata for ParametricValues. This data can be cached for lookup use. Only information about ListValues and MultiValues are returned.

Idinteger or null(int32)

The internal Id of the parametric value.

Namestring or null

The Name of the parametric value.

Descriptionstring or null

The Description of the parametric value.

Codestring or null

An externally defined code use to identify this Parametric value.

ImageKeystring or null(uuid)

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.

SortOrderinteger or null(int32)

Can be specified in Norce Admin for each parametric value.

ParametricIdinteger or null(int32)

The internal Id of the Parametric that contains this value.

ParametricCodestring or null

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

Typestring or nullDeprecated

ProductParametric

Namestring or null
Idinteger or null(int32)

Internal product parametric id.

ValueIdinteger or null(int32)

Parametric value internal id if the parametric type is single list value.

Descriptionstring or null
ValueDescriptionstring or null
IsPrimaryboolean or null
ValueIdSeedstring or null
Value2string or null

The parametric value, if not a ListValue or a MultiValue parametric.

Uomstring or null

The unit of measurement, if any.

GroupIdinteger or null(int32)

Id of the parametric group.

GroupNamestring or null

Name of the parametric group.

SortOrderinteger or null(int32)

Use this to sort the parametric. The value is fetched from the variant group type's sort order in the first place and then from the category's sort order for the parametric values.

Codestring or null

An external application specific code use to identify this Parametric.

IsHiddenboolean or null

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.

Valuestring or nullDeprecated

PriceLists

Pricelist

Information about a specific pricelist.

Idinteger or null(int32)

The internal Id of the pricelist.

Namestring or null

The Name of the pricelist.

Descriptionstring or null

The Description of the pricelist.

Agreementstring or null

External pricelist code usually known to the Erp-system.

Currencyobject or null

The Currency entity contains info about a currency.

IsPrimaryboolean or null

Specifies if this is the primary priceList or not.

IsPublicboolean or null

Specifies if this is a public priceList or not. Most application specific pricelists are public while customer specific are not.

IsLimitedToStockboolean or null

Specifies if this priceList is limited to stock or not.

IsBidboolean or null

Specifies if this is a bid pricelist or not.

ImageKeystring or null(uuid)

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.

Typeinteger or null(int32)

Internal id representing the type of priceList. Types are client specific except for 0=None, which is the default or standard priceList type. See ListPriceListTypes for defined types.

StartDatestring or null(date-time)

The StarDate for when the pricelist is valid, if any.

EndDatestring or null(date-time)

The EndDate for when the pricelist is valid, if any.

IsVirtualboolean or null

Specifies if the pricelist is virtual or not. Virtual pricelists must be inherited from a parent pricelists, which cannot be virtual, and can have no population rules. Prices are not stored in Norce but calculated on the fly when needed. Rules can be specified but other properties are inherited from parent.

SalesAreaIdinteger or null(int32)

The internal Id of the SalesArea associated with this pricelist, if any.

SalesAreaNamestring or null

The Name of the SalesArea associated with this pricelist, if any.

Products

HistoricalBestPrice

PartNostring or null

The part number for this product.

PriceListIdinteger or null(int32)

The pricelist internal id for the price.

Pricenumber or null(decimal)

The actual price value, excluding VAT.

PriceIncVatnumber or null(decimal)

The actual price value, including VAT.

VatRatenumber or null(decimal)

A rate to multiply with price to get price inc VAT. 25% VAT equals a VatRate of 1.25.

Updatedstring or null(date-time)

Time when this price started to be best price.

Product

Idinteger or null(int32)

Internal id of the product.

Namestring or null[ 0 .. 255 ] characters

The name of the product. When Product is a VariantType, this will be the value of the variant parameter(s). MaxLength: 255

Descriptionstring or null

Description of the product.

PartNostring or null[ 0 .. 50 ] characters

Contains the partNo if the product is not a variant or if the product is fetched by PartNo or VariantUniqueName. If the product has a value here then the selected variant can be found by either PartNo or by Id. MaxLength: 50

SubHeaderstring or null
Manufacturerobject or null
FilesArray of objects or null(ProductFile)

If viewed on Product level this will be the product specific files. If viewed on a Variant it will be the variant specific files.

FlagIdSeedstring or null

A comma separated list of flag internal ids. If viewed on Product level this will be the product specific flags. If viewed on a Variant it will be the variant specific flags.

Pricenumber or null(decimal)

If viewed on Product level this can be a from-price. It will be the price of the cheapest variant. If viewed on a Variant it will be the variant specific price.

PriceCatalognumber or null(decimal)

The original price, if specified. Same rules apply as for Price if it is a Product or a Variant.

PriceRecommendednumber or null(decimal)

The rule based price from a priceList, if specified. Same rules apply as for Price if it is a Product or a Variant.

VatRatenumber or null(decimal)

A rate to multiply with price to get price inc VAT. 25% VAT equals a VatRate of 1.25.

RecommendedQuantitynumber or null(decimal)

Indicates the default value used as quantity when buying the product. If IsRecommendedQuantityFixed is true, only multiples of this quantity should be allowed.

OnHandobject or null

Information about OnHand for a given SKU. There are generally three different types of OnHand in Norce. One for the Web, one for the chosen supplier and one for any specified Store.

OnHandStoreobject or null

Information about OnHand for a given SKU. There are generally three different types of OnHand in Norce. One for the Web, one for the chosen supplier and one for any specified Store.

OnHandSupplierobject or null

Information about OnHand for a given SKU. There are generally three different types of OnHand in Norce. One for the Web, one for the chosen supplier and one for any specified Store.

VariantsArray of objects or null(Product)

A list of variants for this Product, if any. If the Product is itself a variant this will be empty.

PriceListIdinteger or null(int32)
Keystring or null(uuid)
Updatedstring or null(date-time)
NavigationNodeKeystring or null(uuid)
ImageKeystring or null(uuid)

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.

VariantParametricsArray of objects or null(ProductParametric)

A list of this product's parametric values. Only used on variants.

StatusIdinteger or null(int32)
MetaTagsstring or null

Meta tags for SEO optimization.

MetaDescriptionstring or null

Meta description for SEO optimization.

VariantNamestring or null[ 0 .. 255 ] characters

The complete variant name of the product. MaxLength: 255

DescriptionHeaderstring or null[ 0 .. 255 ] characters

DescriptionHeader for the product as specified in Norce Admin. MaxLength: 255

UniqueNamestring or null[ 0 .. 500 ] characters

A unique name that can be used in Urls and to get a Product. GetProduct and GetProductByUniqueName gets the same Product. MaxLength: 500

StockDisplayBreakPointinteger or null(int32)

A value that can be used for display logic regarding OnHand.

ParametricsArray of objects or null(ProductParametric)

A list of this product's parametric values. Only Parametric values common to all variants for this product will be here. On Variant level this will contain Parametric values with distinguishing values that are not variant parametric values.

FamiliesArray of objects or null(IdNameDescription)

A list of this product's families.

IsBuyableboolean or null

Indicates if the item is buyable or not. Will always be false if the status is closed. An exception will be thrown if IsBuyable is false and an attempt to buy the item is made. The property can be used to hide or show the buy-button. Note that the value can differ for underlying variants.

SubDescriptionstring or null

Sub description from Norce Admin.

Uomstring or null[ 0 .. 50 ] characters

Short unit of measurement from Norce Admin. MaxLength: 50

UomCountnumber or null(decimal)

Unit of measurement count

EanCodestring or null[ 0 .. 50 ] characters

This will be the EAN code of the selected variant of the product if any. Variants will have this set. MaxLength: 50

Typeinteger or null(int32)

Sku type internal id for this product. Might not be valid if there are variants with different types. Then variants must be examined. Also see ListSkutypes.

CategoriesArray of objects or null(IdValue)

A list of categories ordered so the primary category is first.

IsRecommendedQuantityFixedboolean or null

If this is set to true only multiples of RecommendedQuantity should be allowed.

PopularityRankinteger or null(int32)

A value used to sort items based on popularity. Lower values are more popular.

CostPurchasenumber or null(decimal)

CostPurchase from Norce Admin.

CostUnitnumber or null(decimal)

CostUnit from Norce Admin.

Titlestring or null[ 0 .. 255 ] characters

Title for the product. As specified in Norce Admin. MaxLength: 255

ActualWeightnumber or null(decimal)

Actual weight or gross weight for the product. As specified in Norce Admin.

CommodityCodestring or null

Commodity code for the product. As specified in Norce Admin.

IsDropShipOnlyboolean or null

True if this product is for drop ship only. False otherwise.

Synonymsstring or null[ 0 .. 500 ] characters

Synonyms from the Product in Norce. Can be used when indexing the product in any search engine. MaxLength: 500

IsSubscribableboolean or null

True if this product can be added to a Subscription. False otherwise.

UnspscCodestring or null[ 0 .. 50 ] characters

United Nations Standard Products and Services Code for the product. MaxLength: 50

PriceStandardnumber or null(decimal)

The standard price, if specified. Same rules apply as for Price if it is a Product or a Variant.

Widthnumber or null(decimal)

The logistic width as defined in Norce.

Heightnumber or null(decimal)

The logistic height as defined in Norce.

Depthnumber or null(decimal)

The logistic depth as defined in Norce.

IsDangerousGoodsboolean or null

True if this product is considered as dangerous goods. False otherwise.

HasQuantityBreaksboolean or null

True if this product has any quantity breaks. False otherwise.

GroupByKeystring or null

A key that can be used to group items on product. It is equal to the ProductId for non-variants and equals 'v'+variantId for variants. Should only be used when fetching product lists as variants. MaxLength: int

PriceIncVatnumber or null(decimal)

The price including VAT calculated on the server side. Should be used to display prices including VAT.

ImageAltTextstring or null

Default image alt text

Imagestring or nullDeprecated
CampaignImagestring or nullDeprecated
LargeImagestring or nullDeprecated
ThumbnailImagestring or nullDeprecated
PriceFreightnumber or null(decimal)Deprecated
PriceFreightVatRatenumber or null(decimal)Deprecated
CategoryIdinteger or null(int32)Deprecated
CategoryNamestring or nullDeprecated

ProductId

Idinteger or null(int32)

Internal product id.

Namestring or null
ManufacturerNamestring or null
Pricenumber or null(decimal)

The best price excluding VAT for the product.

VatRatenumber or null(decimal)

A rate to multiply with price to get price inc VAT. 25% VAT equals a VatRate of 1.25.

ImageKeystring or null(uuid)

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.

UniqueNamestring or null

A unique name that can be used in Urls and to get a Product. GetProduct and GetProductByUniqueName gets the same Product.

CategoryIdinteger or null(int32)
PriceIncVatnumber or null(decimal)

The price including VAT calculated on the server side. Should be used to display prices including VAT.

ProductItem

Idinteger or null(int32)

Internal product id.

Namestring or null
SubHeaderstring or null
Manufacturerobject or null
FlagIdSeedstring or null

A comma separated list of flag internal ids.

Pricenumber or null(decimal)

Best price calculated from available pricelists, excluding VAT.

PriceRecommendednumber or null(decimal)

The rule based price from a priceList, excluding VAT, if specified.

PriceCatalognumber or null(decimal)

The original price, excluding VAT, if specified.

VatRatenumber or null(decimal)

A rate to multiply with price to get price inc VAT. 25% VAT equals a VatRate of 1.25.

RecommendedQuantitynumber or null(decimal)

Indicates the default value used as quantity when buying the product. If IsRecommendedQuantityFixed is true, only multiples of this quantity should be allowed.

OnHandobject or null

Information about OnHand for a given SKU. There are generally three different types of OnHand in Norce. One for the Web, one for the chosen supplier and one for any specified Store.

OnHandStoreobject or null

Information about OnHand for a given SKU. There are generally three different types of OnHand in Norce. One for the Web, one for the chosen supplier and one for any specified Store.

OnHandSupplierobject or null

Information about OnHand for a given SKU. There are generally three different types of OnHand in Norce. One for the Web, one for the chosen supplier and one for any specified Store.

Keystring or null(uuid)
Updatedstring or null(date-time)
ImageKeystring or null(uuid)

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.

PopularityRankinteger or null(int32)

A value used to sort items based on popularity. Lower values are more popular.

StatusIdinteger or null(int32)
VariantNamestring or null
VariantImageKeystring or null(uuid)
AdditionalImageKeySeedstring or null

Seed formatted as TypeId[1]:Guid[1], TypeId[2]:Guid[2],.., TypeId[n]:Guid[n].

GroupByKeystring or null

A key that can be used to group items on product. It is equal to the ProductId for non-variants and equals 'v'+variantId for variants. Should only be used when fetching product lists as variants.

VariantFlagIdSeedstring or null

A comma separated list of flag internal ids. Contains any variant specific flags when fetched in product list AsVariants.

PartNostring or null

Contains the partNo if the product is not a variant. This will be empty if the product has variants.

PriceListIdinteger or null(int32)

Contains the priceList internal id if the product is not a variant. This will be empty if the product has variants.

SortOrderinteger or null(int32)

A custom sort order that can be used when the product item is in a list. The sort order is defined for the primary category of the product item.

ParametricListSeedstring or null

ParametricListSeed contains a comma separated list of id-value pairs separated by colon. Ex: 4711:32,4712:5. Id is the ParametricId and Value is a ListValueId. Note that parametric values with string or html types are not included here since we cannot know if they contain any of the separators. Use ListParametricInfo to list all parametric info and ListParametricValues2 for all values as lookup when resolving parametric data.

ParametricMultipleSeedstring or null

ParametricMultipleSeed contains a comma separated list of id-value pairs separated by colon. Ex: 4711:32,4712:5. Id is the ParametricId and Value is a MultipleValueId. Multiple values for the same parametric are repeated with the same id but different values. Note that parametric values with string or html types are not included here since we cannot know if they contain any of the separators. Use ListParametricInfo to list all parametric info and ListParametricValues2 for all values as lookup when resolving parametric data.

ParametricValueSeedstring or null

ParametricValueSeed contains a comma separated list of id-value pairs separated by colon. Ex: 4711:32,4712:5. Id is the ParametricId and Value is the actual value depending on the parametric type. Note that parametric values with string or html types are not included here since we cannot know if they contain any of the separators. Use ListParametricInfo to list all parametric info and ListParametricValues2 for all values as lookup when resolving parametric data.

ParametricTextFieldArray of objects or null(IdValue)

Global text parametrics configured to to appear in lists.

VariantParametricSeedstring or null

Contains all ParametricIds that distinguishes these variants for this product. Their specific values are found under ParametricListSeed, ParametricMultiSeed or ParametricValueSeed. Use ListParametricInfo to list all parametric info and ListParametricValues2 for all values as lookup when resolving parametric data.

UniqueNamestring or null

A unique name that can be used in Urls and to get a Product. GetProduct and GetProductByUniqueName gets the same Product.

StockDisplayBreakPointinteger or null(int32)

A value that can be used for display logic regarding OnHand.

IsBuyableboolean or null

Indicates if the item is buyable or not. Will always be false if the status is closed. An exception will be thrown if IsBuyable is false and an attempt to buy the item is made. The property can be used to hide or show the buy-button.

SubDescriptionstring or null

Sub description from Norce Admin.

Quantitynumber or null(decimal)

The Quantity, if applicable. Null otherwise. This value will be set when it makes sense such as for included items in StructuralItems.

Typeinteger or null(int32)

Sku type for this product. Might not be valid if there are variants with different types. Then variants must be examined. Also see ListSkutypes.

CategoryIdSeedstring or null

A comma separated list of category internal ids ordered so the primary category id is first.

IsRecommendedQuantityFixedboolean or null

If this is set to true only multiples of RecommendedQuantity should be allowed.

Synonymsstring or null

Synonyms from the Product in Norce. Can be used when indexing the product in any search engine.

VariantUniqueNamestring or null

A unique name that can be used in Urls and to get a Product. This is the variant's unique name. GetProduct and GetProductByUniqueName gets the same Product.

IsSubscribableboolean or null

True if this product can be added in a Subscription. False otherwise.

UnitOfMeasurementstring or null

Short unit of measurement from Norce Admin.

UnitOfMeasurementCountnumber or null(decimal)

Unit of measurement count

EanCodestring or null

This will be the EAN code of the selected variant of the product if any. Variants will have this set.

PriceStandardnumber or null(decimal)

The standard price, excluding VAT, if specified.

IsDangerousGoodsboolean or null

True if this product is considered as dangerous goods. False otherwise.

PriceIncVatnumber or null(decimal)

The price including VAT calculated on the server side. Should be used to display prices including VAT.

ImageAltTextstring or null

Default image alt text

VariantImageAltTextstring or null

Variant image alt text

Imagestring or nullDeprecated
CampaignImagestring or nullDeprecated
LargeImagestring or nullDeprecated
ThumbnailImagestring or nullDeprecated
CategoryIdinteger or null(int32)Deprecated

ProductItem2

Idinteger or null(int32)

The product internal id for this ProductItem2.

Keystring or null(uuid)
PartNostring or null

Contains the part number of the primary Variant, adhering to manual sorting or if sorting isn't set - by lowest available price.

UniqueNamestring or null

A unique name that can be used in Urls and to get a Product. GetProduct and GetProductByUniqueName gets the same Product.

Namestring or null
SubHeaderstring or null

Sub header from the Product in Norce.

SubDescriptionstring or null

Sub description from the Product in Norce.

Synonymsstring or null

Synonyms from the Product in Norce. Can be used when indexing the product in any search engine.

Manufacturerobject or null
CategoryIdSeedstring or null

A comma separated list of category internal id ordered so the primary category id is first.

Priceobject or null
OnHandobject or null

Information about OnHand for a given SKU. There are generally three different types of OnHand in Norce. One for the Web, one for the chosen supplier and one for any specified Store.

OnHandStoreobject or null

Information about OnHand for a given SKU. There are generally three different types of OnHand in Norce. One for the Web, one for the chosen supplier and one for any specified Store.

OnHandSupplierobject or null

Information about OnHand for a given SKU. There are generally three different types of OnHand in Norce. One for the Web, one for the chosen supplier and one for any specified Store.

VariantsArray of objects or null(VariantItem)

The Variants on this ProductItem2. Use expand option Variants to include this property or it will be null.

ImageKeystring or null(uuid)

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.

AdditionalImageKeySeedstring or null

Seed formatted as TypeId[1]:Guid[1], TypeId[2]:Guid[2],.., TypeId[n]:Guid[n].

FlagIdSeedstring or null

A comma separated list of flag internal ids.

Parametricsobject or null
StockDisplayBreakPointinteger or null(int32)

A value that can be used for display logic regarding OnHand.

IsSubscribableboolean or null

True if this product can be added in a Subscription. False otherwise.

PopularityRankinteger or null(int32)

A value used to sort items based on popularity. Lower values are more popular.

SortOrderinteger or null(int32)

A custom sort order that can be used when the product item is in a list. The sort order is defined for the primary category of the product item.

Updatedstring or null(date-time)
ImageAltTextstring or null

Default image alt text

ProductItem2PagedList

Idinteger or null(int32)

The product internal id for this ProductItem2.

Keystring or null(uuid)
PartNostring or null

Contains the part number of the primary Variant, adhering to manual sorting or if sorting isn't set - by lowest available price.

UniqueNamestring or null

A unique name that can be used in Urls and to get a Product. GetProduct and GetProductByUniqueName gets the same Product.

Namestring or null
SubHeaderstring or null

Sub header from the Product in Norce.

SubDescriptionstring or null

Sub description from the Product in Norce.

Synonymsstring or null

Synonyms from the Product in Norce. Can be used when indexing the product in any search engine.

Manufacturerobject or null
CategoryIdSeedstring or null

A comma separated list of category internal id ordered so the primary category id is first.

Priceobject or null
OnHandobject or null

Information about OnHand for a given SKU. There are generally three different types of OnHand in Norce. One for the Web, one for the chosen supplier and one for any specified Store.

OnHandStoreobject or null

Information about OnHand for a given SKU. There are generally three different types of OnHand in Norce. One for the Web, one for the chosen supplier and one for any specified Store.

OnHandSupplierobject or null

Information about OnHand for a given SKU. There are generally three different types of OnHand in Norce. One for the Web, one for the chosen supplier and one for any specified Store.

VariantsArray of objects or null(VariantItem)

The Variants on this ProductItem2. Use expand option Variants to include this property or it will be null.

ImageKeystring or null(uuid)

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.

AdditionalImageKeySeedstring or null

Seed formatted as TypeId[1]:Guid[1], TypeId[2]:Guid[2],.., TypeId[n]:Guid[n].

FlagIdSeedstring or null

A comma separated list of flag internal ids.

Parametricsobject or null
StockDisplayBreakPointinteger or null(int32)

A value that can be used for display logic regarding OnHand.

IsSubscribableboolean or null

True if this product can be added in a Subscription. False otherwise.

PopularityRankinteger or null(int32)

A value used to sort items based on popularity. Lower values are more popular.

SortOrderinteger or null(int32)

A custom sort order that can be used when the product item is in a list. The sort order is defined for the primary category of the product item.

Updatedstring or null(date-time)
ImageAltTextstring or null

Default image alt text

ProductItemPagedList

ItemCountinteger or null(int32)

Counts the number of products in the list. If the list is fetched with AsVariants set to true ItemCount will still just count the number of products. Not items in the list. When fetched with a method that has filters, this value will be to total after the filters have been applied.

ItemsArray of objects or null(ProductItem)

List of ProductItems. It is used in lists.

ProductPrice

Valuenumber or null(decimal)

The actual price value, excluding VAT. Multiply by VatRate to get the price inc VAT.

Recommendednumber or null(decimal)

The rule based price from a priceList, excluding VAT, if specified.

Catalognumber or null(decimal)

The original price, if specified.

VatRatenumber or null(decimal)

A rate to multiply with price to get price inc VAT. 25% VAT equals a VatRate of 1.25.

PriceListIdinteger or null(int32)

The priceList id for the price. If multiple priceLists are available then the best (lowest) price will be used.

IsBuyableboolean or null

Indicates if the item is buyable or not. Will always be false if the status is closed. An exception will be thrown if IsBuyable is false and an attempt to buy the item is made. The property can be used to hide or show the buy-button.

RecommendedQuantitynumber or null(decimal)

Indicates the default value used as quantity when buying the product. If IsRecommendedQuantityFixed is true, only multiples of this quantity should be allowed.

IsRecommendedQuantityFixedboolean or null

If this is set to true only multiples of RecommendedQuantity should be allowed.

Standardnumber or null(decimal)

The standard price, excluding VAT, if specified.

ValueIncVatnumber or null(decimal)

The actual price value including VAT calculated on the server side. Should be used to display prices including VAT.

CostPurchasenumber or null(decimal)

CostPurchase from Norce Admin, excluding VAT.

IsDiscountableboolean or null

Indicates if the price can be discounted by a campaign or discount code.

CurrencyIdinteger or null(int32)

The currency internal id the price values are expressed in.

ProductPriceQtyBreak

PartNostring or null

The part number for this product.

QtyBreaknumber or null(decimal)

The minimum quantity needed to purchase to receive the ProductPrice.

ProductPriceobject or null

Promotions

PromotionProducts

List of ProductItems per promotion and effect type.

PromotionIdinteger or null(int32)

This is the promotion internal id for which the Products are listed.

EffectIdinteger or null(int32)

This is the effect internal id for which the Products are listed.

ItemsArray of objects or null(ProductItem)

This is the list of Products associated with the promotion and effect.

Relations

ProductRelations

Idinteger or null(int32)

This is the type internal id for the relation type

Codestring or null

This is the type external code for the relation type

Namestring or null

This is the name of the relation type

Descriptionstring or null

This is the description of the relation type

RelationsMetadataArray of objects or null(RelationMetadataItem)

Indicates if the related items are product or variant specific

Relationsobject or null
VariantRelationsArray of objects or null(VariantRelations)

This is a list of variant relations.

RelationMetadataItem

Idinteger or null(int32)

This is the internal product id.

PartNostring or null

This is the part number if variants are specified

IsVariantSpecificboolean or null

True if relation is to specific variants.

Reviews

Review

The Review entity keeps track of customer reviews on products. It can be used to display a list of reviews on a product page. Other customers can like or dislike existing reviews.

Idinteger or null(int32)

The internal id of the review. Null or left out when creating new reviews.

ReferenceIdinteger or null(int32)

The internal product id of the review. Or if the review is for some other entity, then it is the entity Id.

Namestring or null

The name of the reviewer.

Emailstring or null

The email address of the reviewer.

Textstring or null

The review text.

Urlstring or null

A Url to some external source referenced by the reviewer.

ImagePathstring or null

A Url to some external image uploaded by the reviewer.

Scorenumber or null(decimal)

The review score, if scores are kept. It is up to the application to define the score range.

Datestring or null(date-time)

The date of the review.

Likesinteger or null(int32)

Number of likes. See UpdateProductReviewLikes for information about how to update this.

Dislikesinteger or null(int32)

Number of dislikes. See UpdateProductReviewLikes for information about how to update this.

IsPublishedboolean or null

Shows if review is published. Applications can have new reviews to not be published and later after internal review on the content have it published.

SkuTypes

SkuType

Represents the type of a SKU.

Idinteger or null(int32)

The internal id of the sku type.

Namestring or null

The name of the sku type.

Descriptionstring or null

The description of the sku type.

SortOrderinteger or null(int32)

The sort order of the sku type.

Groupobject or null

Status

No entities. See IdValues

Variants

VariantItem

Idinteger or null(int32)

The product internal id for this VariantItem.

GroupByKeystring or null

A key that group items on product. It is equal to the product id for non-variants and equals 'v'+variantId for variants. Should be used to correlate ProductItems with VariantItems.

Namestring or null

The Name of this VariantItem. Will be the same as the corresponding product if this is not a Variant.

StatusIdinteger or null(int32)

The status for this VariantItem. Valid values can be found in ListStatuses.

TypeIdinteger or null(int32)

The sku type for this VariantItem. Valid values can be found in ListSkutypes.

PartNostring or null

The partNo for this VariantItem.

ManufacturerPartNostring or null

The manufacturer's partNo for this VariantItem.

ImageKeystring or null(uuid)

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.

FlagIdSeedstring or null

A comma separated list of flag internal ids.

Priceobject or null
OnHandobject or null

Information about OnHand for a given SKU. There are generally three different types of OnHand in Norce. One for the Web, one for the chosen supplier and one for any specified Store.

OnHandStoreobject or null

Information about OnHand for a given SKU. There are generally three different types of OnHand in Norce. One for the Web, one for the chosen supplier and one for any specified Store.

OnHandSupplierobject or null

Information about OnHand for a given SKU. There are generally three different types of OnHand in Norce. One for the Web, one for the chosen supplier and one for any specified Store.

Parametricsobject or null
AdditionalImageKeySeedstring or null

Seed formatted as TypeId[1]:Guid[1], TypeId[2]:Guid[2],.., TypeId[n]:Guid[n].

EanCodestring or null

The EAN code for this VariantItem.

IsBuyableboolean or null

Indicates if the item is buyable or not. Will always be false if the status is closed. An exception will be thrown if IsBuyable is false and an attempt to buy the item is made. The property can be used to hide or show the buy-button.

UnitOfMeasurementstring or null

Short unit of measurement from Norce Admin.

UnitOfMeasurementCountnumber or null(decimal)

Unit of measurement count

RecommendedQuantitynumber or null(decimal)

Indicates the default value used as quantity when buying the product. If IsRecommendedQuantityFixed is true, only multiples of this quantity should be allowed.

IsRecommendedQuantityFixedboolean or null

If this is set to true only multiples of RecommendedQuantity should be allowed.

SubHeaderstring or null

Sub header from the Product in Norce. Only set if Product texts are variant unique.

SubDescriptionstring or null

Sub description from the Product in Norce. Only set if Product texts are variant unique.

UniqueNamestring or null

A unique name that can be used in Urls and to get a Product.

ImageAltTextstring or null

Image alt text for this Variant Item

VariantRelations

Variant specific relations for this product.

Idinteger or null(int32)

This is the product internal id for the variant

RelationsMetadataArray of objects or null(RelationMetadataItem)

Indicates if the related items are product or variant specific

Relationsobject or null

Warehouses

Warehouse

Represents a Warehouse. Used to get detailed OnHand for a product/variant or basket.

StoreIdinteger or null(int32)

The store internal id for the current store. Can be null if WarehouseId and LocationId are supplied.

WarehouseIdinteger or null(int32)

The internal id for the warehouse. Can be null if StoreId is supplied.

LocationIdinteger or null(int32)

The internal id for the warehouse location. Can be null if StoreId is supplied.

OnHandobject or null

Information about OnHand for a given SKU. There are generally three different types of OnHand in Norce. One for the Web, one for the chosen supplier and one for any specified Store.

WarehouseInfo

Represents a Warehouse with Locations and an optional Store. Used to get detailed meta data for warehouses, locations and stores.

Idinteger or null(int32)

The internal Id for the warehouse.

Typeinteger or null(int32)

The Type internal id for the warehouse. 1 for the standard warehouse, 2 if it is for a store.

Codestring or null

The external Code for the warehouse.

Namestring or null

The Name for the warehouse.

LocationsArray of objects or null(WarehouseInfoLocation)

LocationInfos for the warehouse.

IsStandardboolean or nullDeprecated

Indicates if the warehouse is standard or not.

WarehouseInfoLocation

Represents a Location for a WarehouseInfo.

Idinteger or null(int32)

The internal Id for the location.

Codestring or null

The external Code for the location.

Namestring or null

The Name for the location.

StoresArray of objects or null(WarehouseInfoStore)

A list of Stores for this location, if any.

IsStandardboolean or nullDeprecated

Indicates if the location is standard or not.

WarehouseInfoStore

Represents an optional Store for a WarehouseInfo.

Idinteger or null(int32)

The internal Id for the store.

Codestring or null

The external Code for the store.

Namestring or null

The Name for the store.