STORM API
/
Product Service
/
PriceLists

Documentation ProductService (1.1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
https://demo.storm.io/api/1.1/

Assortments

Operations

Categories

Operations

Configurations

Operations

Families

Operations

Files

Operations

Filters

Operations

Flags

Operations

InfoTypes

Operations

Manufacturers

Operations

Navigation

Operations

OnHand

Operations

Parametric

Operations

PriceLists

Operations

List pricelists

Request

Lists priceLists for the client.

Query
cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

curl -i -X GET \
  https://demo.storm.io/api/1.1/ProductService.svc/rest/ListPricelists

Responses

Success

Body
Array [
Idinteger(int32)

The internal Id of the pricelist.

Namestring

The Name of the pricelist. MaxLength: 50.

Descriptionstring

The Description of the pricelist. MaxLength: max.

Agreementstring

External pricelist code usually known to the Erp-system. MaxLength: 50.

Currencyobject(ApplicationsCurrency)(ApplicationsCurrency)
IsPrimaryboolean

Specifies if this is the primary priceList or not.

IsPublicboolean

Specifies if this is a public priceList or not. Most application specific pricelists are public while customer specific are not.

IsLimitedToStockboolean

Specifies if this priceList is limited to stock or not.

IsBidboolean

Specifies if this is a bid pricelist or not.

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.

Typeinteger(int32)

Internal id representing the type of priceList. Types are client specific except for 0=None, which is the default or standard priceList type. See ListPriceListTypes for defined types.

StartDatestring or null(date-time)

The StarDate for when the pricelist is valid, if any.

EndDatestring or null(date-time)

The EndDate for when the pricelist is valid, if any.

IsVirtualboolean

Specifies if the pricelist is virtual or not. Virtual pricelists must be inherited from a parent pricelists, which cannot be virtual, and can have no population rules. Prices are not stored in Storm but calculated on the fly when needed. Rules can be specified but other properties are inherited from parent.

]
Response
[
  {
    "Id": 0,
    "Name": "string",
    "Description": "string",
    "Agreement": "string",
    "Currency": { … },
    "IsPrimary": true,
    "IsPublic": true,
    "IsLimitedToStock": true,
    "IsBid": true,
    "ImageKey": "string",
    "Type": 0,
    "StartDate": "2019-08-24T14:15:22Z",
    "EndDate": "2019-08-24T14:15:22Z",
    "IsVirtual": true
  }
]

List pricelist types

Request

Reference list of PriceList Types.

Query
cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

curl -i -X GET \
  https://demo.storm.io/api/1.1/ProductService.svc/rest/ListPricelistTypes

Responses

Success

Body
Array [
Idinteger(int32)

The internal Id of the Entity. This Id might be different in different tiers such as Stage and Production. Use Code if hard coding is required.

Valuestring

The Value of the Entity. MaxLength: max.

Codestring

The Code of the Entity, if existing. Use this value when hard coding is required. MaxLength: 255.

]
Response
[
  {
    "Id": 0,
    "Value": "string",
    "Code": "string"
  }
]

Products

Operations

Promotions

Operations

Relations

Operations

Reviews

Operations

SkuTypes

Operations

Status

Operations

Variants

Operations

Warehouses

Operations