STORM QUERY
/
Core
/
Core

Storm Query API Documentation (2.0)

Storm Query API is an API based on OData V4. It is an API to fill the need for data from Storm in integration services that do not have direct access to Storm’s data and data models.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
https://query.storm.io/Query/2.0/

Core

Operations

Get Application

Request

Get Application

curl -i -X GET \
  https://query.storm.io/Query/2.0/Core/Applications

Responses

Success

Bodyapplication/jsonArray [
Idinteger(int32)

Id. Key property.

Keystring(guid)

Key.

Namestring

Name. MaxLength: 50. Nullable.

Descriptionstring

Description. MaxLength: 500. Nullable.

Urlstring

Url. MaxLength: 255. Nullable.

CmsUrlstring

CmsUrl. MaxLength: 255. Nullable.

SalesUrlstring

SalesUrl. MaxLength: 255. Nullable.

SenderEmailAddressstring

SenderEmailAddress. MaxLength: 255. Nullable.

HostClientIdinteger(int32)

HostClientId.

IsActiveboolean

IsActive.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

UrlMatchstring

UrlMatch. MaxLength: 4000. Nullable.

ParentIdinteger(int32)

ParentId. Nullable.

ImageKeystring

ImageKey. MaxLength: 50. Nullable.

ProductUrlstring

ProductUrl. MaxLength: 255. Nullable.

Clientobject(Enferno.Storm.Query.Api.DataContexts.StormCore.Client)(Enferno.Storm.Query.Api.DataContexts.StormCore.Client)
]
Response
application/json
[
  {
    "Id": 0,
    "Key": "string",
    "Name": "string",
    "Description": "string",
    "Url": "string",
    "CmsUrl": "string",
    "SalesUrl": "string",
    "SenderEmailAddress": "string",
    "HostClientId": 0,
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0,
    "UrlMatch": "string",
    "ParentId": 0,
    "ImageKey": "string",
    "ProductUrl": "string",
    "Client": { … }
  }
]

Get Country

Request

Get Country

curl -i -X GET \
  https://query.storm.io/Query/2.0/Core/Countries

Responses

Success

Bodyapplication/jsonArray [
Idinteger(int32)

Id. Key property.

Codestring

Code. MaxLength: 3. Nullable.

DefaultNamestring

DefaultName. MaxLength: 50. Nullable.

PhoneAreaCodeinteger(int32)

PhoneAreaCode. Nullable.

IsActiveboolean

IsActive.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

CulturesArray of objects(Enferno.Storm.Query.Api.DataContexts.StormCore.CountryCulture)(Enferno.Storm.Query.Api.DataContexts.StormCore.CountryCulture)

Cultures.

]
Response
application/json
[
  {
    "Id": 0,
    "Code": "string",
    "DefaultName": "string",
    "PhoneAreaCode": 0,
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0,
    "Cultures": [ … ]
  }
]

Get Currency

Request

Get Currency

curl -i -X GET \
  https://query.storm.io/Query/2.0/Core/Currencies

Responses

Success

Bodyapplication/jsonArray [
Idinteger(int32)

Id. Key property.

Codestring

Code. MaxLength: 3. Nullable.

DefaultNamestring

DefaultName. MaxLength: 50. Nullable.

ExchangeRatenumber(decimal)

ExchangeRate.

DefaultPrefixstring

DefaultPrefix. MaxLength: 10. Nullable.

DefaultSuffixstring

DefaultSuffix. MaxLength: 10. Nullable.

IsActiveboolean

IsActive.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

CulturesArray of objects(Enferno.Storm.Query.Api.DataContexts.StormCore.CurrencyCulture)(Enferno.Storm.Query.Api.DataContexts.StormCore.CurrencyCulture)

Cultures.

]
Response
application/json
[
  {
    "Id": 0,
    "Code": "string",
    "DefaultName": "string",
    "ExchangeRate": 0,
    "DefaultPrefix": "string",
    "DefaultSuffix": "string",
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0,
    "Cultures": [ … ]
  }
]

