Skip to content
STORM API
/
Customer Service
/
/
PricelistItem

Documentation CustomerService (1.1)

The Customers namespace has Entities and Operations concerned with Customer and Company management.

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

Schemas

Schemas

Pricelist

Idinteger or null(int32)

The internal pricelist id. Set to null when creating a new pricelist.

ParentIdinteger or null(int32)

The parent internal pricelist id. If any.

Namestring

The name of the pricelist. MaxLength: 50.

Descriptionstring

The description of the pricelist. MaxLength: max.

Agreementstring

The agreement code of the pricelist. Can be an external id of the priceList. MaxLength: 50.

Typeinteger(int32)

The type of the pricelist. 0 is default. Other values are application specific.

IsActiveboolean

Specifies if the pricelist is active or not. Set this to false before update if you want to delete the pricelist.

PriceRuleobject(PricelistPriceRule)(PricelistPriceRule)
PopulationRulesArray of objects(PricelistPopulationRule)(PricelistPopulationRule)

A list of population rules for this pricelist.

CurrencyIdinteger(int32)

The currencyId for this pricelist.

IsExclusiveboolean

Indicates if the pricelist should be used exclusively for this Company, or not. Exclusive pricelists are not used with any standard pricelists and only exclusive pricelists will be in scope if the Company has any.

{
  "Id": 0,
  "ParentId": 0,
  "Name": "string",
  "Description": "string",
  "Agreement": "string",
  "Type": 0,
  "IsActive": true,
  "PriceRule": {
    "RuleId": 0,
    "Value": 0
  },
  "PopulationRules": [
    { … }
  ],
  "CurrencyId": 0,
  "IsExclusive": true
}

PricelistItem

PartNostring

PartNo of the SKU for this price item. MaxLength: 50.

PricelistIdinteger(int32)

The internal pricelist id.

Pricenumber(decimal)

The price. Read only. Currency is from the pricelist.

PriceRecommendednumber or null(decimal)

The price from inherited pricelist, if any.

IsActiveboolean

Specifies if the pricelist item is active or not. Ignored when inserting new pricelist items.

PriceRuleobject(PricelistPriceRule)(PricelistPriceRule)
{
  "PartNo": "string",
  "PricelistId": 0,
  "Price": 0,
  "PriceRecommended": 0,
  "IsActive": true,
  "PriceRule": {
    "RuleId": 0,
    "Value": 0
  }
}

PricelistPopulationRule

RuleIdinteger or null(int32)

An internal id for a specific rule. Set to null when creating a rule.

ManufacturerIdinteger or null(int32)

An optional internal manufacturer id. Used if the priceList is restricted to a specific manufacturer.

CategoryIdinteger or null(int32)

An optional internal category id. Used if the priceList is restricted to a specific category.

IsSupplierRequiredboolean

Specifies if the populations is from a supplier.

IsInclusiveboolean

Specifies if the population rule is inclusive or exclusive.

{
  "RuleId": 0,
  "ManufacturerId": 0,
  "CategoryId": 0,
  "IsSupplierRequired": true,
  "IsInclusive": true
}

Accounts

Operations

Address

Operations

Companies

Operations

Contacts

Operations

Customers

Operations

Flags

Operations

InfoTypes

Operations

PriceLists

Operations