STORM API
/
Shopping Service
/
Schemas
/
BasketItem

Documentation ShoppingService (1.1)

Entities and methods to handle baskets and payments.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers

https://demo.storm.io/api/1.1/

Schemas

BasketDeliveryMethodUpdate

Idinteger(int32)

The internal id of the DeliveryMethod.

Pricenumber or null(decimal)

The Price of the DeliveryMethod, excluding VAT. Prices set here will be handled as manual prices. If not set the Price will be taken from Storm and be treated as a normal price.

DropPointobject(DropPoint)(DropPoint)
Codestring

An external Code for the DeliveryMethod. This should not be set if the Code defined in Storm is to be used. MaxLength: 50.

Carrierstring

The carrier providing the delivery method MaxLength: 50.

{
  "Id": 0,
  "Price": 0,
  "DropPoint": {
    "Code": "string",
    "RoutingCode": "string",
    "Depot": "string",
    "Name1": "string",
    "Name2": "string",
    "Address1": "string",
    "Address2": "string",
    "PostalCode": "string",
    "City": "string",
    "CountryCode": "string",
    "Contact": "string",
    "Phone": "string",
    "Fax": "string",
    "Email": "string",
    "Latitude": 0.1,
    "Longitude": 0.1,
    "Distance": 0.1,
    "OpeningHours": [ … ],
    "IsSelected": true
  },
  "Code": "string",
  "Carrier": "string"
}

BasketItem

Idinteger or null(int32)

Internal id of the basket item. Used to refer to this particular row in different methods.

LineNointeger(int32)

Line number of the item. Used to refer to this particular row in different methods.

ParentLineNointeger or null(int32)

If this item is part of a bundle, an attached item from promotion or such this property will refer to the associated line number.

ProductIdinteger(int32)

Internal product id of the product for this basket item.

PartNostring

The PartNo of this Item. Must be specified when adding items to a basket. MaxLength: 50.

ManufacturerPartNostring

Manufacturer part number. Populated by Storm. MaxLength: 50.

Namestring

Name of the product. Populated by Storm. MaxLength: 255.

SubHeaderstring

Sub header of the product. Populated by Storm. MaxLength: 255.

ThumbnailImagestring

MaxLength: 255. Obsolete! - Use ImageKey with preset

FlagIdSeedstring

A comma separated list of internal flag ids. MaxLength: max.

Typeinteger(int32)

The internal type id of the underlying product. See ListSkuTypes under Products.

PriceDisplaynumber(decimal)

This is the price, excluding VAT, after applying company discounts and promotions. It is what the customer is paying.

Pricenumber or null(decimal)

This is the snapshot value, excluding VAT, of PriceDisplay when the basket is bought. Should be null. Can be used to set a price from the application when updating or creating BasketItems. Then IsPriceManual must be set to true as well.

PriceOriginalnumber(decimal)

This is the original price of the SKU, excluding VAT.

Costnumber or null(decimal)

CostPurchase from Storm Admin, excluding VAT.

VatRatenumber(decimal)

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

Quantitynumber(decimal)

The Quantity of this Item. Must be specified when adding items to a basket.

UOMstring

MaxLength: 50.

UOMCountnumber or null(decimal)
Commentstring

Free text comment for this basket item. MaxLength: 255.

PriceListIdinteger(int32)

The internal pricelist id of this Item. Must be specified when adding items to a basket. Use the PriceListId from Product or ProductItem.

ReferIdinteger or null(int32)

Used to tag a BasketItem with some external id.

ReferUrlstring

Used to tag a BasketItem with an incoming URL. MaxLength: 255.

IsEditableboolean

Indicates if a basket item is editable or not. This can happen when the API splits rows in promotions. Can be checked to see if an item should be allowed for UpdateBasketItem.

IsDiscountableboolean
InfoArray of objects(ExtraInfo)(ExtraInfo)

List of information types and values associated with this particular basket item.

OptionalItemsArray of objects(BasketItem)(BasketItem)
OnHandValuenumber(decimal)

Obsolete! - Moved to OnHand property

IncomingValuenumber(decimal)

Obsolete! - Moved to OnHand property

NextDeliveryDatestring or null(date-time)

Obsolete! - Moved to OnHand property

LeadtimeDayCountinteger or null(int32)

Obsolete! - Moved to OnHand property

PromotionIdSeedstring

Internal ids of promotions applied on this product. MaxLength: max.

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.

ManufacturerNamestring

Name of the manufacturer of the product. Populated by Storm. MaxLength: 100.

CategoryIdinteger or null(int32)

Obsolete! - Use CategoryIdSeed

OnHandobject(ProductsOnHand)(ProductsOnHand)
OnHandSupplierobject(ProductsOnHand)(ProductsOnHand)
PriceRecommendednumber or null(decimal)

The rule based price, excluding VAT, from a priceList, if specified.

ManufacturerIdinteger(int32)

Internal manufacturer id for the product. Populated by Storm.

UniqueNamestring

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

StatusIdinteger(int32)

The status of the underlying product. Lookup references in ListStatuses.

StockDisplayBreakPointinteger or null(int32)

A value that can be used for display logic regarding OnHand.

PriceCatalognumber or null(decimal)

The original price, excluding VAT, if specified.

IsBuyableboolean

Indicates if the item is buyable or not. Will always be false if the status is closed. An exception will be thrown if IsBuyable is false and an attempt to buy the item is made.