Get File

Request

Get File

curl -i -X GET \
  https://query.storm.io/Query/2.0/Core/Files

Responses

Success

Bodyapplication/jsonArray [
Idinteger(int32)

Id. Key property.

DefaultNamestring

DefaultName. MaxLength: 50. Nullable.

DefaultDescriptionstring

DefaultDescription. MaxLength: 500. Nullable.

TypeIdinteger(int32)

TypeId.

DefaultPixelWidthinteger(int32)

DefaultPixelWidth. Nullable.

DefaultPixelHeightinteger(int32)

DefaultPixelHeight. Nullable.

DefaultMaxSizeinteger(int32)

DefaultMaxSize. Nullable.

DefaultThumbnailPixelWidthinteger(int32)

DefaultThumbnailPixelWidth. Nullable.

DefaultThumbnailPixelHeightinteger(int32)

DefaultThumbnailPixelHeight. Nullable.

DefaultThumbnailMaxSizeinteger(int32)

DefaultThumbnailMaxSize. Nullable.

IsHiddenboolean

IsHidden.

IsActiveboolean

IsActive.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

CulturesArray of objects(Enferno.Storm.Query.Api.DataContexts.StormCore.FileCulture)(Enferno.Storm.Query.Api.DataContexts.StormCore.FileCulture)

Cultures.

Typeobject(Enferno.Storm.Query.Api.DataContexts.StormCore.FileType)(Enferno.Storm.Query.Api.DataContexts.StormCore.FileType)
]
Response
application/json
[
  {
    "Id": 0,
    "DefaultName": "string",
    "DefaultDescription": "string",
    "TypeId": 0,
    "DefaultPixelWidth": 0,
    "DefaultPixelHeight": 0,
    "DefaultMaxSize": 0,
    "DefaultThumbnailPixelWidth": 0,
    "DefaultThumbnailPixelHeight": 0,
    "DefaultThumbnailMaxSize": 0,
    "IsHidden": true,
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0,
    "Cultures": [ … ],
    "Type": { … }
  }
]

Get FileType

Request

Get FileType

curl -i -X GET \
  https://query.storm.io/Query/2.0/Core/FileTypes

Responses

Success

Bodyapplication/jsonArray [
Idinteger(int32)

Id. Key property.

Extensionstring

Extension. MaxLength: 50. Nullable.

MimeTypestring

MimeType. MaxLength: 100. Nullable.

IsActiveboolean

IsActive.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

FilesArray of objects(Enferno.Storm.Query.Api.DataContexts.StormCore.File)(Enferno.Storm.Query.Api.DataContexts.StormCore.File)

Files.

]
Response
application/json
[
  {
    "Id": 0,
    "Extension": "string",
    "MimeType": "string",
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0,
    "Files": [ … ]
  }
]

Get SalesArea

Request

Get SalesArea

curl -i -X GET \
  https://query.storm.io/Query/2.0/Core/SalesAreas

Responses

Success

Bodyapplication/jsonArray [
Idinteger(int32)

Id. Key property.

DefaultNamestring

DefaultName. MaxLength: 50. Nullable.

DefaultDescriptionstring

DefaultDescription. MaxLength: 500. Nullable.

DefaultCurrencyIdinteger(int32)

DefaultCurrencyId.

DefaultVatCodeIdinteger(int32)

DefaultVatCodeId.

IsActiveboolean

IsActive.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

CulturesArray of objects(Enferno.Storm.Query.Api.DataContexts.StormCore.SalesAreaCulture)(Enferno.Storm.Query.Api.DataContexts.StormCore.SalesAreaCulture)

Cultures.

]
Response
application/json
[
  {
    "Id": 0,
    "DefaultName": "string",
    "DefaultDescription": "string",
    "DefaultCurrencyId": 0,
    "DefaultVatCodeId": 0,
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0,
    "Cultures": [ … ]
  }
]

