STORM API

Shopping Service

Documentation ShoppingService (1.1)

Entities and methods to handle baskets and payments.

Download OpenAPI description

openapi.json

openapi.yaml

Servers

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

Basket

Operations

Checkout

Operations

DeliveryMethods

Operations

List delivery methods by basket

Request

Query

basketIdinteger(int32)required

The internal basket id.

countryIdstring

Internal id that specifies in which country. If none is supplied, value is resolved from Application default.

zipstringrequired

Zip code for filtration.

customerIdstring

Current internal customer id, checks for specific customer bound delivery methods.

companyIdstring

Current internal company id, checks for specific company bound delivery methods.

cultureCodestring

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

currencyIdstring

Internal id that specifies in which currency to display prices. If none is supplied, value is resolved from Application.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ShoppingService.svc/rest/ListDeliveryMethodsByBasket?basketId=0&zip=string'

Responses

Success

Body

Array [

Idinteger(int32)

The internal id of the DeliveryMethod.

Namestring

The Name of the DeliveryMethod. MaxLength: 50.

TypeIdinteger(int32)

The internal type id of the DeliveryMethod. DeliveryMethodTypes are logical groupings of different types such as home delivery, pickup and such.

TypeNamestring

The TypeName of the DeliveryMethodType. MaxLength: 50.

Descriptionstring

The Description of the DeliveryMethod. MaxLength: max.

PartNostring

The part number, if any, of the product representing the DeliveryMethod. Products setup for delivery methods must have a SkuType equal to Freight. These are handled by Storm and added and removed automatically. MaxLength: 50.

Pricenumber(decimal)

The Price of the DeliveryMethod, excluding VAT.

VatRatenumber(decimal)

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

IsNotifiableboolean

Indicates if the DeliveryMethod has delivery notifications.

ImagePathstring

MaxLength: 255. Obsolete! - Use ImageKey with preset

IsSelectedboolean

IsSelected is set to true for the currently selected DeliveryMethod on baskets. All other DeliveryMethods have this set to false. If no DeliveryMethod has been set all will have this value set to false.

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.

IsForCompanyOnlyboolean

Indicates if the DeliveryMethod has is for Companies only.

IsForPersonOnlyboolean

Indicates if the DeliveryMethod has is for Customers only.

Costnumber(decimal)

The Cost of the DeliveryMethod.

StoreIdinteger or null(int32)

The internal store id of any Store connected to this DeliveryMethod. Most often this will be set if ZipCode mappings exist in Storm.

WarehouseIdinteger or null(int32)

The internal warehouse id of any Warehouse connected to this DeliveryMethod. Most often this will be set if ZipCode mappings exist in Storm.

LocationIdinteger or null(int32)

The internal location id of any WarehouseLocation connected to this DeliveryMethod. Most often this will be set if ZipCode mappings exist in Storm.

DropPointsArray of objects(DropPoint)(DropPoint)

A list of DropPoint, if any, for the DeliveryMethod. These are not kept in Storm but fetched from integrated DeliveryMethod providers such as ShipAdvisor.

Codestring

An external Code for the DeliveryMethod. MaxLength: 50.

Carrierstring

Optional information about carrier MaxLength: 50.

]

Response

[
  {
    "Id": 0,
    "Name": "string",
    "TypeId": 0,
    "TypeName": "string",
    "Description": "string",
    "PartNo": "string",
    "Price": 0,
    "VatRate": 0,
    "IsNotifiable": true,
    "ImagePath": "string",
    "IsSelected": true,
    "ImageKey": "string",
    "IsForCompanyOnly": true,
    "IsForPersonOnly": true,
    "Cost": 0,
    "StoreId": 0,
    "WarehouseId": 0,
    "LocationId": 0,
    "DropPoints": [ … ],
    "Code": "string",
    "Carrier": "string"
  }
]

List delivery methods by basket (v2)

Request

Query

basketIdinteger(int32)required

The internal basket id.

countryIdstring

Internal id that specifies in which country. If none is supplied, value is resolved from Application default.

zipstringrequired

Zip code for filtration.

customerIdstring

Current internal customer id, checks for specific customer bound delivery methods.

companyIdstring

Current internal company id, checks for specific company bound delivery methods.

dropPointSizestring

Maximum number of dropPoints to return for each delivery method.

cultureCodestring

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

currencyIdstring

Internal id that specifies in which currency to display prices. If none is supplied, value is resolved from Application.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ShoppingService.svc/rest/ListDeliveryMethodsByBasket2?basketId=0&zip=string'

Responses

Success

Body

