Skip to content
COMMERCE SERVICES
/
Product Service
/
/
ProductOnHand

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

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

ProductOnHand

ProductIdinteger(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(Warehouse)(Warehouse)

A list of warehouses with OnHand for the product.

VariantsArray of objects(ProductOnHand)(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

MaxLength: 50.

Valuestring

MaxLength: max. Obsolete! - Use Value2 with Uom

Idinteger(int32)

Internal product parametric id.

ValueIdinteger or null(int32)

Parametric value internal id if the parametric type is single list value.

Descriptionstring
ValueDescriptionstring

MaxLength: max.

IsPrimaryboolean
ValueIdSeedstring

MaxLength: max.

Value2string

The parametric value, if not a ListValue or a MultiValue parametric. MaxLength: max.

Uomstring

The unit of measurement, if any. MaxLength: 50.

GroupIdinteger(int32)

Id of the parametric group.

GroupNamestring

Name of the parametric group. MaxLength: 50.

SortOrderinteger(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

An external application specific code use to identify this Parametric. MaxLength: 50.

IsHiddenboolean

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.

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

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