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

Operations

Request

Get ProductSku

curl -i -X GET \
  https://customer-slug.api-se.norce.tech/commerce/query/2.0/Products/ProductSkus

Responses

Success

Bodyapplication/jsonArray [
PartNostring

PartNo. MaxLength: 50. Key property.

ProductIdinteger(int32)

ProductId.

ClientIdinteger(int32)

ClientId.

StatusIdinteger(int32)

StatusId.

StatusLastUpdatedstring(date-time)

StatusLastUpdated. Nullable.

StatusLastUpdatedByinteger(int32)

StatusLastUpdatedBy. Nullable.

TypeIdinteger(int32)

TypeId.

IntegrationPartNostring

IntegrationPartNo. MaxLength: 50. Nullable.

ErpNamestring

ErpName. MaxLength: 255. Nullable.

DefaultCommentstring

DefaultComment. MaxLength: 255. Nullable.

CommodityCodestring

CommodityCode. MaxLength: 50. Nullable.

EanCodestring

EanCode. MaxLength: 50. Nullable.

TrackingCodestring

TrackingCode. MaxLength: 50. Nullable.

GrossWeightnumber(decimal)

GrossWeight. Nullable.

NetWeightnumber(decimal)

NetWeight. Nullable.

FreightClassIdinteger(int32)

FreightClassId. Nullable.

UnitOfMeasurementIdinteger(int32)

UnitOfMeasurementId. Nullable.

UnitOfMeasurementCountnumber(decimal)

UnitOfMeasurementCount.

PackageIdinteger(int32)

PackageId. Nullable.

TrackingCodeTypeIdinteger(int32)

TrackingCodeTypeId. Nullable.

Urlstring

Url. MaxLength: 255. Nullable.

ImagePathstring

ImagePath. MaxLength: 255. Nullable.

IsDropShipOnlyboolean

IsDropShipOnly. Nullable.

IsPublishedboolean

IsPublished.

PublishedLastUpdatedstring(date-time)

PublishedLastUpdated. Nullable.

PublishedLastUpdatedByinteger(int32)

PublishedLastUpdatedBy. Nullable.

IsBlockedboolean

IsBlocked.

BlockedLastUpdatedstring(date-time)

BlockedLastUpdated. Nullable.

BlockedLastUpdatedByinteger(int32)

BlockedLastUpdatedBy. Nullable.

PopulationRuleIdinteger(int32)

PopulationRuleId. Nullable.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

LastCheckedstring(date-time)

LastChecked. Nullable.

TrackingModeTypeIdinteger(int32)

TrackingModeTypeId. Nullable.

IsStatusLockedboolean

IsStatusLocked.

StatusLockedDatestring(date-time)

StatusLockedDate. Nullable.

StatusLockedByinteger(int32)

StatusLockedBy. Nullable.

RecommendedSalesQtynumber(decimal)

RecommendedSalesQty. Nullable.

LogisticWidthnumber(decimal)

LogisticWidth. Nullable.

LogisticHeightnumber(decimal)

LogisticHeight. Nullable.

LogisticDepthnumber(decimal)

LogisticDepth. Nullable.

IsBuyableboolean

IsBuyable.

BuyableLastUpdatedstring(date-time)

BuyableLastUpdated. Nullable.

BuyableLastUpdatedByinteger(int32)

BuyableLastUpdatedBy. Nullable.

DiscountClassstring

DiscountClass. MaxLength: 50. Nullable.

IsRecommendedSalesQtyFixedboolean

IsRecommendedSalesQtyFixed. Nullable.

StartDatestring(date-time)

StartDate. Nullable.

EndDatestring(date-time)

EndDate. Nullable.

Productobject(Enferno.Storm.Query.Api.DataContexts.ProductModel.Product)(Enferno.Storm.Query.Api.DataContexts.ProductModel.Product)
CulturesArray of objects(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductSkuCulture)(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductSkuCulture)

Cultures.

PriceListsArray of objects(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductSkuPricelist)(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductSkuPricelist)

PriceLists.

SalesAreasArray of objects(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductSkuSalesArea)(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductSkuSalesArea)

SalesAreas.

OnHandsArray of objects(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductSkuOnHand)(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductSkuOnHand)

OnHands.

StructureItemsArray of objects(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductSkuStructureItem)(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductSkuStructureItem)

StructureItems.

BestPricesArray of objects(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductSkuBestPrice)(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductSkuBestPrice)

BestPrices.

]
Response
application/json
[ { "PartNo": "string", "ProductId": 0, "ClientId": 0, "StatusId": 0, "StatusLastUpdated": "2019-08-24T14:15:22Z", "StatusLastUpdatedBy": 0, "TypeId": 0, "IntegrationPartNo": "string", "ErpName": "string", "DefaultComment": "string", "CommodityCode": "string", "EanCode": "string", "TrackingCode": "string", "GrossWeight": 0, "NetWeight": 0, "FreightClassId": 0, "UnitOfMeasurementId": 0, "UnitOfMeasurementCount": 0, "PackageId": 0, "TrackingCodeTypeId": 0, "Url": "string", "ImagePath": "string", "IsDropShipOnly": true, "IsPublished": true, "PublishedLastUpdated": "2019-08-24T14:15:22Z", "PublishedLastUpdatedBy": 0, "IsBlocked": true, "BlockedLastUpdated": "2019-08-24T14:15:22Z", "BlockedLastUpdatedBy": 0, "PopulationRuleId": 0, "Created": "2019-08-24T14:15:22Z", "CreatedBy": 0, "Updated": "2019-08-24T14:15:22Z", "UpdatedBy": 0, "LastChecked": "2019-08-24T14:15:22Z", "TrackingModeTypeId": 0, "IsStatusLocked": true, "StatusLockedDate": "2019-08-24T14:15:22Z", "StatusLockedBy": 0, "RecommendedSalesQty": 0, "LogisticWidth": 0, "LogisticHeight": 0, "LogisticDepth": 0, "IsBuyable": true, "BuyableLastUpdated": "2019-08-24T14:15:22Z", "BuyableLastUpdatedBy": 0, "DiscountClass": "string", "IsRecommendedSalesQtyFixed": true, "StartDate": "2019-08-24T14:15:22Z", "EndDate": "2019-08-24T14:15:22Z", "Product": {}, "Cultures": [], "PriceLists": [], "SalesAreas": [], "OnHands": [], "StructureItems": [], "BestPrices": [] } ]

Request

Get ProductSkuPricelist

curl -i -X GET \
  https://customer-slug.api-se.norce.tech/commerce/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": [] } ]

Request

Get Variant

curl -i -X GET \
  https://customer-slug.api-se.norce.tech/commerce/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": {} } ]