STORM QUERY
/
Core
/
Core
/
Get KpiOrder

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/

Schemas

Core

Operations

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 SkuType

Request

Get SkuType

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

Responses

Success

Bodyapplication/jsonArray [
Idinteger(int32)

Id. Key property.

DefaultNamestring

DefaultName. MaxLength: 50. Nullable.

DefaultDescriptionstring

DefaultDescription. MaxLength: 500. Nullable.

GroupIdinteger(int32)

GroupId.

DefaultSortOrderinteger(int32)

DefaultSortOrder.

IsActiveboolean

IsActive.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

IsPublicboolean

IsPublic.

Groupobject(Enferno.Storm.Query.Api.DataContexts.StormCore.SkuTypeGroup)(Enferno.Storm.Query.Api.DataContexts.StormCore.SkuTypeGroup)
]
Response
application/json
[
  {
    "Id": 0,
    "DefaultName": "string",
    "DefaultDescription": "string",
    "GroupId": 0,
    "DefaultSortOrder": 0,
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0,
    "IsPublic": true,
    "Group": { … }
  }
]