Array [

Idinteger(int32)

The internal id of the DeliveryMethod.

Namestring

The Name of the DeliveryMethod. MaxLength: 50.

TypeIdinteger(int32)

The internal type id of the DeliveryMethod. DeliveryMethodTypes are logical groupings of different types such as home delivery, pickup and such.

TypeNamestring

The TypeName of the DeliveryMethodType. MaxLength: 50.

Descriptionstring

The Description of the DeliveryMethod. MaxLength: max.

PartNostring

Pricenumber(decimal)

The Price of the DeliveryMethod, excluding VAT.

VatRatenumber(decimal)

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

IsNotifiableboolean

Indicates if the DeliveryMethod has delivery notifications.

ImagePathstring

MaxLength: 255. Obsolete! - Use ImageKey with preset

IsSelectedboolean

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.

IsForCompanyOnlyboolean

Indicates if the DeliveryMethod has is for Companies only.

IsForPersonOnlyboolean

Indicates if the DeliveryMethod has is for Customers only.

Costnumber(decimal)

The Cost of the DeliveryMethod.

StoreIdinteger or null(int32)

The internal store id of any Store connected to this DeliveryMethod. Most often this will be set if ZipCode mappings exist in Storm.

WarehouseIdinteger or null(int32)

The internal warehouse id of any Warehouse connected to this DeliveryMethod. Most often this will be set if ZipCode mappings exist in Storm.

LocationIdinteger or null(int32)

The internal location id of any WarehouseLocation connected to this DeliveryMethod. Most often this will be set if ZipCode mappings exist in Storm.

DropPointsArray of objects(DropPoint)(DropPoint)

A list of DropPoint, if any, for the DeliveryMethod. These are not kept in Storm but fetched from integrated DeliveryMethod providers such as ShipAdvisor.

Codestring

An external Code for the DeliveryMethod. MaxLength: 50.

Carrierstring

Optional information about carrier MaxLength: 50.

]

Response

[
  {
    "Id": 0,
    "Name": "string",
    "TypeId": 0,
    "TypeName": "string",
    "Description": "string",
    "PartNo": "string",
    "Price": 0,
    "VatRate": 0,
    "IsNotifiable": true,
    "ImagePath": "string",
    "IsSelected": true,
    "ImageKey": "string",
    "IsForCompanyOnly": true,
    "IsForPersonOnly": true,
    "Cost": 0,
    "StoreId": 0,
    "WarehouseId": 0,
    "LocationId": 0,
    "DropPoints": [ … ],
    "Code": "string",
    "Carrier": "string"
  }
]

List delivery methods by product [Obsolete("Use ListDeliveryMethodsByProduct2")]

Request

Query

productIdinteger(int32)required

The internal product id for the product to list available delivery methods for.

countryIdstring

Internal id that specifies in which country. If none is supplied, value is resolved from Application default.

zipstringrequired

Zip code for filtration.

cultureCodestring

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

currencyIdstring

Internal id that specifies in which currency to display prices. If none is supplied, value is resolved from Application.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ShoppingService.svc/rest/ListDeliveryMethodsByProduct?productId=0&zip=string'

Responses

Success

Body

Array [

Idinteger(int32)

The internal id of the DeliveryMethod.

Namestring

The Name of the DeliveryMethod. MaxLength: 50.

TypeIdinteger(int32)

The internal type id of the DeliveryMethod. DeliveryMethodTypes are logical groupings of different types such as home delivery, pickup and such.

TypeNamestring

The TypeName of the DeliveryMethodType. MaxLength: 50.

Descriptionstring

The Description of the DeliveryMethod. MaxLength: max.

PartNostring

Pricenumber(decimal)

The Price of the DeliveryMethod, excluding VAT.

VatRatenumber(decimal)

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

IsNotifiableboolean

Indicates if the DeliveryMethod has delivery notifications.

ImagePathstring

MaxLength: 255. Obsolete! - Use ImageKey with preset

IsSelectedboolean

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.

IsForCompanyOnlyboolean

Indicates if the DeliveryMethod has is for Companies only.

IsForPersonOnlyboolean

Indicates if the DeliveryMethod has is for Customers only.

Costnumber(decimal)

The Cost of the DeliveryMethod.

StoreIdinteger or null(int32)

The internal store id of any Store connected to this DeliveryMethod. Most often this will be set if ZipCode mappings exist in Storm.

WarehouseIdinteger or null(int32)

The internal warehouse id of any Warehouse connected to this DeliveryMethod. Most often this will be set if ZipCode mappings exist in Storm.

LocationIdinteger or null(int32)

The internal location id of any WarehouseLocation connected to this DeliveryMethod. Most often this will be set if ZipCode mappings exist in Storm.

DropPointsArray of objects(DropPoint)(DropPoint)

A list of DropPoint, if any, for the DeliveryMethod. These are not kept in Storm but fetched from integrated DeliveryMethod providers such as ShipAdvisor.

Codestring

An external Code for the DeliveryMethod. MaxLength: 50.

Carrierstring

Optional information about carrier MaxLength: 50.

]

