STORM API
/
Shopping Service
/
OnHand

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

Checkout

Operations

DeliveryMethods

Operations

InfoTypes

Operations

OnHand

Operations

List external availability on products in basket

Request

Checks the actual on hand status for the products in the basket in the customers back end system. If no backend is configured then this is equal to calling ListProductOnHandByBasket.

Query
basketIdinteger(int32)required

The internal basket id.

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

Ignored.

Body

An Warehouse if OnHand for a specific store is wanted. If standard warehouse (web) is wanted just pass null.

StoreIdinteger or null(int32)

The store internal id for the current store. Can be null if WarehouseId and LocationId are supplied.

WarehouseIdinteger or null(int32)

The internal id for the warehouse. Can be null if StoreId is supplied.

LocationIdinteger or null(int32)

The internal id for the warehouse location. Can be null if StoreId is supplied.

OnHandobject(ProductsOnHand)(ProductsOnHand)
curl -i -X POST \
  'https://demo.storm.io/api/1.1/ShoppingService.svc/rest/ListExternalProductOnHandByBasket?basketId=0' \
  -H 'Content-Type: application/json' \
  -d '{
    "StoreId": 0,
    "WarehouseId": 0,
    "LocationId": 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": [
        {
          "Id": 0,
          "Value": "string",
          "Code": "string"
        }
      ]
    }
  }'

Responses

Success

Body
Array [
ProductIdinteger(int32)

The product internal id for the current product/variant. If the entity is fetched by productId it will be that productId. If the product is fetched by partNo it will be the productId for that variant.

WarehousesArray of objects(ProductsWarehouse)(ProductsWarehouse)

A list of warehouses with OnHand for the product.

VariantsArray of objects(ProductsProductOnHand)(ProductsProductOnHand)

An optional list of ProductOnHand for all variants if fetched by productId. Null when fetched for a variant or a basket.

]
Response
[
  {
    "ProductId": 0,
    "Warehouses": [ … ],
    "Variants": [ … ]
  }
]

List availability on products in basket

Request

Lists OnHand data based on basket items. Only deliverable items will be regarded. The result is a list of ProductOnHand where each product has a list of warehoues matching the warehouse specification passed in. ProductOnHand.Variants will always be null when getting this data for a basket. OnHand for each warehouse will always be returned whether or not the warehouse has the item or not. OnHand.IsActive = false indicates the item does not exist at the warehouse so only active OnHands should be used when checking availability.

Query
basketIdinteger(int32)required

The internal basket id.

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

Ignored.

Body

An Warehouse if OnHand for a specific store is wanted. If standard warehouse (web) is wanted just pass null.

StoreIdinteger or null(int32)

The store internal id for the current store. Can be null if WarehouseId and LocationId are supplied.

WarehouseIdinteger or null(int32)

The internal id for the warehouse. Can be null if StoreId is supplied.

LocationIdinteger or null(int32)

The internal id for the warehouse location. Can be null if StoreId is supplied.

OnHandobject(ProductsOnHand)(ProductsOnHand)
curl -i -X POST \
  'https://demo.storm.io/api/1.1/ShoppingService.svc/rest/ListProductOnHandByBasket?basketId=0' \
  -H 'Content-Type: application/json' \
  -d '{
    "StoreId": 0,
    "WarehouseId": 0,
    "LocationId": 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": [
        {
          "Id": 0,
          "Value": "string",
          "Code": "string"
        }
      ]
    }
  }'

Responses

Success

Body
Array [
ProductIdinteger(int32)

The product internal id for the current product/variant. If the entity is fetched by productId it will be that productId. If the product is fetched by partNo it will be the productId for that variant.

WarehousesArray of objects(ProductsWarehouse)(ProductsWarehouse)

A list of warehouses with OnHand for the product.

VariantsArray of objects(ProductsProductOnHand)(ProductsProductOnHand)

An optional list of ProductOnHand for all variants if fetched by productId. Null when fetched for a variant or a basket.

]
Response
[
  {
    "ProductId": 0,
    "Warehouses": [ … ],
    "Variants": [ … ]
  }
]

OrderRequest

Operations

Payments

Operations

Promotions

Operations

Subscriptions

Operations