STORM QUERY
/
Products
/
Products

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/

Schemas

Products

Operations

Get Product

Request

Get Product

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

Responses

Success

Bodyapplication/jsonArray [
Idinteger(int32)

Id. Key property.

ClientIdinteger(int32)

ClientId.

ManufacturerIdinteger(int32)

ManufacturerId.

ManufacturerPartNostring

ManufacturerPartNo. MaxLength: 50. Nullable.

DefaultNamestring

DefaultName. MaxLength: 255. Nullable.

DefaultSubHeaderstring

DefaultSubHeader. MaxLength: 255. Nullable.

DefaultSubDescriptionstring

DefaultSubDescription. Nullable.

DefaultDescriptionHeaderstring

DefaultDescriptionHeader. MaxLength: 255. Nullable.

DefaultDescriptionstring

DefaultDescription. Nullable.

DefaultImagePathstring

DefaultImagePath. MaxLength: 255. Nullable.

DefaultThumbnailImagePathstring

DefaultThumbnailImagePath. MaxLength: 255. Nullable.

DefaultCampaignImagePathstring

DefaultCampaignImagePath. MaxLength: 255. Nullable.

DefaultLargeImagePathstring

DefaultLargeImagePath. MaxLength: 255. Nullable.

DefaultSynonymsstring

DefaultSynonyms. MaxLength: 500. Nullable.

SortOrderValueinteger(int32)

SortOrderValue. Nullable.

AssortmentIdinteger(int32)

AssortmentId. Nullable.

AssortmentLastUpdatedstring(date-time)

AssortmentLastUpdated. Nullable.

AssortmentLastUpdatedByinteger(int32)

AssortmentLastUpdatedBy. Nullable.

IsVariantboolean

IsVariant.

VariantIdinteger(int32)

VariantId. Nullable.

Aliasstring

Alias. MaxLength: 255. Nullable.

DefaultTitlestring

DefaultTitle. MaxLength: 255. Nullable.

DefaultTagsstring

DefaultTags. Nullable.

DefaultMetaTagsstring

DefaultMetaTags. Nullable.

DefaultMetaDescriptionstring

DefaultMetaDescription. Nullable.

HideInTopListboolean

HideInTopList. Nullable.

IsActiveboolean

IsActive.

StoppedDatestring(date-time)

StoppedDate. Nullable.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

InsuranceCurrencyIdinteger(int32)

InsuranceCurrencyId. Nullable.

InsuranceStartPricenumber(decimal)

InsuranceStartPrice. Nullable.

InsuranceRunningPercentagenumber(decimal)

InsuranceRunningPercentage. Nullable.

Keystring(guid)

Key.

ManufacturerPartNo2string

ManufacturerPartNo2. MaxLength: 50. Nullable.

ImageKeystring(guid)

ImageKey. Nullable.

DefaultUniqueUrlNamestring

DefaultUniqueUrlName. MaxLength: 500. Nullable.

StockDisplayBreakPointinteger(int32)

StockDisplayBreakPoint. Nullable.

IsDangerousGoodsboolean

IsDangerousGoods.

Codestring

Code. MaxLength: 50. Nullable.

IsRecurringOrderableboolean

IsRecurringOrderable. Nullable.

DefaultExternalDescriptionstring

DefaultExternalDescription. Nullable.

UnspscCodestring

UnspscCode. MaxLength: 50. Nullable.

TranslationRequestedstring(date-time)

TranslationRequested. Nullable.

TranslationRequestedByinteger(int32)

TranslationRequestedBy. Nullable.

SkusArray of objects(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductSku)(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductSku)

Skus.

CategoriesArray of objects(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductCategory)(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductCategory)

Categories.

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

Cultures.

SupplierSkusArray of objects(Enferno.Storm.Query.Api.DataContexts.ProductModel.SupplierProductSkuClient)(Enferno.Storm.Query.Api.DataContexts.ProductModel.SupplierProductSkuClient)

SupplierSkus.

ParametricsArray of objects(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductParametric)(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductParametric)

Parametrics.

ParametricMultipleArray of objects(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductParametricMultiple)(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductParametricMultiple)

ParametricMultiple.

Variantobject(Enferno.Storm.Query.Api.DataContexts.ProductModel.Variant)(Enferno.Storm.Query.Api.DataContexts.ProductModel.Variant)
FlagsArray of objects(Enferno.Storm.Query.Api.DataContexts.ProductModel.ClientProductFlag)(Enferno.Storm.Query.Api.DataContexts.ProductModel.ClientProductFlag)

Flags.

FamiliesArray of objects(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductFamily)(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductFamily)

Families.

AccessoriesArray of objects(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductAccessory)(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductAccessory)

Accessories.

UpsellArray of objects(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductUpsell)(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductUpsell)

Upsell.

CrossellArray of objects(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductCrossell)(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductCrossell)

Crossell.

VariantTypesArray of objects(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductVariantType)(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductVariantType)

VariantTypes.

FilesArray of objects(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductFile)(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductFile)

Files.

PopularitiesArray of objects(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductPopularity)(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductPopularity)

Popularities.

ProductRelationsArray of objects(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductRelation)(Enferno.Storm.Query.Api.DataContexts.ProductModel.ProductRelation)

ProductRelations.

]
Response
application/json
[
  {
    "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": [ … ]
  }
]

Get ProductCategory

Request

Get ProductCategory

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

Responses

Success

Bodyapplication/jsonArray [
ProductIdinteger(int32)

ProductId. Key property.

CategoryIdinteger(int32)

CategoryId. Key property.

ClientIdinteger(int32)

ClientId.

IsPrimaryboolean

IsPrimary.

SortOrderinteger(int32)

SortOrder. Nullable.

ProductSortOrderinteger(int32)

ProductSortOrder. Nullable.

IsActiveboolean

IsActive.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

]
Response
application/json
[
  {
    "ProductId": 0,
    "CategoryId": 0,
    "ClientId": 0,
    "IsPrimary": true,
    "SortOrder": 0,
    "ProductSortOrder": 0,
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0
  }
]

Get SupplierProductSkuClient

Request

Get SupplierProductSkuClient

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

Responses

Success

Bodyapplication/jsonArray [
PartNostring

PartNo. MaxLength: 50. Key property.

SupplierIdinteger(int32)

SupplierId. Key property.

ClientIdinteger(int32)

ClientId.

ProductIdinteger(int32)

ProductId. Nullable.

ManufacturerIdinteger(int32)

ManufacturerId. Nullable.

CategoryIdinteger(int32)

CategoryId. Nullable.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

Skuobject(Enferno.Storm.Query.Api.DataContexts.ProductModel.SupplierProductSku)(Enferno.Storm.Query.Api.DataContexts.ProductModel.SupplierProductSku)
Productobject(Enferno.Storm.Query.Api.DataContexts.ProductModel.Product)(Enferno.Storm.Query.Api.DataContexts.ProductModel.Product)
]
Response
application/json
[
  {
    "PartNo": "string",
    "SupplierId": 0,
    "ClientId": 0,
    "ProductId": 0,
    "ManufacturerId": 0,
    "CategoryId": 0,
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0,
    "Sku": { … },
    "Product": { … }
  }
]