Skip to content
STORM API
/
/
/
StoreInfoPagedList

Documentation ApplicationService (1.1)

The Applications namespace has Entities and Operations concerned with the Application as such. It contains the Application entity, Stores and other lookup data common to an Application.

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

Schemas

Schemas

StoreInfo

Idinteger(int32)

The internal id of the Store.

InfoArray of objects(IdValue)(IdValue)

Contains a list of id-value pairs specific to the client for this store. Use ApplicationService.ListStoreInfoTypes(string) for id lookup.

{
  "Id": 0,
  "Info": [
    { … }
  ]
}

StoreInfoPagedList

ItemCountinteger(int32)

The total item count. Can be used to manage paging. This will always be the total number of available items, regardless of paging. Use PageSize to calculate number of pages.

ItemsArray of objects(StoreInfo)(StoreInfo)

Items contains the current list of StoreInfo for the current page if paging is used. Otherwise all items will be in the list.

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

StoreItem

Idinteger(int32)

The internal Id of the Store.

Namestring

The Name of the Store. MaxLength: 50.

Addressstring

The Address of the Store. MaxLength: 100.

PostalAddressstring

The PostalAddress of the Store. Zip and City. MaxLength: 100.

OnHandValuenumber or null(decimal)

Obsolete! - Use OnHand

IncomingValuenumber or null(decimal)

Obsolete! - Use OnHand

NextDeliveryDatestring or null(date-time)

Obsolete! - Use OnHand

Distancenumber or null(decimal)

Used when fetching Stores and we have a specified current location from which to calculate a distance to the Store.

Typestring

The Type of the Store. Taken from Storm's Division.GroupName. MaxLength: 50.

SubTypestring

The SubType of the Store. Taken from Storm's Division.SubGroupName. MaxLength: 50.

Codestring

The external code. Usually the id in the erp system. MaxLength: 50.

OnHandobject(ProductsOnHand)(ProductsOnHand)
OnHandDemoobject(ProductsOnHand)(ProductsOnHand)
UniqueNamestring

A unique name that can be used in Urls and to get this entity. GetStoreItem and GetStoreItemByUniqueName gets the same StoreItem. MaxLength: 100.

{
  "Id": 0,
  "Name": "string",
  "Address": "string",
  "PostalAddress": "string",
  "OnHandValue": 0,
  "IncomingValue": 0,
  "NextDeliveryDate": "2019-08-24T14:15:22Z",
  "Distance": 0,
  "Type": "string",
  "SubType": "string",
  "Code": "string",
  "OnHand": {
    "Value": 0,
    "IncomingValue": 0,
    "NextDeliveryDate": "2019-08-24T14:15:22Z",
    "LeadtimeDayCount": 0,
    "LastChecked": "2019-08-24T14:15:22Z",
    "IsActive": true,
    "IsReturnable": true,
    "Info": [ … ]
  },
  "OnHandDemo": {
    "Value": 0,
    "IncomingValue": 0,
    "NextDeliveryDate": "2019-08-24T14:15:22Z",
    "LeadtimeDayCount": 0,
    "LastChecked": "2019-08-24T14:15:22Z",
    "IsActive": true,
    "IsReturnable": true,
    "Info": [ … ]
  },
  "UniqueName": "string"
}

Application

Operations

Flags

Operations

InfoTypes

Operations

Location

Operations

Stores

Operations