STORM QUERY

Products

Get Variant

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

Servers

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

Schemas

Products

Operations

Get ProductSkuPricelist

Request

Get ProductSkuPricelist

curl -i -X GET \
  https://query.storm.io/Query/2.0/Products/ProductSkuPriceLists

Responses

Success

Bodyapplication/jsonArray [

PartNostring

PartNo. MaxLength: 50. Key property.

PriceListIdinteger(int32)

PriceListId. Key property.

QtyBreakinteger(int32)

QtyBreak. Key property.

ClientIdinteger(int32)

ClientId.

CurrencyIdinteger(int32)

CurrencyId.

PriceSalenumber(decimal)

PriceSale.

PriceSaleLastUpdatedstring(date-time)

PriceSaleLastUpdated. Nullable.

PriceSaleLastUpdatedByinteger(int32)

PriceSaleLastUpdatedBy. Nullable.

PriceRuleIdinteger(int32)

PriceRuleId. Nullable.

PriceRuleValuenumber(decimal)

PriceRuleValue. Nullable.

CostPurchasenumber(decimal)

CostPurchase.

CostPurchaseLastUpdatedstring(date-time)

CostPurchaseLastUpdated. Nullable.

CostPurchaseLastUpdatedByinteger(int32)

CostPurchaseLastUpdatedBy. Nullable.

CostUnitnumber(decimal)

CostUnit.

CostUnitLastUpdatedstring(date-time)

CostUnitLastUpdated. Nullable.

CostUnitLastUpdatedByinteger(int32)

CostUnitLastUpdatedBy. Nullable.

SupplementChargePercentagenumber(decimal)

SupplementChargePercentage. Nullable.

PriceStandardnumber(decimal)

PriceStandard. Nullable.

PriceRecommendednumber(decimal)

PriceRecommended. Nullable.

PriceRecommendedLastUpdatedstring(date-time)

PriceRecommendedLastUpdated. Nullable.

PriceRecommendedLastUpdatedByinteger(int32)

PriceRecommendedLastUpdatedBy. Nullable.

PricePreviousnumber(decimal)

PricePrevious. Nullable.

PricePreviousLastUpdatedstring(date-time)

PricePreviousLastUpdated. Nullable.

PricePreviousLastUpdatedByinteger(int32)

PricePreviousLastUpdatedBy. Nullable.

PriceCatalognumber(decimal)

PriceCatalog. Nullable.

PriceCatalogLastUpdatedstring(date-time)

PriceCatalogLastUpdated. Nullable.

PriceCatalogLastUpdatedByinteger(int32)

PriceCatalogLastUpdatedBy. Nullable.

IsPriceDiscountableboolean

IsPriceDiscountable.

ChosenSupplierIdinteger(int32)

ChosenSupplierId. Nullable.

ChosenSupplierPartNostring

ChosenSupplierPartNo. MaxLength: 50. Nullable.

ChosenSupplierPriceListIdinteger(int32)

ChosenSupplierPriceListId. Nullable.

ChosenSupplierQtyBreakinteger(int32)

ChosenSupplierQtyBreak. Nullable.

IsChosenSupplierLockedboolean

IsChosenSupplierLocked.

IsActiveboolean

IsActive.

StoppedDatestring(date-time)

StoppedDate. Nullable.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

LastCheckedstring(date-time)

LastChecked. Nullable.

MinimumMarginPercentagenumber(decimal)

MinimumMarginPercentage. Nullable.

PriceRuleLastUpdatedstring(date-time)

PriceRuleLastUpdated. Nullable.

PriceRuleLastUpdatedByinteger(int32)

PriceRuleLastUpdatedBy. Nullable.

PricingIdinteger(int32)

PricingId. Nullable.

SupplementChargenumber(decimal)

SupplementCharge. Nullable.

LimitToPriceRecommendedboolean

LimitToPriceRecommended. Nullable.

IsActiveLastUpdatedstring(date-time)

IsActiveLastUpdated. Nullable.

IsActiveLastUpdatedByinteger(int32)

IsActiveLastUpdatedBy. Nullable.

Skuobject(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductSku)(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductSku)

InfoArray of objects(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductSkuPriceListInfo)(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductSkuPriceListInfo)

Info.

]

Response

application/json

