COMMERCE SERVICES
/
Product Service
/
Schemas
/
ProductItem2PagedList

Norce Commerce Product v1.1 service (1.1)

The Product namespace has Entities and Operations used for Products and other related Entities such as Prices, Filters, Categories etc. The main use of the Product service is to retrieve product data, variants, prices, and its availability to be used in a webshop or other sales channels. The Product service is read only and does not support creating or updating data in Norce. For this, use the Connect API.

Download OpenAPI description
openapi-v1.json
openapi-v1.yaml
Languages
Servers
Playground

https://{slug}.api-se.playground.norce.tech/commerce/

Stage

https://{slug}.api-se.stage.norce.tech/commerce/

Production

https://{slug}.api-se.norce.tech/commerce/

Assortments

Contains endpoints for viewing metadata about assortment types, not commonly used anymore, still in use by legacy systems.

Operations

Categories

Contains endpoints for looking up category metadata.

Operations

Configurations

Contains endpoints for working with configuration products, not currently in use.

Operations

Families

Contains endpoints for viewing product family metadata, not commonly used anymore, but still needed in legacy systems.

Operations

Files

Contains endpoints for viewing file and image metadata.

Operations

Filters

Contains endpoints for working with ProductFilter navigations. Read more about it here.

Operations

Flags

Contains endpoints for viewing product flag metadata.

Operations

InfoTypes

Contains endpoints for viewing product related extended fields, info types.

Operations

Manufacturers

Contains endpoints for viewing manufacturer information.

Operations

Navigation

Contains endpoints for viewing navigation nodes, not commonly used anymore, still in use by legacy systems.

Operations

OnHand

Contains endpoints for looking up detailed availability information.

Operations

Parametric

Contains endpoints for viewing parametric meta data and parametric data used in comparison views.

Operations

PriceLists

Contains endpoints for viewing price list data and metadata.

Operations

Products

Contains endpoints for listing, finding and viewing products, variants and its content. Read more about this here and here

Operations

Promotions

Contains endpoints for listing products based on promotion associations.

Operations

Relations

Contains endpoints for listing products based on their relations and relation metadata.

Operations

Reviews

Contains endpoints for managing product reviews, not commonly used anymore, still in use by legacy systems.

Operations

SkuTypes

Contains endpoints for looking up product type metadata.

Operations

Status

Contains endpoints for looking up product status metadata.

Operations

Variants

Contains endpoints for listing variants.

Operations

Warehouses

Contains endpoints for viewing warehouse and location information.

Operations

Schemas

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

{
  "Id": 0,
  "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
  "PartNo": "string",
  "UniqueName": "string",
  "Name": "string",
  "SubHeader": "string",
  "SubDescription": "string",
  "Synonyms": "string",
  "Manufacturer": {
    "Id": 0,
    "Name": "string",
    "PartNo": "string",
    "LogoPath": "string",
    "LogoKey": "3d7d7146-aca8-4108-aa6b-ef13bcb3846c",
    "UniqueName": "string"
  },
  "CategoryIdSeed": "string",
  "Price": {
    "Value": 0,
    "Recommended": 0,
    "Catalog": 0,
    "VatRate": 0,
    "PriceListId": 0,
    "IsBuyable": true,
    "RecommendedQuantity": 0,
    "IsRecommendedQuantityFixed": true,
    "Standard": 0,
    "ValueIncVat": 0,
    "CostPurchase": 0,
    "IsDiscountable": true,
    "CurrencyId": 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": "9afa8b7e-ca15-438f-a9d6-f679c437e59c",
  "AdditionalImageKeySeed": "string",
  "FlagIdSeed": "string",
  "Parametrics": {
    "ListSeed": "string",
    "MultipleSeed": "string",
    "ValueSeed": "string"
  },
  "StockDisplayBreakPoint": 0,
  "IsSubscribable": true,
  "PopularityRank": 0,
  "SortOrder": 0,
  "Updated": "2019-08-24T14:15:22Z",
  "ImageAltText": "string"
}

ProductItem2PagedList

ItemCountinteger or null(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 or null(ProductItem2)

List of ProductItem2. It is used in lists.

{
  "ItemCount": 0,
  "Items": [
    { … }
  ]
}

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.

{
  "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"
}