Skip to content
STORM API
/
Shopping Service
/
/
List basket statuses

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/

Basket

Operations

List baskets by status

Request

Returns a paged basket list for specified customer, company or sales contact.

Query
companyIdstringrequired

The internal company id for which baskets are fetched. Either this a customerId or salesContactId must be specified.

customerIdstringrequired

The internal customer id for which baskets are fetched. Either this a companyId or salesContactId must be specified.

salesContactIdstringrequired

The internal salesContact id for which baskets are fetched. Either this a companyId or customerId must be specified.

statusIdinteger(int32)

The internal id for the status to fetch.

pageNostring

Page numbers start with 1. Default is 1. If you specify a pageNo outside the range of items, an empty list will be returned. PageSize is mandatory for pageNo to work.

pageSizestring

Number of items to display per page. Mandatory if using pageNo.

pricelistSeedstring

A comma separated list of internal pricelist ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

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/ListBasketsByStatus?companyId=string&customerId=string&salesContactId=string'

Responses

Success

Body
ItemCountinteger(int32)

Total number of baskets.

ItemsArray of objects(Basket)(Basket)

List of baskets.

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

List basket statuses

Request

Lists the available basket statuses.

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/ShoppingService.svc/rest/ListBasketStatuses

Responses

Success

Body
Array [
Idinteger(int32)

The internal Id of the Entity.

Namestring

The Name of the Entity. MaxLength: 50.

Descriptionstring

The Description of the Entity. MaxLength: 500.

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.

Codestring

The Code of the Entity. MaxLength: 50.

]
Response
[
  {
    "Id": 0,
    "Name": "string",
    "Description": "string",
    "ImageKey": "string",
    "Code": "string"
  }
]

List basket types

Request

Lists the available basket 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/ShoppingService.svc/rest/ListBasketTypes

Responses

Success

Body
Array [
Idinteger(int32)

The internal Id of the Entity.

Namestring

The Name of the Entity. MaxLength: 50.

Descriptionstring

The Description of the Entity. MaxLength: 500.

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.

Codestring

The Code of the Entity. MaxLength: 50.

]
Response
[
  {
    "Id": 0,
    "Name": "string",
    "Description": "string",
    "ImageKey": "string",
    "Code": "string"
  }
]

Checkout

Operations

DeliveryMethods

Operations

InfoTypes

Operations

OnHand

Operations

OrderRequest

Operations

Payments

Operations

Promotions

Operations

Subscriptions

Operations