Application Service schemas
The Applications namespace is concerned with the Application as such. It contains the Application entity, Stores and other lookup data common to an Application.
Application
Application
The Application entity contains data specific to the current application. An Application belongs to a Client and one Client can have multiple Applications. A common usage is that an Application maps to a market or a domain such as .se, .com and such.
| Id | integer or null <int32> The system wide unique internal Storm Id for this Application. |
| ParentId | integer or null <int32> Id of the parent application, if any. Will be the same as Id if none exists. Applications with the same parentId share products and customers. Some content and navigation can differ. |
| Key | string <guid> The system wide unique Key for this Application. |
| Name | string The Name of this Application. MaxLength: 50 |
| Url | string The Url to the Application. MaxLength: 255 |
| SenderEmailAddress | string The sender e-mail address for all external communication and notifications if Norce Storm email services are used. MaxLength: 255 |
object <Client> (Client) | |
object <Cultures> (Cultures) | |
object <Currencies> (Currencies) | |
object <Pricelists> (Pricelists) | |
object <SalesAreas> (SalesAreas) | |
object <Roles> (Roles) | |
object <Countries> (Countries) | |
Array of objects <IdValue> (IdValue) A list of authorizations available for this application. Can be used when creating customer accounts. |
Client
The Client entity contains data specific to the current client. A Client can have multiple Applications and represents a customer (Merchant) to Norce.
| Id | integer <int32> The system wide unique internal Storm Id for the Client. |
| Key | string <guid> The system wide unique Key for the Client. |
| Name | string The Name of the Client. MaxLength: 100 |
Countries
A list of Countries and a Default. Used in Application. Available Countries can be used to populate drop-down lists with countries when the end user enters addresses.
Array of objects <Country> (Country) A list of countries. | |
object <Country> (Country) |
Country
The Country entity contains info about a country.
| Id | integer <int32> The internal Storm Id of the country. |
| Name | string The name of the country. MaxLength: 50 |
| Code | string The Code of the country. The ISO 3166-1 alpha-2 is used. SE for Sweden. MaxLength: 3 |
Culture
The Culture entity contains info about a culture. It defines language and formats.
| Code | string The Code of the culture. Two letter or five letter codes. sv-SE for swedish. MaxLength: 16 |
| Name | string The name of the culture. MaxLength: 50 |
Cultures
A list of Cultures and a Default. Used in Application. Available Cultures can be used to let the end user select different languages within an Application.
Array of objects <Culture> (Culture) A list of cultures. | |
object <Culture> (Culture) |
Currencies
A list of Currencies and a Default. Used in Application. Available Currencies can be used to let the end user select different currencies within an Application.
Array of objects <Currency> (Currency) A list of currencies. | |
object <Currency> (Currency) |
Currency
The Currency entity contains info about a currency.
| Id | integer <int32> The internal Storm Id of the currency. |
| Name | string The name of the currency. MaxLength: 50 |
| Code | string The Code of the currency. ISO 4217 is used. SEK for Swedish kronor. MaxLength: 3 |
| Prefix | string The Prefix sign/code if available. MaxLength: 10 |
| Suffix | string The suffix sign/code if available. MaxLength: 10 |
Pricelists
A list of public PriceListIds and a Default. Used in Application.
| Ids | Array of integers <int32> A list of priceList ids. |
| Default | integer <int32> The default priceList id from the list. |
Role
The Role entity contains info about a Role. Roles can be used to authorize users to different actions within an Application.
| Id | integer <int32> The internal Id of the role. |
| Name | string The Name of the role. MaxLength: 50 |
| Description | string The Description of the role. MaxLength: 500 |
Roles
A list of Roles and a Default. Used in Application. Available Roles can be used in Account. Roles when creating customers with accounts.
Array of objects <Role> (Role) A list of roles. | |
object <Role> (Role) |
SalesArea
A SaleArea defines a region within an Application(market) with specific default VAT and currency.
| Id | integer <int32> The internal Id of the SalesArea. |
| Name | string The Name of the SalesArea. MaxLength: 50 |
| CurrencyId | integer <int32> The default id of the Currency for this SalesArea. |
| VatCodeId | integer <int32> The default id of the VatCode for this SalesArea. |
SalesAreas
A list of SalesAreas and a Default. Used in Application.
Array of objects <SalesArea> (SalesArea) A list of SalesAreas. | |
object <SalesArea> (SalesArea) |
Flags
No entities. See IdValues
InfoTypes
No entities. See IdNameDescription
Location
Location
This entity defines a location. If StoreId and StoreCode are both null, then WarehouseId and LocationId are not null and vice versa. All properties can have values if the Store is fetched from Norce [Storm]. The information can be used when specifying Store/Warehouse/Location in some API-methods.
| StoreId | integer or null <int32> This is the internal Storm ID. |
| StoreCode | string This is a code used to map Store from an external system. MaxLength: 50 |
| WarehouseId | integer or null <int32> This is the internal Storm ID. |
| LocationIdId | integer or null <int32> This is the internal Storm ID. |
LocationInfo
LocationInfo aggregates Locations for a zipcode in a country. Available locations are Delivery, Pickup and Payment.
| CountryCode | string This is country code for the location. MaxLength: 3 |
| ZipCode | string This is zip code for the location. MaxLength: 50 |
object <Location> (Location) | |
object <Location> (Location) | |
object <Location> (Location) |
Stores
Store
Represents a Store, Workshop or such. It is called Division in the Admin UI. The Store entity is a bit more heavy weight than it's counter part StoreItem and should be used to display a detail page for the Store.
| Id | integer <int32> The internal Id of the Store. |
| Name | string The Name of the Store. MaxLength: 50 |
| Address | string The Address of the Store. MaxLength: 100 |
| PostalAddress | string The PostalAddress of the Store. Zip and City. MaxLength: 100 |
| Phone | string The PhoneNumber to the Store. MaxLength: 50 |
| Fax | string The FaxNumber to the Store. MaxLength: 50 |
| OpeningWeekdays | string Defines the opening hours for the Store during week days. MaxLength: 255 |
| OpeningSaturdays | string Defines the opening hours for the Store during on Saturdays. MaxLength: 255 |
| OpeningSundays | string Defines the opening hours for the Store during on Sundays. MaxLength: 255 |
| Longitude | number or null <double> The longitude part of the location of the Store. Can be used to calculate distances to the Store. |
| Latitude | number or null <double> The latitude part of the location of the Store. Can be used to calculate distances to the Store. |
| Distance | number or null <decimal> Used when fetching Stores and we have a specified current location from which to calculate a distance to the Store. |
| Key | string <guid> The system wide unique Key for the Store. |
| Type | string The Type of the Store. Taken from Storm's Division.GroupName. MaxLength: 50 |
| SubType | string The SubType of the Store. Taken from Storm's Division.SubGroupName. MaxLength: 50 |
Array 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. | |
object <Pricelists> (Pricelists) | |
| Code | string The external code. Usually the id in the erp system. MaxLength: 50 |
| Description | string The Description of the Store. MaxLength: max |
| ImageKey | string 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. |
| UniqueName | string A unique name that can be used in Urls and to get this entity. GetStore and GetStoreByUniqueName gets the same Store. MaxLength: 100 |
StoreInfo
StoreInfo contains all info fields for a given Store.
| Id | integer <int32> The internal id of the Store. |
Array 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. |
StoreInfoPagedList
The StoreInfoPagedList is a PagedList. The Items property contains all current items, depending on paging, and the ItemCount the total number of items.
| ItemCount | integer <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. |
Array 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. |
StoreItem
Represents a Store, Workshop or such. It is called Division in the Admin UI. The StoreItem entity is a bit less heavy weight than it's counter part Store and is fetched in a list.
| Id | integer <int32> The internal Id of the Store. |
| Name | string The Name of the Store. MaxLength: 50 |
| Address | string The Address of the Store. MaxLength: 100 |
| PostalAddress | string The PostalAddress of the Store. Zip and City. MaxLength: 100 |
| OnHandValue | number or null <decimal> |
| IncomingValue | number or null <decimal> |
| NextDeliveryDate | string or null <date-time> |
| Distance | number or null <decimal> Used when fetching Stores and we have a specified current location from which to calculate a distance to the Store. |
| Type | string The Type of the Store. Taken from Storm's Division.GroupName. MaxLength: 50 |
| SubType | string The SubType of the Store. Taken from Storm's Division.SubGroupName. MaxLength: 50 |
| Code | string The external code. Usually the id in the erp system. MaxLength: 50 |
object <ProductsOnHand> (ProductsOnHand) | |
object <ProductsOnHand> (ProductsOnHand) | |
| UniqueName | string A unique name that can be used in Urls and to get this entity. GetStoreItem and GetStoreItemByUniqueName gets the same StoreItem. MaxLength: 100 |
StoreItemPagedList
The StoreItemPagedList is a PagedList. The Items property contains all current items, depending on paging, and the ItemCount the total number of items.
| ItemCount | integer <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. |
Array 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. |
Expose Service schemas
The Expose namespace has common entities to all other namespaces or things that does not fit under any other namespace.
ErrorMessages
No entities. See NameValue
File
An Entity used where information about files are needed.
| Id | integer <int32> The internal id of the File. |
| Type | integer <int32> The type id of the File. Depending on context and Client. Can be used by Applications to differentiate files for different usages. |
| Name | string The Name of the File. MaxLength: 50 |
| Description | string The Description of the File. MaxLength: max |
| Key | string or null <guid> A unique id for the File at our image server. Url for images are formed like http://[client specific CDN]/{ImageKey}. Preset, height and width can be sent as parameters. |
IdNameDescription
An Entity used where Id, Name and Description is needed. It also has an optional ImageKey that gets populated when existing. Mostly used for lookup data.
| Id | integer <int32> The internal Id of the Entity. |
| Name | string The Name of the Entity. MaxLength: 50 |
| Description | string The Description of the Entity. MaxLength: 500 |
| ImageKey | string 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. |
| Code | string The Code of the Entity. MaxLength: 50 |
IdValue
An Entity used where Id and Value is needed. Mostly used for lookup data.
| Id | integer <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. |
| Value | string The Value of the Entity. MaxLength: max |
| Code | string The Code of the Entity, if existing. Use this value when hard coding is required. MaxLength: 255 |
NameValue
An Entity used where Name and Value is needed. Mostly used for lookup data.
| Name | string The Name of the Entity. MaxLength: 50 |
| Value | string The Value of the Entity. MaxLength: max |
Ping
No entities.
Process
No entities.