STORM QUERY
/
Shopping
/
Shopping

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/

Shopping

Operations

Get ApplicationPaymentMethod

Request

Get ApplicationPaymentMethod

curl -i -X GET \
  https://query.storm.io/Query/2.0/Shopping/ApplicationPaymentMethods

Responses

Success

Bodyapplication/jsonArray [
ApplicationIdinteger(int32)

ApplicationId. Key property.

PaymentMethodIdinteger(int32)

PaymentMethodId. Key property.

PaymentServiceIdinteger(int32)

PaymentServiceId.

OnlyCompaniesboolean

OnlyCompanies.

OnlyNotCompaniesboolean

OnlyNotCompanies.

HasDeliveryMethodsboolean

HasDeliveryMethods.

HasDivisionsboolean

HasDivisions.

HasFieldsboolean

HasFields.

CurrencyIdinteger(int32)

CurrencyId. Nullable.

MinOrderValuenumber(decimal)

MinOrderValue. Nullable.

MaxOrderValuenumber(decimal)

MaxOrderValue. Nullable.

Feenumber(decimal)

Fee.

FeeVatRatenumber(decimal)

FeeVatRate.

Codestring

Code. MaxLength: 50. Nullable.

ExternalPartnerCodestring

ExternalPartnerCode. MaxLength: 50. Nullable.

PartNostring

PartNo. MaxLength: 50. Nullable.

SortOrderinteger(int32)

SortOrder. Nullable.

IsActiveboolean

IsActive.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

IsRecurrableboolean

IsRecurrable. Nullable.

ClientIdinteger(int32)

ClientId. Nullable.

CulturesArray of objects(Enferno.Storm.Query.Api.DataContexts.ShoppingModel.ApplicationPaymentMethodCulture)(Enferno.Storm.Query.Api.DataContexts.ShoppingModel.ApplicationPaymentMethodCulture)

Cultures.

]
Response
application/json
[
  {
    "ApplicationId": 0,
    "PaymentMethodId": 0,
    "PaymentServiceId": 0,
    "OnlyCompanies": true,
    "OnlyNotCompanies": true,
    "HasDeliveryMethods": true,
    "HasDivisions": true,
    "HasFields": true,
    "CurrencyId": 0,
    "MinOrderValue": 0,
    "MaxOrderValue": 0,
    "Fee": 0,
    "FeeVatRate": 0,
    "Code": "string",
    "ExternalPartnerCode": "string",
    "PartNo": "string",
    "SortOrder": 0,
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0,
    "IsRecurrable": true,
    "ClientId": 0,
    "Cultures": [ … ]
  }
]

Get ApplicationDeliveryMethod

Request

Get ApplicationDeliveryMethod

curl -i -X GET \
  https://query.storm.io/Query/2.0/Shopping/ApplicationDeliveryMethods

Responses

Success

