COMMERCE SERVICES
/
Product Service
/
Schemas
/
ProductOnHand

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

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
{
  "Id": 0,
  "Name": "string",
  "PartNo": "string",
  "LogoPath": "string",
  "LogoKey": "3d7d7146-aca8-4108-aa6b-ef13bcb3846c",
  "UniqueName": "string"
}

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.

{
  "ProductId": 0,
  "Warehouses": [
    { … }
  ],
  "Variants": [
    {}
  ]
}

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
{
  "Name": "string",
  "Value": "string",
  "Id": 0,
  "ValueId": 0,
  "Description": "string",
  "ValueDescription": "string",
  "IsPrimary": true,
  "ValueIdSeed": "string",
  "Value2": "string",
  "Uom": "string",
  "GroupId": 0,
  "GroupName": "string",
  "SortOrder": 0,
  "Code": "string",
  "IsHidden": true
}