Get SkuStatus

Request

Get SkuStatus

curl -i -X GET \
  https://query.storm.io/Query/2.0/Core/SkuStatuses

Responses

Success

Bodyapplication/jsonArray [
Idinteger(int32)

Id. Key property.

DefaultNamestring

DefaultName. MaxLength: 50. Nullable.

DefaultDescriptionstring

DefaultDescription. MaxLength: 500. Nullable.

IsActiveboolean

IsActive.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

CulturesArray of objects(Enferno.Storm.Query.Api.DataContexts.StormCore.SkuStatusCulture)(Enferno.Storm.Query.Api.DataContexts.StormCore.SkuStatusCulture)

Cultures.

]
Response
application/json
[
  {
    "Id": 0,
    "DefaultName": "string",
    "DefaultDescription": "string",
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0,
    "Cultures": [ … ]
  }
]

Get VatCode

Request

Get VatCode

curl -i -X GET \
  https://query.storm.io/Query/2.0/Core/VatCodes

Responses

Success

Bodyapplication/jsonArray [
Idinteger(int32)

Id. Key property.

DefaultNamestring

DefaultName. MaxLength: 50. Nullable.

DefaultDescriptionstring

DefaultDescription. MaxLength: 500. Nullable.

Valuenumber(decimal)

Value.

IsActiveboolean

IsActive.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

CulturesArray of objects(Enferno.Storm.Query.Api.DataContexts.StormCore.VatCodeCulture)(Enferno.Storm.Query.Api.DataContexts.StormCore.VatCodeCulture)

Cultures.

]
Response
application/json
[
  {
    "Id": 0,
    "DefaultName": "string",
    "DefaultDescription": "string",
    "Value": 0,
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0,
    "Cultures": [ … ]
  }
]

Get DeliveryMethod

Request

Get DeliveryMethod

curl -i -X GET \
  https://query.storm.io/Query/2.0/Core/DeliveryMethods

Responses

Success

Bodyapplication/jsonArray [
Idinteger(int32)

Id. Key property.

DeliveryServiceIdinteger(int32)

DeliveryServiceId. Nullable.

DeliveryMethodTypeIdinteger(int32)

DeliveryMethodTypeId. Nullable.

DefaultNamestring

DefaultName. MaxLength: 50. Nullable.

DefaultDescriptionstring

DefaultDescription. Nullable.

DefaultLogoPathstring

DefaultLogoPath. MaxLength: 255. Nullable.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

DefaultLogoKeystring(guid)

DefaultLogoKey. Nullable.

DeliveryServiceobject(Enferno.Storm.Query.Api.DataContexts.StormCore.DeliveryService)(Enferno.Storm.Query.Api.DataContexts.StormCore.DeliveryService)
DeliveryMethodTypeobject(Enferno.Storm.Query.Api.DataContexts.StormCore.DeliveryMethodType)(Enferno.Storm.Query.Api.DataContexts.StormCore.DeliveryMethodType)
]
Response
application/json
[
  {
    "Id": 0,
    "DeliveryServiceId": 0,
    "DeliveryMethodTypeId": 0,
    "DefaultName": "string",
    "DefaultDescription": "string",
    "DefaultLogoPath": "string",
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0,
    "DefaultLogoKey": "string",
    "DeliveryService": { … },
    "DeliveryMethodType": { … }
  }
]

Get PaymentMethod

Request

Get PaymentMethod

curl -i -X GET \
  https://query.storm.io/Query/2.0/Core/PaymentMethods

Responses

Success

