Skip to content
COMMERCE SERVICES
/
Product Service
/
/
ProductFile

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

ProductAccessories

Accessoriesobject(ProductItemPagedList)(ProductItemPagedList)
VariantAccessoriesArray of objects(VariantAccessories)(VariantAccessories)

This is a list of VariantAccessories.

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

ProductFile

Idinteger(int32)

This is the file internal id and it defines the kind of file it is. Not to be confused with entity ids. Values are application specific and should be like 'Front image', 'Back image'. See ListFileTypeIds for possible values.

Typeinteger(int32)

This is the FileTypeId mapped from Storm's predefined types. Types maps to mime types.

Pathstring

MaxLength: max. Obsolete! - Use Key

Namestring

This is the Name of the product file. MaxLength: 50.

Descriptionstring

This is the Description of the product file. MaxLength: max.

Keystring or null(guid)

A unique id for the file at our image server. Url for images are formed like http://[client specific CDN]/{Key}. Preset, height and width can be sent as parameters.

Extensionstring

This is the file type extension for the current file. Can be used to append after image key in url. MaxLength: 50.

Codestring

This is the file's external Code. Can be use as is for grouping files if Id is not adequate. Or any other application specific purpose. MaxLength: 50.

SortOrderinteger or null(int32)

This is the sortorder of the file within its file type Id.

ImageAltTextstring

Image alt text

{
  "Id": 0,
  "Type": 0,
  "Path": "string",
  "Name": "string",
  "Description": "string",
  "Key": "string",
  "Extension": "string",
  "Code": "string",
  "SortOrder": 0,
  "ImageAltText": "string"
}

ProductId

Idinteger(int32)

Internal product id.

Namestring

MaxLength: 255.

ManufacturerNamestring

MaxLength: 100.

Pricenumber(decimal)

The best price excluding VAT for the product.

VatRatenumber(decimal)

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

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.

UniqueNamestring

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

CategoryIdinteger or null(int32)
PriceIncVatnumber(decimal)

The price including VAT calculated on the server side. Should be used to display prices including VAT.

{
  "Id": 0,
  "Name": "string",
  "ManufacturerName": "string",
  "Price": 0,
  "VatRate": 0,
  "ImageKey": "string",
  "UniqueName": "string",
  "CategoryId": 0,
  "PriceIncVat": 0
}

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