Skip to content

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
Languages
Servers

https://query.storm.io/Query/2.0/

Operations

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": {} } ]

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" } ]

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": [] } ]