Skip to content
COMMERCE SERVICES
/
Product Service
/
/
ProductItemPagedList

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

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

ProductItemPagedList

ItemCountinteger(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(ProductItem)(ProductItem)
{
  "ItemCount": 0,
  "Items": [
    { … }
  ]
}

ProductManufacturer

Idinteger(int32)

Internal id of manufacturer.

Namestring

MaxLength: 255.

PartNostring

MaxLength: 50.

LogoPathstring

MaxLength: 255. Obsolete! - Use ImageKey

LogoKeystring or null(guid)

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

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

{
  "Id": 0,
  "Name": "string",
  "PartNo": "string",
  "LogoPath": "string",
  "LogoKey": "string",
  "UniqueName": "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