[
  {
    "PartNo": "string",
    "PriceListId": 0,
    "QtyBreak": 0,
    "ClientId": 0,
    "CurrencyId": 0,
    "PriceSale": 0,
    "PriceSaleLastUpdated": "2019-08-24T14:15:22Z",
    "PriceSaleLastUpdatedBy": 0,
    "PriceRuleId": 0,
    "PriceRuleValue": 0,
    "CostPurchase": 0,
    "CostPurchaseLastUpdated": "2019-08-24T14:15:22Z",
    "CostPurchaseLastUpdatedBy": 0,
    "CostUnit": 0,
    "CostUnitLastUpdated": "2019-08-24T14:15:22Z",
    "CostUnitLastUpdatedBy": 0,
    "SupplementChargePercentage": 0,
    "PriceStandard": 0,
    "PriceRecommended": 0,
    "PriceRecommendedLastUpdated": "2019-08-24T14:15:22Z",
    "PriceRecommendedLastUpdatedBy": 0,
    "PricePrevious": 0,
    "PricePreviousLastUpdated": "2019-08-24T14:15:22Z",
    "PricePreviousLastUpdatedBy": 0,
    "PriceCatalog": 0,
    "PriceCatalogLastUpdated": "2019-08-24T14:15:22Z",
    "PriceCatalogLastUpdatedBy": 0,
    "IsPriceDiscountable": true,
    "ChosenSupplierId": 0,
    "ChosenSupplierPartNo": "string",
    "ChosenSupplierPriceListId": 0,
    "ChosenSupplierQtyBreak": 0,
    "IsChosenSupplierLocked": true,
    "IsActive": true,
    "StoppedDate": "2019-08-24T14:15:22Z",
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0,
    "LastChecked": "2019-08-24T14:15:22Z",
    "MinimumMarginPercentage": 0,
    "PriceRuleLastUpdated": "2019-08-24T14:15:22Z",
    "PriceRuleLastUpdatedBy": 0,
    "PricingId": 0,
    "SupplementCharge": 0,
    "LimitToPriceRecommended": true,
    "IsActiveLastUpdated": "2019-08-24T14:15:22Z",
    "IsActiveLastUpdatedBy": 0,
    "Sku": { … },
    "Info": [ … ]
  }
]

Get Variant

Request

Get Variant

curl -i -X GET \
  https://query.storm.io/Query/2.0/Products/Variants

Responses

Success

Bodyapplication/jsonArray [

Idinteger(int32)

Id. Key property.

ClientIdinteger(int32)

ClientId.

DefaultNamestring

DefaultName. MaxLength: 255. Nullable.

DefaultImagePathstring

DefaultImagePath. MaxLength: 255. Nullable.

DefaultThumbnailImagePathstring

DefaultThumbnailImagePath. MaxLength: 255. Nullable.

DefaultCampaignImagePathstring

DefaultCampaignImagePath. MaxLength: 255. Nullable.

DefaultLargeImagePathstring

DefaultLargeImagePath. MaxLength: 255. Nullable.

GroupIdinteger(int32)

GroupId. Nullable.

Aliasstring

Alias. MaxLength: 255. Nullable.

DefaultTitlestring

DefaultTitle. MaxLength: 255. Nullable.

DefaultTagsstring

DefaultTags. Nullable.

DefaultMetaTagsstring

DefaultMetaTags. Nullable.

DefaultMetaDescriptionstring

DefaultMetaDescription. Nullable.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

ImageKeystring(guid)

ImageKey. Nullable.

Codestring

Code. MaxLength: 50. Nullable.

DefaultUniqueUrlNamestring

DefaultUniqueUrlName. MaxLength: 500. Nullable.

Keystring(guid)

Key.

CulturesArray of objects(Enferno.Storm.Query.Api.DataContexts.ProductModel.VariantCulture)(Enferno.Storm.Query.Api.DataContexts.ProductModel.VariantCulture)

Cultures.

ProductsArray of objects(Enferno.Storm.Query.Api.DataContexts.ProductModel.Product)(Enferno.Storm.Query.Api.DataContexts.ProductModel.Product)

Products.

VariantGroupobject(ProductService.ProductVariantGroup)(ProductService.ProductVariantGroup)

]

Response

application/json

[
  {
    "Id": 0,
    "ClientId": 0,
    "DefaultName": "string",
    "DefaultImagePath": "string",
    "DefaultThumbnailImagePath": "string",
    "DefaultCampaignImagePath": "string",
    "DefaultLargeImagePath": "string",
    "GroupId": 0,
    "Alias": "string",
    "DefaultTitle": "string",
    "DefaultTags": "string",
    "DefaultMetaTags": "string",
    "DefaultMetaDescription": "string",
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0,
    "ImageKey": "string",
    "Code": "string",
    "DefaultUniqueUrlName": "string",
    "Key": "string",
    "Cultures": [ … ],
    "Products": [ … ],
    "VariantGroup": { … }
  }
]

Get ProductAccessory

Request

Get ProductAccessory

curl -i -X GET \
  https://query.storm.io/Query/2.0/Products/ProductAccessories

Responses

Success

Bodyapplication/jsonArray [

ProductIdinteger(int32)

ProductId. Key property.

ClientIdinteger(int32)

ClientId.

AccessoryProductIdinteger(int32)

AccessoryProductId.

TypeIdinteger(int32)

TypeId.

SortOrderinteger(int32)

SortOrder. Nullable.

PopulationRuleIdinteger(int32)

PopulationRuleId. Nullable.

IsActiveboolean

IsActive.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

IsProductVariantUniqueboolean

IsProductVariantUnique.

IsAccessoryProductVariantUniqueboolean

IsAccessoryProductVariantUnique.

CulturesArray of objects(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductAccessoryCulture)(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductAccessoryCulture)

Cultures.

]

Response

application/json

[
  {
    "ProductId": 0,
    "ClientId": 0,
    "AccessoryProductId": 0,
    "TypeId": 0,
    "SortOrder": 0,
    "PopulationRuleId": 0,
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0,
    "IsProductVariantUnique": true,
    "IsAccessoryProductVariantUnique": true,
    "Cultures": [ … ]
  }
]

Storm Query API Documentation (2.0)

Schemas

Products

Get ProductSkuPricelist

Request

Responses

Did the information on the page help you?

Get Variant

Request

Responses

Did the information on the page help you?

Get ProductAccessory

Request

Responses

Did the information on the page help you?