STORM API
/
Product Service
/
OnHand

Documentation ProductService (1.1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
https://demo.storm.io/api/1.1/

Assortments

Operations

Categories

Operations

Configurations

Operations

Families

Operations

Files

Operations

Filters

Operations

Flags

Operations

InfoTypes

Operations

Manufacturers

Operations

Navigation

Operations

OnHand

Operations

Get product external availability by part number

Request

Checks the actual on hand status in the customers back end system.

Query
partNostringrequired

Part number of the product to get.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

pricelistSeedstring

A comma separated list of PriceList internal 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.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

cultureCodestring

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

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

Body
required

The actual list of warehouses to check OnHand for. OnHand in Warehouse is ignored.

Array [
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(OnHand)(OnHand)
]
curl -i -X POST \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/GetExternalProductOnHandByPartNo?partNo=string&statusSeed=string' \
  -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
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(Warehouse)(Warehouse)

A list of warehouses with OnHand for the product.

VariantsArray of objects(ProductOnHand)(ProductOnHand)

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": [
    {}
  ]
}

Get product external availability by id

Request

Checks the actual on hand status in the customers back end system.

Query
productIdinteger(int32)required

Internal id of the product to get.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

pricelistSeedstring

A comma separated list of PriceList internal 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.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

cultureCodestring

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

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

Body
required

The actual list of warehouses to check OnHand for. OnHand in Warehouse is ignored.

Array [
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(OnHand)(OnHand)
]
curl -i -X POST \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/GetExternalProductOnHandByProduct?productId=0&statusSeed=string' \
  -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
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(Warehouse)(Warehouse)

A list of warehouses with OnHand for the product.

VariantsArray of objects(ProductOnHand)(ProductOnHand)

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": [
    {}
  ]
}

Get product availability by part number

Request

Query
partNostringrequired

Part number of the product to get.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

pricelistSeedstring

A comma separated list of PriceList internal 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.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

cultureCodestring

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

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

Body
required

The actual list of warehouses to check OnHand for. OnHand in Warehouse is ignored.

Array [
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(OnHand)(OnHand)
]
curl -i -X POST \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/GetProductOnHandByPartNo?partNo=string&statusSeed=string' \
  -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
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(Warehouse)(Warehouse)

A list of warehouses with OnHand for the product.

VariantsArray of objects(ProductOnHand)(ProductOnHand)

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": [
    {}
  ]
}

Get product availability by id

Request

Query
productIdinteger(int32)required

Internal id of the product to get.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

pricelistSeedstring

A comma separated list of PriceList internal 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.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

cultureCodestring

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

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

Body
required

The actual list of warehouses to check OnHand for. OnHand in Warehouse is ignored.

Array [
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(OnHand)(OnHand)
]
curl -i -X POST \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/GetProductOnHandByProduct?productId=0&statusSeed=string' \
  -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
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(Warehouse)(Warehouse)

A list of warehouses with OnHand for the product.

VariantsArray of objects(ProductOnHand)(ProductOnHand)

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": [
    {}
  ]
}

Parametric

Operations

PriceLists

Operations

Products

Operations

Promotions

Operations

Relations

Operations

Reviews

Operations

SkuTypes

Operations

Status

Operations

Variants

Operations

Warehouses

Operations