Skip to content
COMMERCE SERVICES
/
Product Service
/
/
IdValue

Documentation ProductService (1.1)

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

Schemas

Schemas

IdNameDescription

Idinteger(int32)

The internal Id of the Entity.

Namestring

The Name of the Entity. MaxLength: 50.

Descriptionstring

The Description of the Entity. MaxLength: 500.

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.

Codestring

The Code of the Entity. MaxLength: 50.

{
  "Id": 0,
  "Name": "string",
  "Description": "string",
  "ImageKey": "string",
  "Code": "string"
}

IdValue

Idinteger(int32)

The internal Id of the Entity. This Id might be different in different tiers such as Stage and Production. Use Code if hard coding is required.

Valuestring

The Value of the Entity. MaxLength: max.

Codestring

The Code of the Entity, if existing. Use this value when hard coding is required. MaxLength: 255.

{
  "Id": 0,
  "Value": "string",
  "Code": "string"
}

ShoppingPromotion

Idinteger or null(int32)

The internal id of the Promotion.

Namestring

The Name of the Promotion. MaxLength: 255.

Headerstring

SubHeader from Storm. MaxLength: 255.

ShortDescriptionstring

DescriptionHeader from Storm. MaxLength: 255.

Description1string

Description from Storm. MaxLength: max.

Description2string

SubDescription from Storm. MaxLength: max.

StartDatestring or null(date-time)

The StartDate of the Promotion, if any. Only valid promotions will be returned.

EndDatestring or null(date-time)

The EndDate of the Promotion, if any. Only valid promotions will be returned.

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.

RequirementSeedstring

A comma separated list of fulfilled requirements for this promotion. MaxLength: max.

DiscountCodestring

Will contain the discountCode if the promotion has a discountCode requirement. MaxLength: max.

IsExcludedFromPriceCalculationboolean

A value of true means the promotion was applied last an not included in any price calculations.

AllowProductListingboolean

This flag can be checked to see whether the promotion allows listing of products from requirements. Use Products.ListProductsByPromotionRequirement to list products. Note that if this property is true and no product requirements exists, no products will be listed.

ImagesArray of objects(File)(File)

A list of additional images files uploaded for the promotion. Images can be differentiated by using different types. See ListPromotionImageTypes for available types.

ProductFiltersArray of objects(ShoppingPromotionProductFilter)(ShoppingPromotionProductFilter)

A list of productFilters for the promotion. Can be used to filter or fetch promotions matched by Products. match the products properties against the filter values Each ProductFilter must match all existing values and if any ProductFilter matches the promotion will be valid for that product.

AppliedAmountnumber or null(decimal)

Applied discount amount, excluding VAT, if fetched on AppliedPromotions property on the basket. In that case it will be the sum of all applied amounts on all Basket.Items. This value is rounded to two decimals.

EffectSeedstring

A comma separated list of applicable effects for this promotion. MaxLength: max.

FreightDiscountPctnumber or null(decimal)

FreightDiscountPct can be used to calculate external freight prices. The value is given as percentage as 100.00 for 100% discount. Only used for FreightDiscounts.

IsStackableboolean

Promotion effect quantity or basket discount is multiplied with how many times requirement is fulfilled.

AppliedAmountIncVatnumber or null(decimal)

Applied discount amount, including VAT, for this Promotion on this BasketItem.

ExclusivityTypeinteger(int32)

ExclusivityType allows setting promotions as NotExclusive = 0, Exclusive = 1, or IgnoreExclusivity = 2.

{
  "Id": 0,
  "Name": "string",
  "Header": "string",
  "ShortDescription": "string",
  "Description1": "string",
  "Description2": "string",
  "StartDate": "2019-08-24T14:15:22Z",
  "EndDate": "2019-08-24T14:15:22Z",
  "ImageKey": "string",
  "RequirementSeed": "string",
  "DiscountCode": "string",
  "IsExcludedFromPriceCalculation": true,
  "AllowProductListing": true,
  "Images": [
    { … }
  ],
  "ProductFilters": [
    { … }
  ],
  "AppliedAmount": 0,
  "EffectSeed": "string",
  "FreightDiscountPct": 0,
  "IsStackable": true,
  "AppliedAmountIncVat": 0,
  "ExclusivityType": 0
}

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