Response

[
  {
    "Id": 0,
    "Name": "string",
    "TypeId": 0,
    "TypeName": "string",
    "Description": "string",
    "PartNo": "string",
    "Price": 0,
    "VatRate": 0,
    "IsNotifiable": true,
    "ImagePath": "string",
    "IsSelected": true,
    "ImageKey": "string",
    "IsForCompanyOnly": true,
    "IsForPersonOnly": true,
    "Cost": 0,
    "StoreId": 0,
    "WarehouseId": 0,
    "LocationId": 0,
    "DropPoints": [ … ],
    "Code": "string",
    "Carrier": "string"
  }
]

List delivery methods by product (v2)

Request

Query

productIdinteger(int32)required

The internal product id for the product to list available delivery methods for.

countryIdstring

Internal id that specifies in which country. If none is supplied, value is resolved from Application default.

zipstringrequired

Zip code for filtration.

customerIdstring

Current internal customer id, checks for specific customer bound delivery methods.

companyIdstring

Current internal company id, checks for specific company bound delivery methods.

cultureCodestring

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

currencyIdstring

Internal id that specifies in which currency to display prices. If none is supplied, value is resolved from Application.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ShoppingService.svc/rest/ListDeliveryMethodsByProduct2?productId=0&zip=string'

Responses

Success

Body

Array [

Idinteger(int32)

The internal id of the DeliveryMethod.

Namestring

The Name of the DeliveryMethod. MaxLength: 50.

TypeIdinteger(int32)

The internal type id of the DeliveryMethod. DeliveryMethodTypes are logical groupings of different types such as home delivery, pickup and such.

TypeNamestring

The TypeName of the DeliveryMethodType. MaxLength: 50.

Descriptionstring

The Description of the DeliveryMethod. MaxLength: max.

PartNostring

Pricenumber(decimal)

The Price of the DeliveryMethod, excluding VAT.

VatRatenumber(decimal)

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

IsNotifiableboolean

Indicates if the DeliveryMethod has delivery notifications.

ImagePathstring

MaxLength: 255. Obsolete! - Use ImageKey with preset

IsSelectedboolean

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.

IsForCompanyOnlyboolean

Indicates if the DeliveryMethod has is for Companies only.

IsForPersonOnlyboolean

Indicates if the DeliveryMethod has is for Customers only.

Costnumber(decimal)

The Cost of the DeliveryMethod.

StoreIdinteger or null(int32)

The internal store id of any Store connected to this DeliveryMethod. Most often this will be set if ZipCode mappings exist in Storm.

WarehouseIdinteger or null(int32)

The internal warehouse id of any Warehouse connected to this DeliveryMethod. Most often this will be set if ZipCode mappings exist in Storm.

LocationIdinteger or null(int32)

The internal location id of any WarehouseLocation connected to this DeliveryMethod. Most often this will be set if ZipCode mappings exist in Storm.

DropPointsArray of objects(DropPoint)(DropPoint)

A list of DropPoint, if any, for the DeliveryMethod. These are not kept in Storm but fetched from integrated DeliveryMethod providers such as ShipAdvisor.

Codestring

An external Code for the DeliveryMethod. MaxLength: 50.

Carrierstring

Optional information about carrier MaxLength: 50.

]

Response

[
  {
    "Id": 0,
    "Name": "string",
    "TypeId": 0,
    "TypeName": "string",
    "Description": "string",
    "PartNo": "string",
    "Price": 0,
    "VatRate": 0,
    "IsNotifiable": true,
    "ImagePath": "string",
    "IsSelected": true,
    "ImageKey": "string",
    "IsForCompanyOnly": true,
    "IsForPersonOnly": true,
    "Cost": 0,
    "StoreId": 0,
    "WarehouseId": 0,
    "LocationId": 0,
    "DropPoints": [ … ],
    "Code": "string",
    "Carrier": "string"
  }
]

InfoTypes

Operations

OnHand

Operations

OrderRequest

Operations

Payments

Operations

Promotions

Operations

Subscriptions

Operations

Documentation ShoppingService (1.1)

Basket

Checkout

DeliveryMethods

List delivery methods by basket

Request

Responses

Did the information on the page help you?

List delivery methods by basket (v2)

Request

Responses

Did the information on the page help you?

List delivery methods by product [Obsolete("Use ListDeliveryMethodsByProduct2")]

Request

Responses

Did the information on the page help you?

List delivery methods by product (v2)

Request

Responses

Did the information on the page help you?

InfoTypes

OnHand

OrderRequest

Payments

Promotions

Subscriptions