SubDescriptionstring

Sub description from Storm Admin. MaxLength: max.

CategoryIdSeedstring

A comma separated list of internal category ids ordered so the primary category is first. MaxLength: max.

RecommendedQuantitynumber or null(decimal)

Indicates the default value used as quantity when buying the product. If IsRecommendedQuantityFixed is true, only multiples of this quantity should be allowed.

IsRecommendedQuantityFixedboolean

If this is set to true only multiples of RecommendedQuantity should be allowed.

AppliedPromotionsArray of objects(AppliedPromotionOnItem)(AppliedPromotionOnItem)

Applied promotions for this item, if any. It will contain some info about what promotion was applied and amount applied.

RequirementPromotionIdSeedstring

A comma separated list of promotion internal ids for this item that are fulfilling the requirements. MaxLength: max.

IsSubscribableboolean

True if this item can be added to a Subscription. False otherwise. Can be used when copying BasketItems from one Basket to a TemplateBasket in a Subacription.

DescriptionHeaderstring

DescriptionHeader for the product as specified in Storm Admin. MaxLength: 255.

IsPriceManualboolean

Used when setting price on a BasketItem from the application. Manual prices are not discountable when applying promotions or company discounts.

PriceStandardnumber or null(decimal)

The standard price, excluding VAT, if specified.

EanCodestring

SKU EAN code. MaxLength: 50.

CostUnitnumber or null(decimal)

CostUnit, excluding VAT, from Storm Admin.

PriceDisplayIncVatnumber(decimal)

This is the price including VAT after applying company discounts and promotions. It is what the customer is paying.

PriceListLockedboolean or null

Set to true to exclude this item's price list from business logic when selecting cheapest price. Will be set to false if price list is unavailable.

PriceOriginalIncVatnumber(decimal)

This is the original price of the SKU, including VAT.

PriceRecommendedIncVatnumber or null(decimal)

The rule based price, including VAT, from a priceList, if specified.

PriceCatalogIncVatnumber or null(decimal)

The original price, including VAT, if specified.

PriceStandardIncVatnumber or null(decimal)

The standard price, including VAT, if specified.

{
  "Id": 0,
  "LineNo": 0,
  "ParentLineNo": 0,
  "ProductId": 0,
  "PartNo": "string",
  "ManufacturerPartNo": "string",
  "Name": "string",
  "SubHeader": "string",
  "ThumbnailImage": "string",
  "FlagIdSeed": "string",
  "Type": 0,
  "PriceDisplay": 0,
  "Price": 0,
  "PriceOriginal": 0,
  "Cost": 0,
  "VatRate": 0,
  "Quantity": 0,
  "UOM": "string",
  "UOMCount": 0,
  "Comment": "string",
  "PriceListId": 0,
  "ReferId": 0,
  "ReferUrl": "string",
  "IsEditable": true,
  "IsDiscountable": true,
  "Info": [
    { … }
  ],
  "OptionalItems": [
    {}
  ],
  "OnHandValue": 0,
  "IncomingValue": 0,
  "NextDeliveryDate": "2019-08-24T14:15:22Z",
  "LeadtimeDayCount": 0,
  "PromotionIdSeed": "string",
  "ImageKey": "string",
  "ManufacturerName": "string",
  "CategoryId": 0,
  "OnHand": {
    "Value": 0,
    "IncomingValue": 0,
    "NextDeliveryDate": "2019-08-24T14:15:22Z",
    "LeadtimeDayCount": 0,
    "LastChecked": "2019-08-24T14:15:22Z",
    "IsActive": true,
    "IsReturnable": true,
    "Info": [ … ]
  },
  "OnHandSupplier": {
    "Value": 0,
    "IncomingValue": 0,
    "NextDeliveryDate": "2019-08-24T14:15:22Z",
    "LeadtimeDayCount": 0,
    "LastChecked": "2019-08-24T14:15:22Z",
    "IsActive": true,
    "IsReturnable": true,
    "Info": [ … ]
  },
  "PriceRecommended": 0,
  "ManufacturerId": 0,
  "UniqueName": "string",
  "StatusId": 0,
  "StockDisplayBreakPoint": 0,
  "PriceCatalog": 0,
  "IsBuyable": true,
  "SubDescription": "string",
  "CategoryIdSeed": "string",
  "RecommendedQuantity": 0,
  "IsRecommendedQuantityFixed": true,
  "AppliedPromotions": [
    { … }
  ],
  "RequirementPromotionIdSeed": "string",
  "IsSubscribable": true,
  "DescriptionHeader": "string",
  "IsPriceManual": true,
  "PriceStandard": 0,
  "EanCode": "string",
  "CostUnit": 0,
  "PriceDisplayIncVat": 0,
  "PriceListLocked": true,
  "PriceOriginalIncVat": 0,
  "PriceRecommendedIncVat": 0,
  "PriceCatalogIncVat": 0,
  "PriceStandardIncVat": 0
}

BasketPagedList

ItemCountinteger(int32)

Total number of baskets.

ItemsArray of objects(Basket)(Basket)

List of baskets.

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

Basket

Operations

Checkout

Operations

DeliveryMethods

Operations

InfoTypes

Operations

OnHand

Operations

OrderRequest

Operations

Payments

Operations

Promotions

Operations

Subscriptions

Operations