Bodyapplication/jsonArray [
Idinteger(int32)

Id. Key property.

PaymentMethodTypeIdinteger(int32)

PaymentMethodTypeId.

DefaultNamestring

DefaultName. MaxLength: 50. Nullable.

DefaultDescriptionstring

DefaultDescription. Nullable.

LogoPathstring

LogoPath. MaxLength: 500. Nullable.

SortOrderinteger(int32)

SortOrder.

IsPartialPaymentboolean

IsPartialPayment.

IsActiveboolean

IsActive.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

LogoKeystring(guid)

LogoKey. Nullable.

]
Response
application/json
[
  {
    "Id": 0,
    "PaymentMethodTypeId": 0,
    "DefaultName": "string",
    "DefaultDescription": "string",
    "LogoPath": "string",
    "SortOrder": 0,
    "IsPartialPayment": true,
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "LogoKey": "string"
  }
]

Get ProductInfoTypeGroup

Request

Get ProductInfoTypeGroup

curl -i -X GET \
  https://query.storm.io/Query/2.0/Core/ProductInfoTypeGroups

Responses

Success

Bodyapplication/jsonArray [
Idinteger(int32)

Id. Key property.

DefaultNamestring

DefaultName. MaxLength: 50. Nullable.

DefaultDescriptionstring

DefaultDescription. MaxLength: 500. Nullable.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

CulturesArray of objects(Enferno.Storm.Query.Api.DataContexts.StormCore.ProductInfoTypeGroupCulture)(Enferno.Storm.Query.Api.DataContexts.StormCore.ProductInfoTypeGroupCulture)

Cultures.

]
Response
application/json
[
  {
    "Id": 0,
    "DefaultName": "string",
    "DefaultDescription": "string",
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0,
    "Cultures": [ … ]
  }
]

Get KpiOrder

Request

Get KpiOrder

curl -i -X GET \
  https://query.storm.io/Query/2.0/Core/KpiOrders

Responses

Success

Bodyapplication/jsonArray [
Idinteger(int32)

Id. Key property.

Datestring(date-time)

Date.

ClientIdinteger(int32)

ClientId.

ApplicationIdinteger(int32)

ApplicationId.

PaymentServiceIdinteger(int32)

PaymentServiceId.

PaymentMethodIdinteger(int32)

PaymentMethodId.

Sourcestring

Source. MaxLength: 50. Nullable.

CurrencyIdinteger(int32)

CurrencyId.

CurrencyRatenumber(decimal)

CurrencyRate.

NoOfOrdersinteger(int32)

NoOfOrders.

NoOfOrderLinesinteger(int32)

NoOfOrderLines.

CostPurchaseExVATnumber(decimal)

CostPurchaseExVAT.

OrderValueExVATnumber(decimal)

OrderValueExVAT.

OrderValueIncVATnumber(decimal)

OrderValueIncVAT.

Fxnumber(decimal)

Fx.

TotalMarginnumber(decimal)

TotalMargin.

CompanyDiscountnumber(decimal)

CompanyDiscount.

NoOfAppliedPromotionsinteger(int32)

NoOfAppliedPromotions.

TotalDiscountPromotionsnumber(decimal)

TotalDiscountPromotions.

]
Response
application/json
[
  {
    "Id": 0,
    "Date": "2019-08-24T14:15:22Z",
    "ClientId": 0,
    "ApplicationId": 0,
    "PaymentServiceId": 0,
    "PaymentMethodId": 0,
    "Source": "string",
    "CurrencyId": 0,
    "CurrencyRate": 0,
    "NoOfOrders": 0,
    "NoOfOrderLines": 0,
    "CostPurchaseExVAT": 0,
    "OrderValueExVAT": 0,
    "OrderValueIncVAT": 0,
    "Fx": 0,
    "TotalMargin": 0,
    "CompanyDiscount": 0,
    "NoOfAppliedPromotions": 0,
    "TotalDiscountPromotions": 0
  }
]

Get RecurringOrderStatus

Request

Get RecurringOrderStatus

curl -i -X GET \
  https://query.storm.io/Query/2.0/Core/RecurringOrderStatuses

Responses

Success

