Skip to content
COMMERCE QUERY
/
Products
/
/
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.ProductModel.ProductSku

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.

{
  "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": {
    "Id": 0,
    "ClientId": 0,
    "ManufacturerId": 0,
    "ManufacturerPartNo": "string",
    "DefaultName": "string",
    "DefaultSubHeader": "string",
    "DefaultSubDescription": "string",
    "DefaultDescriptionHeader": "string",
    "DefaultDescription": "string",
    "DefaultImagePath": "string",
    "DefaultThumbnailImagePath": "string",
    "DefaultCampaignImagePath": "string",
    "DefaultLargeImagePath": "string",
    "DefaultSynonyms": "string",
    "SortOrderValue": 0,
    "AssortmentId": 0,
    "AssortmentLastUpdated": "2019-08-24T14:15:22Z",
    "AssortmentLastUpdatedBy": 0,
    "IsVariant": true,
    "VariantId": 0,
    "Alias": "string",
    "DefaultTitle": "string",
    "DefaultTags": "string",
    "DefaultMetaTags": "string",
    "DefaultMetaDescription": "string",
    "HideInTopList": 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,
    "InsuranceCurrencyId": 0,
    "InsuranceStartPrice": 0,
    "InsuranceRunningPercentage": 0,
    "Key": "string",
    "ManufacturerPartNo2": "string",
    "ImageKey": "string",
    "DefaultUniqueUrlName": "string",
    "StockDisplayBreakPoint": 0,
    "IsDangerousGoods": true,
    "Code": "string",
    "IsRecurringOrderable": true,
    "DefaultExternalDescription": "string",
    "UnspscCode": "string",
    "TranslationRequested": "2019-08-24T14:15:22Z",
    "TranslationRequestedBy": 0,
    "Skus": [ … ],
    "Categories": [ … ],
    "Cultures": [ … ],
    "SupplierSkus": [ … ],
    "Parametrics": [ … ],
    "ParametricMultiple": [ … ],
    "Variant": { … },
    "Flags": [ … ],
    "Families": [ … ],
    "Accessories": [ … ],
    "Upsell": [ … ],
    "Crossell": [ … ],
    "VariantTypes": [ … ],
    "Files": [ … ],
    "Popularities": [ … ],
    "ProductRelations": [ … ]
  },
  "Cultures": [
    { … }
  ],
  "PriceLists": [
    { … }
  ],
  "SalesAreas": [
    { … }
  ],
  "OnHands": [
    { … }
  ],
  "StructureItems": [
    { … }
  ],
  "BestPrices": [
    { … }
  ]
}

Enferno.Storm.Query.Api.DataContexts.ProductModel.Variant

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)
{
  "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": {
    "Id": 0,
    "ClientId": 0,
    "DefaultName": "string",
    "DefaultDescription": "string",
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0,
    "Code": "string",
    "Cultures": "string"
  }
}

Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductAccessory

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.

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

Products

Operations