Skip to content
COMMERCE SERVICES
/
Product Service
/
/
ProductItem2PagedList

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

ProductItem2

Idinteger(int32)

The product internal id for this ProductItem2.

Keystring(guid)
Namestring

MaxLength: 255.

Manufacturerobject(ProductManufacturer)(ProductManufacturer)
CategoryIdSeedstring

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

PartNostring

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

Priceobject(ProductPrice)(ProductPrice)
OnHandobject(OnHand)(OnHand)
OnHandStoreobject(OnHand)(OnHand)
OnHandSupplierobject(OnHand)(OnHand)
VariantsArray of objects(VariantItem)(VariantItem)

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

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.

AdditionalImageKeySeedstring

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

FlagIdSeedstring

A comma separated list of flag internal ids. MaxLength: max.

Parametricsobject(ParametricsSeed)(ParametricsSeed)
UniqueNamestring

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

SubHeaderstring

Sub header from the Product in Storm. MaxLength: 255.

SubDescriptionstring

Sub description from the Product in Storm. MaxLength: max.

Synonymsstring

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

StockDisplayBreakPointinteger or null(int32)

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

IsSubscribableboolean

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

Default image alt text

{
  "Id": 0,
  "Key": "string",
  "Name": "string",
  "Manufacturer": {
    "Id": 0,
    "Name": "string",
    "PartNo": "string",
    "LogoPath": "string",
    "LogoKey": "string",
    "UniqueName": "string"
  },
  "CategoryIdSeed": "string",
  "PartNo": "string",
  "Price": {
    "Value": 0,
    "Recommended": 0,
    "Catalog": 0,
    "VatRate": 0,
    "PriceListId": 0,
    "IsBuyable": true,
    "RecommendedQuantity": 0,
    "IsRecommendedQuantityFixed": true,
    "Standard": 0,
    "ValueIncVat": 0
  },
  "OnHand": {
    "Value": 0,
    "IncomingValue": 0,
    "NextDeliveryDate": "2019-08-24T14:15:22Z",
    "LeadtimeDayCount": 0,
    "LastChecked": "2019-08-24T14:15:22Z",
    "IsActive": true,
    "IsReturnable": true,
    "Info": [ … ]
  },
  "OnHandStore": {
    "Value": 0,
    "IncomingValue": 0,
    "NextDeliveryDate": "2019-08-24T14:15:22Z",
    "LeadtimeDayCount": 0,
    "LastChecked": "2019-08-24T14:15:22Z",
    "IsActive": true,
    "IsReturnable": true,
    "Info": [ … ]
  },
  "OnHandSupplier": {
    "Value": 0,
    "IncomingValue": 0,
    "NextDeliveryDate": "2019-08-24T14:15:22Z",
    "LeadtimeDayCount": 0,
    "LastChecked": "2019-08-24T14:15:22Z",
    "IsActive": true,
    "IsReturnable": true,
    "Info": [ … ]
  },
  "Variants": [
    { … }
  ],
  "ImageKey": "string",
  "AdditionalImageKeySeed": "string",
  "FlagIdSeed": "string",
  "Parametrics": {
    "ListSeed": "string",
    "MultipleSeed": "string",
    "ValueSeed": "string"
  },
  "UniqueName": "string",
  "SubHeader": "string",
  "SubDescription": "string",
  "Synonyms": "string",
  "StockDisplayBreakPoint": 0,
  "IsSubscribable": true,
  "PopularityRank": 0,
  "SortOrder": 0,
  "Updated": "2019-08-24T14:15:22Z",
  "ImageAltText": "string"
}

ProductItem2PagedList

ItemCountinteger(int32)

Counts the number of products 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(ProductItem2)(ProductItem2)
{
  "ItemCount": 0,
  "Items": [
    { … }
  ]
}

ProductItemFilterValues

ProductIdinteger(int32)

Internal product id.

GroupByKeystring

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.

CategoryIdinteger or null(int32)

Internal category id.

ManufacturerIdinteger or null(int32)

Internal manufacturer id.

FlagIdSeedstring

A comma separated list of flag internal ids. MaxLength: max.

Pricenumber(decimal)

Best price excluding VAT.

VatRatenumber(decimal)

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

OnHandobject(OnHand)(OnHand)
OnHandStoreobject(OnHand)(OnHand)
OnHandSupplierobject(OnHand)(OnHand)
ParametricListSeedstring

MaxLength: max.

ParametricMultipleSeedstring

MaxLength: max.

ParametricValueSeedstring

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. MaxLength: max.

{
  "ProductId": 0,
  "GroupByKey": "string",
  "CategoryId": 0,
  "ManufacturerId": 0,
  "FlagIdSeed": "string",
  "Price": 0,
  "VatRate": 0,
  "OnHand": {
    "Value": 0,
    "IncomingValue": 0,
    "NextDeliveryDate": "2019-08-24T14:15:22Z",
    "LeadtimeDayCount": 0,
    "LastChecked": "2019-08-24T14:15:22Z",
    "IsActive": true,
    "IsReturnable": true,
    "Info": [ … ]
  },
  "OnHandStore": {
    "Value": 0,
    "IncomingValue": 0,
    "NextDeliveryDate": "2019-08-24T14:15:22Z",
    "LeadtimeDayCount": 0,
    "LastChecked": "2019-08-24T14:15:22Z",
    "IsActive": true,
    "IsReturnable": true,
    "Info": [ … ]
  },
  "OnHandSupplier": {
    "Value": 0,
    "IncomingValue": 0,
    "NextDeliveryDate": "2019-08-24T14:15:22Z",
    "LeadtimeDayCount": 0,
    "LastChecked": "2019-08-24T14:15:22Z",
    "IsActive": true,
    "IsReturnable": true,
    "Info": [ … ]
  },
  "ParametricListSeed": "string",
  "ParametricMultipleSeed": "string",
  "ParametricValueSeed": "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