Bodyapplication/jsonArray [
Idinteger(int32)

Id. Key property.

DefaultNamestring

DefaultName. MaxLength: 50. Nullable.

DefaultDescriptionstring

DefaultDescription. MaxLength: 500. Nullable.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

CulturesArray of objects(Enferno.Storm.Query.Api.DataContexts.StormCore.RecurringOrderStatusCulture)(Enferno.Storm.Query.Api.DataContexts.StormCore.RecurringOrderStatusCulture)

Cultures.

]
Response
application/json
[
  {
    "Id": 0,
    "DefaultName": "string",
    "DefaultDescription": "string",
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0,
    "Cultures": [ … ]
  }
]

Get RecurringOrderScheduleFrequency

Request

Get RecurringOrderScheduleFrequency

curl -i -X GET \
  https://query.storm.io/Query/2.0/Core/RecurringOrderScheduleFrequencies

Responses

Success

Bodyapplication/jsonArray [
Idinteger(int32)

Id. Key property.

DefaultNamestring

DefaultName. MaxLength: 50. Nullable.

DefaultDescriptionstring

DefaultDescription. MaxLength: 500. Nullable.

IsActiveboolean

IsActive.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

CulturesArray of objects(Enferno.Storm.Query.Api.DataContexts.StormCore.RecurringOrderScheduleFrequencyCulture)(Enferno.Storm.Query.Api.DataContexts.StormCore.RecurringOrderScheduleFrequencyCulture)

Cultures.

]
Response
application/json
[
  {
    "Id": 0,
    "DefaultName": "string",
    "DefaultDescription": "string",
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0,
    "Cultures": [ … ]
  }
]

Get RecurringOrderScheduleMonthlyInterval

Request

Get RecurringOrderScheduleMonthlyInterval

curl -i -X GET \
  https://query.storm.io/Query/2.0/Core/RecurringOrderScheduleMonthlyIntervals

Responses

Success

Bodyapplication/jsonArray [
Idinteger(int32)

Id. Key property.

DefaultNamestring

DefaultName. MaxLength: 50. Nullable.

DefaultDescriptionstring

DefaultDescription. MaxLength: 500. Nullable.

IsActiveboolean

IsActive.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

CulturesArray of objects(Enferno.Storm.Query.Api.DataContexts.StormCore.RecurringOrderScheduleMonthlyIntervalCulture)(Enferno.Storm.Query.Api.DataContexts.StormCore.RecurringOrderScheduleMonthlyIntervalCulture)

Cultures.

]
Response
application/json
[
  {
    "Id": 0,
    "DefaultName": "string",
    "DefaultDescription": "string",
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0,
    "Cultures": [ … ]
  }
]

Get RecurringOrderScheduleMonthlyIntervalValue

Request

Get RecurringOrderScheduleMonthlyIntervalValue

curl -i -X GET \
  https://query.storm.io/Query/2.0/Core/RecurringOrderScheduleMonthlyIntervalValues

Responses

Success

Bodyapplication/jsonArray [
Idinteger(int32)

Id. Key property.

DefaultNamestring

DefaultName. MaxLength: 50. Nullable.

DefaultDescriptionstring

DefaultDescription. MaxLength: 500. Nullable.

IsActiveboolean

IsActive.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

CulturesArray of objects(Enferno.Storm.Query.Api.DataContexts.StormCore.RecurringOrderScheduleMonthlyIntervalValueCulture)(Enferno.Storm.Query.Api.DataContexts.StormCore.RecurringOrderScheduleMonthlyIntervalValueCulture)

Cultures.

]
Response
application/json
[
  {
    "Id": 0,
    "DefaultName": "string",
    "DefaultDescription": "string",
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0,
    "Cultures": [ … ]
  }
]

GetClientSeed

Request

GetClientSeed

Query
clientIdinteger(int32)required
applicationIdinteger(int32)
typeIdinteger(int32)required
curl -i -X GET \
  'https://query.storm.io/Query/2.0/Core/GetClientSeed?clientId=0&typeId=0'

Responses

Success

Bodyapplication/json
string
Response
application/json
"string"