Skip to content
STORM API
/
/
/
SalesAreas

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

SalesArea

Idinteger(int32)

The internal Id of the SalesArea.

Namestring

The Name of the SalesArea. MaxLength: 50.

CurrencyIdinteger(int32)

The default id of the Currency for this SalesArea.

VatCodeIdinteger(int32)

The default id of the VatCode for this SalesArea.

{
  "Id": 0,
  "Name": "string",
  "CurrencyId": 0,
  "VatCodeId": 0
}

SalesAreas

ListArray of objects(SalesArea)(SalesArea)

A list of SalesAreas.

Defaultobject(SalesArea)(SalesArea)
{
  "List": [
    { … }
  ],
  "Default": {
    "Id": 0,
    "Name": "string",
    "CurrencyId": 0,
    "VatCodeId": 0
  }
}

Store

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.

Phonestring

The PhoneNumber to the Store. MaxLength: 50.

Faxstring

The FaxNumber to the Store. MaxLength: 50.

OpeningWeekdaysstring

Defines the opening hours for the Store during week days. MaxLength: 255.

OpeningSaturdaysstring

Defines the opening hours for the Store during on Saturdays. MaxLength: 255.

OpeningSundaysstring

Defines the opening hours for the Store during on Sundays. MaxLength: 255.

Longitudenumber or null(double)

The longitude part of the location of the Store. Can be used to calculate distances to the Store.

Latitudenumber or null(double)

The latitude part of the location of the Store. Can be used to calculate distances to the Store.

Distancenumber or null(decimal)

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

Keystring(guid)

The system wide unique Key for 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.

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.

Pricelistsobject(Pricelists)(Pricelists)
Codestring

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

Descriptionstring

The Description of the Store. MaxLength: max.

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.

UniqueNamestring

A unique name that can be used in Urls and to get this entity. GetStore and GetStoreByUniqueName gets the same Store. MaxLength: 100.

{
  "Id": 0,
  "Name": "string",
  "Address": "string",
  "PostalAddress": "string",
  "Phone": "string",
  "Fax": "string",
  "OpeningWeekdays": "string",
  "OpeningSaturdays": "string",
  "OpeningSundays": "string",
  "Longitude": 0.1,
  "Latitude": 0.1,
  "Distance": 0,
  "Key": "string",
  "Type": "string",
  "SubType": "string",
  "Info": [
    { … }
  ],
  "Pricelists": {
    "Ids": [ … ],
    "Default": 0
  },
  "Code": "string",
  "Description": "string",
  "ImageKey": "string",
  "UniqueName": "string"
}

Application

Operations

Flags

Operations

InfoTypes

Operations

Location

Operations

Stores

Operations