STORM API
/
Metadata Service
/
Application Service
/
Stores

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/

Application

Operations

Flags

Operations

InfoTypes

Operations

Location

Operations

Stores

Operations

Get store

Request

Gets a Store by Id. Should be used to display details about a Store or when just data for a single Store is needed. Returns null if the Store does not exist.

Query
idinteger(int32)required

The internal Id of the Store to fetch.

longitudestring

Longitude for current position. Store will calculate the Distance if supplied together with latitude. Format: decimal.

latitudestring

Latitude for current position. Store will calculate the Distance if supplied together with longitude. Format: decimal.

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/ApplicationService.svc/rest/GetStore?id=0'

Responses

Success

Body
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.

Response
{
  "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"
}

Get store by unique name

Request

Gets a Store by its unique url name. Should be used to display details about a Store or when just data for a single Store is needed. Returns null if the Store does not exist.

Query
uniqueNamestringrequired

The unique name of the Store to fetch.

longitudestring

Longitude for current position. Store will calculate the Distance if supplied together with latitude. Format: decimal.

latitudestring

Latitude for current position. Store will calculate the Distance if supplied together with longitude. Format: decimal.

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/ApplicationService.svc/rest/GetStoreByUniqueName?uniqueName=string'

Responses

Success

Body
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.

Response
{
  "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"
}

Get store item

Request

Gets a StoreItem by Id. Should be used to display details about a StoreItem or when just data for a single StoreItem is needed. Returns null if the StoreItem does not exist.

Query
idinteger(int32)required

The internal Id of the Store to fetch.

partNostring

If supplied, the returned StoreItem will have information about onHand.

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/ApplicationService.svc/rest/GetStoreItem?id=0'

Responses

Success

Body
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.

Response
{
  "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"
}

Get store item by country and zipcode

Request

Gets a StoreItem by country and zip code. Should be used to display details about a StoreItem or when just data for a single StoreItem is needed. Returns null if the StoreItem does not exist.

Query
countryIdstring

Specifies in which countryId. If none is supplied, value is resolved from Application default. Valid countryIds can be found in Application.Countries.

zipCodeinteger(int32)required

The zip code of the end user. The StoreItem is resolved by looking at deliveryMethod locations as set up in StormAdmin.

partNostring

If supplied, the returned StoreItem will have information about onHand.

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/ApplicationService.svc/rest/GetStoreItemByCountryAndZipCode?zipCode=0'

Responses

Success

Body
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.

Response
{
  "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"
}

Get store item by unique name

Request

Gets a StoreItem by its unique url name. Should be used to display details about a StoreItem or when just data for a single StoreItem is needed. Returns null if the StoreItem does not exist.

Query
uniqueNamestringrequired

The unique name of the Store to fetch.

partNostring

If supplied, the returned StoreItem will have information about onHand.

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/ApplicationService.svc/rest/GetStoreItemByUniqueName?uniqueName=string'

Responses

Success

Body
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.

Response
{
  "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"
}

List store info

Request

Lists StoreInfo as a PagedList. This will list info for all Stores.

Query
pageNostring

Page numbers start with 1. Default is 1. If you specify a pageNo outside the range of items, an empty list will be returned. PageSize is mandatory for pageNo to work.

pageSizestring

Number of items to display per page. Mandatory if using pageNo.

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/ApplicationService.svc/rest/ListStoreInfo

Responses

Success

Body
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.

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

List store info types

Request

Lists the info types that can be set on the Store.Info property.

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/ApplicationService.svc/rest/ListStoreInfoTypes

Responses

Success

Body
Array [
Idinteger(int32)

The internal Id of the Entity. This Id might be different in different tiers such as Stage and Production. Use Code if hard coding is required.

Valuestring

The Value of the Entity. MaxLength: max.

Codestring

The Code of the Entity, if existing. Use this value when hard coding is required. MaxLength: 255.

]
Response
[
  {
    "Id": 0,
    "Value": "string",
    "Code": "string"
  }
]

List store items

Request

Lists StoreItems as a PagedList.

Query
partNostring

If supplied, the returned StoreItem will have information about onHand.

longitudestring

Longitude for current position. StoreItems will calculate the Distance if supplied together with latitude. Format: decimal.

latitudestring

Latitude for current position. StoreItems will calculate the Distance if supplied together with longitude. Format: decimal.

pageNostring

Page numbers start with 1. Default is 1. If you specify a pageNo outside the range of items, an empty list will be returned. PageSize is mandatory for pageNo to work.

pageSizestring

Number of items to display per page. Mandatory if using pageNo.

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/ApplicationService.svc/rest/ListStoreItems

Responses

Success

Body
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(StoreItem)(StoreItem)

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

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

List stores [Obsolete("Use ListStoreItems.")]

Request

Lists Stores as a PagedList.

Query
partNostring

If supplied, the returned StoreItem will have information about onHand.

longitudestring

Longitude for current position. StoreItems will calculate the Distance if supplied together with latitude. Format: decimal.

latitudestring

Latitude for current position. StoreItems will calculate the Distance if supplied together with longitude. Format: decimal.

pageNostring

Page numbers start with 1. Default is 1. If you specify a pageNo outside the range of items, an empty list will be returned. PageSize is mandatory for pageNo to work.

pageSizestring

Number of items to display per page. Mandatory if using pageNo.

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/ApplicationService.svc/rest/ListStores

Responses

Success

Body
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(StoreItem)(StoreItem)

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

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

List stores (v2)

Request

Lists all stores. Any distance calculations should be made by the client application for caching reasons or the Distance field will be null.

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/ApplicationService.svc/rest/ListStores2

Responses

Success

Body
Array [
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.

]
Response
[
  {
    "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": { … },
    "Code": "string",
    "Description": "string",
    "ImageKey": "string",
    "UniqueName": "string"
  }
]

Update division information

Request

Updates the given info for a division.

Query
idinteger(int32)required

The internal id of the division.

typeIdinteger(int32)required

The id of the info type. For reference, use ListInfoTypes.

valuestringrequired

The value to set.

updatedBystring

The accountId of the user making the update. If none is supplied, value is resolved from Application.

curl -i -X POST \
  'https://demo.storm.io/api/1.1/ApplicationService.svc/rest/UpdateDivisionInfo?id=0&typeId=0&value=string'

Responses

Success

Body