Bodyapplication/jsonArray [
ApplicationIdinteger(int32)

ApplicationId. Key property.

DeliveryMethodIdinteger(int32)

DeliveryMethodId. Key property.

Codestring

Code. MaxLength: 50. Nullable.

OnlyCompaniesboolean

OnlyCompanies.

OnlyNotCompaniesboolean

OnlyNotCompanies.

HasLocationsboolean

HasLocations.

HasCustomerFlagsboolean

HasCustomerFlags.

HasPaymentMethodsboolean

HasPaymentMethods.

HasDeliveryNotificationboolean

HasDeliveryNotification.

AvailableAsDropShipboolean

AvailableAsDropShip.

AllowDangerousGoodsboolean

AllowDangerousGoods.

CurrencyIdinteger(int32)

CurrencyId. Nullable.

MaxOrderProductValuenumber(decimal)

MaxOrderProductValue. Nullable.

MaxWeightnumber(decimal)

MaxWeight. Nullable.

MaxWidthnumber(decimal)

MaxWidth. Nullable.

MaxHeightnumber(decimal)

MaxHeight. Nullable.

MaxDepthnumber(decimal)

MaxDepth. Nullable.

MaxGirthnumber(decimal)

MaxGirth. Nullable.

MaxVolumenumber(decimal)

MaxVolume. Nullable.

MaxUnitsnumber(decimal)

MaxUnits. Nullable.

MinTempnumber(decimal)

MinTemp. Nullable.

MaxTempnumber(decimal)

MaxTemp. Nullable.

UseVolumeWeightboolean

UseVolumeWeight.

UseLargestWeightboolean

UseLargestWeight.

VolumeWeightFactornumber(decimal)

VolumeWeightFactor. Nullable.

IsStackableboolean

IsStackable.

IsActiveboolean

IsActive.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

MaxVolumeWeightnumber(decimal)

MaxVolumeWeight. Nullable.

HasSkuTypesboolean

HasSkuTypes.

AreSkuTypesForcedboolean

AreSkuTypesForced.

SortOrderinteger(int32)

SortOrder. Nullable.

MinOrderProductValuenumber(decimal)

MinOrderProductValue. Nullable.

ClientIdinteger(int32)

ClientId. Nullable.

CulturesArray of objects(Enferno.Storm.Query.Api.DataContexts.ShoppingModel.ApplicationDeliveryMethodCulture)(Enferno.Storm.Query.Api.DataContexts.ShoppingModel.ApplicationDeliveryMethodCulture)

Cultures.

]
Response
application/json
[
  {
    "ApplicationId": 0,
    "DeliveryMethodId": 0,
    "Code": "string",
    "OnlyCompanies": true,
    "OnlyNotCompanies": true,
    "HasLocations": true,
    "HasCustomerFlags": true,
    "HasPaymentMethods": true,
    "HasDeliveryNotification": true,
    "AvailableAsDropShip": true,
    "AllowDangerousGoods": true,
    "CurrencyId": 0,
    "MaxOrderProductValue": 0,
    "MaxWeight": 0,
    "MaxWidth": 0,
    "MaxHeight": 0,
    "MaxDepth": 0,
    "MaxGirth": 0,
    "MaxVolume": 0,
    "MaxUnits": 0,
    "MinTemp": 0,
    "MaxTemp": 0,
    "UseVolumeWeight": true,
    "UseLargestWeight": true,
    "VolumeWeightFactor": 0,
    "IsStackable": true,
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0,
    "MaxVolumeWeight": 0,
    "HasSkuTypes": true,
    "AreSkuTypesForced": true,
    "SortOrder": 0,
    "MinOrderProductValue": 0,
    "ClientId": 0,
    "Cultures": [ … ]
  }
]

Get RecurringOrder

Request

Get RecurringOrder

curl -i -X GET \
  https://query.storm.io/Query/2.0/Shopping/RecurringOrders

Responses

Success

Bodyapplication/jsonArray [
Idinteger(int32)

Id. Key property.

ClientIdinteger(int32)

ClientId.

ApplicationIdinteger(int32)

ApplicationId.

TypeIdinteger(int32)

TypeId.

TemplateQuotationIdinteger(int32)

TemplateQuotationId.

StatusIdinteger(int32)

StatusId.

HoldFromDatestring(date-time)

HoldFromDate. Nullable.

HoldUntilDatestring(date-time)

HoldUntilDate. Nullable.

StartDatestring(date-time)

StartDate. Nullable.

EndDatestring(date-time)

EndDate. Nullable.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

SchedulesArray of objects(Enferno.Storm.Query.Api.DataContexts.ShoppingModel.RecurringOrderSchedule)(Enferno.Storm.Query.Api.DataContexts.ShoppingModel.RecurringOrderSchedule)

Schedules.

Typeobject(Enferno.Storm.Query.Api.DataContexts.ShoppingModel.RecurringOrderType)(Enferno.Storm.Query.Api.DataContexts.ShoppingModel.RecurringOrderType)
]
Response
application/json
[
  {
    "Id": 0,
    "ClientId": 0,
    "ApplicationId": 0,
    "TypeId": 0,
    "TemplateQuotationId": 0,
    "StatusId": 0,
    "HoldFromDate": "2019-08-24T14:15:22Z",
    "HoldUntilDate": "2019-08-24T14:15:22Z",
    "StartDate": "2019-08-24T14:15:22Z",
    "EndDate": "2019-08-24T14:15:22Z",
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0,
    "Schedules": [ … ],
    "Type": { … }
  }
]

GetPaymentAmount

Request

GetPaymentAmount

Query
quotationIdinteger(int32)required
curl -i -X GET \
  'https://query.storm.io/Query/2.0/Shopping/GetPaymentAmount?quotationId=0'

Responses

Success

Bodyapplication/json
number(decimal)
Response
application/json
0