Skip to content
COMMERCE QUERY
/
Shopping
/
/
Enferno.Storm.Query.Api.D...

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://customer-slug.api-se.norce.tech/commerce/query/2.0/

Schemas

Schemas

Enferno.Storm.Query.Api.DataContexts.ShoppingModel.ApplicationDeliveryMethodCulture

ApplicationIdinteger(int32)

ApplicationId. Key property.

DeliveryMethodIdinteger(int32)

DeliveryMethodId. Key property.

CultureCodestring

CultureCode. MaxLength: 16. Key property.

Namestring

Name. MaxLength: 50. Nullable.

Descriptionstring

Description. Nullable.

LogoPathstring

LogoPath. MaxLength: 255. Nullable.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

LogoKeystring(guid)

LogoKey. Nullable.

ClientIdinteger(int32)

ClientId. Nullable.

{
  "ApplicationId": 0,
  "DeliveryMethodId": 0,
  "CultureCode": "string",
  "Name": "string",
  "Description": "string",
  "LogoPath": "string",
  "Updated": "2019-08-24T14:15:22Z",
  "UpdatedBy": 0,
  "LogoKey": "string",
  "ClientId": 0
}

Enferno.Storm.Query.Api.DataContexts.ShoppingModel.ApplicationPaymentMethodCulture

ApplicationIdinteger(int32)

ApplicationId. Key property.

PaymentMethodIdinteger(int32)

PaymentMethodId. Key property.

CultureCodestring

CultureCode. MaxLength: 16. Key property.

Namestring

Name. MaxLength: 50. Nullable.

Descriptionstring

Description. Nullable.

LogoPathstring

LogoPath. MaxLength: 500. Nullable.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy.

LogoKeystring(guid)

LogoKey. Nullable.

ClientIdinteger(int32)

ClientId. Nullable.

{
  "ApplicationId": 0,
  "PaymentMethodId": 0,
  "CultureCode": "string",
  "Name": "string",
  "Description": "string",
  "LogoPath": "string",
  "Updated": "2019-08-24T14:15:22Z",
  "UpdatedBy": 0,
  "LogoKey": "string",
  "ClientId": 0
}

Enferno.Storm.Query.Api.DataContexts.ShoppingModel.RecurringOrderSchedule

RecurringOrderIdinteger(int32)

RecurringOrderId. Key property.

Idinteger(int32)

Id. Key property.

ClientIdinteger(int32)

ClientId.

ApplicationIdinteger(int32)

ApplicationId.

FrequencyIdinteger(int32)

FrequencyId.

RecurValueinteger(int32)

RecurValue.

WeeklyMondayboolean

WeeklyMonday.

WeeklyTuesdayboolean

WeeklyTuesday.

WeeklyWednesdayboolean

WeeklyWednesday.

WeeklyThursdayboolean

WeeklyThursday.

WeeklyFridayboolean

WeeklyFriday.

WeeklySaturdayboolean

WeeklySaturday.

WeeklySundayboolean

WeeklySunday.

MonthlyDayinteger(int32)

MonthlyDay.

MonthlyIntervalIdinteger(int32)

MonthlyIntervalId.

MonthlyIntervalValueIdinteger(int32)

MonthlyIntervalValueId.

TimeOfDaystring

TimeOfDay. Nullable.

IsActiveboolean

IsActive.

StoppedDatestring(date-time)

StoppedDate. Nullable.

StoppedByinteger(int32)

StoppedBy. Nullable.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

{
  "RecurringOrderId": 0,
  "Id": 0,
  "ClientId": 0,
  "ApplicationId": 0,
  "FrequencyId": 0,
  "RecurValue": 0,
  "WeeklyMonday": true,
  "WeeklyTuesday": true,
  "WeeklyWednesday": true,
  "WeeklyThursday": true,
  "WeeklyFriday": true,
  "WeeklySaturday": true,
  "WeeklySunday": true,
  "MonthlyDay": 0,
  "MonthlyIntervalId": 0,
  "MonthlyIntervalValueId": 0,
  "TimeOfDay": "string",
  "IsActive": true,
  "StoppedDate": "2019-08-24T14:15:22Z",
  "StoppedBy": 0,
  "Created": "2019-08-24T14:15:22Z",
  "CreatedBy": 0,
  "Updated": "2019-08-24T14:15:22Z",
  "UpdatedBy": 0
}

Enferno.Storm.Query.Api.DataContexts.ShoppingModel.RecurringOrderType

Idinteger(int32)

Id. Key property.

ClientIdinteger(int32)

ClientId.

ApplicationIdinteger(int32)

ApplicationId.

Codestring

Code. MaxLength: 50. Nullable.

Namestring

Name. MaxLength: 50. Nullable.

Descriptionstring

Description. MaxLength: 500. Nullable.

EndDatestring(date-time)

EndDate. Nullable.

IsActiveboolean

IsActive.

StoppedDatestring(date-time)

StoppedDate. Nullable.

StoppedByinteger(int32)

StoppedBy. Nullable.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

{
  "Id": 0,
  "ClientId": 0,
  "ApplicationId": 0,
  "Code": "string",
  "Name": "string",
  "Description": "string",
  "EndDate": "2019-08-24T14:15:22Z",
  "IsActive": true,
  "StoppedDate": "2019-08-24T14:15:22Z",
  "StoppedBy": 0,
  "Created": "2019-08-24T14:15:22Z",
  "CreatedBy": 0,
  "Updated": "2019-08-24T14:15:22Z",
  "UpdatedBy": 0
}

Enferno.Storm.Query.Api.DataContexts.ShoppingModel.ApplicationPaymentMethod

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.

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

Enferno.Storm.Query.Api.DataContexts.ShoppingModel.ApplicationDeliveryMethod

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.

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

Enferno.Storm.Query.Api.DataContexts.ShoppingModel.RecurringOrder

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)
{
  "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": {
    "Id": 0,
    "ClientId": 0,
    "ApplicationId": 0,
    "Code": "string",
    "Name": "string",
    "Description": "string",
    "EndDate": "2019-08-24T14:15:22Z",
    "IsActive": true,
    "StoppedDate": "2019-08-24T14:15:22Z",
    "StoppedBy": 0,
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0
  }
}

Shopping

Operations