STORM API
/
Shopping Service
/
Basket
/
List saved baskets for a customer

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

Basket

Operations

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"
  }
]

List saved baskets for a customer

Request

List saved baskets for a specific customer

Query
customerIdinteger(int32)required

The internal customer id of the customer. The id is used to fetch saved baskets.

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/ListSavedBaskets?customerId=0'

Responses

Success

Body
Array [
Idinteger(int32)

Internal id of the saved basket.

Namestring

Name given to this specific saved basket. MaxLength: 50.

Createdstring(date-time)

Creation date.

CustomerIdinteger or null(int32)

Internal customer id of associated customer, if any.

ValidTostring or null(date-time)

Valid date, if any.

]
Response
[
  {
    "Id": 0,
    "Name": "string",
    "Created": "2019-08-24T14:15:22Z",
    "CustomerId": 0,
    "ValidTo": "2019-08-24T14:15:22Z"
  }
]

Save a basket

Request

Save a initiated basket

Query
customerIdinteger(int32)required

The internal customer id of the customer. The id is used to fetch saved baskets.

basketIdinteger(int32)required

The internal id of the basket to save.

namestringrequired

The name of the saved basket.

cultureCodestring

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

curl -i -X POST \
  'https://demo.storm.io/api/1.1/ShoppingService.svc/rest/SaveBasket?basketId=0&customerId=0&name=string'

Responses

Success

Body
Idinteger(int32)

Internal id of the saved basket.

Namestring

Name given to this specific saved basket. MaxLength: 50.

Createdstring(date-time)

Creation date.

CustomerIdinteger or null(int32)

Internal customer id of associated customer, if any.

ValidTostring or null(date-time)

Valid date, if any.

Response
{
  "Id": 0,
  "Name": "string",
  "Created": "2019-08-24T14:15:22Z",
  "CustomerId": 0,
  "ValidTo": "2019-08-24T14:15:22Z"
}

Checkout

Operations

DeliveryMethods

Operations

InfoTypes

Operations

OnHand

Operations

OrderRequest

Operations

Payments

Operations

Promotions

Operations

Subscriptions

Operations