STORM API
/
Product Service
/
Relations

Documentation ProductService (1.1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
https://demo.storm.io/api/1.1/

Assortments

Operations

Categories

Operations

Configurations

Operations

Families

Operations

Files

Operations

Filters

Operations

Flags

Operations

InfoTypes

Operations

Manufacturers

Operations

Navigation

Operations

OnHand

Operations

Parametric

Operations

PriceLists

Operations

Products

Operations

Promotions

Operations

Relations

Operations

List product assortment types [Obsolete("Use ListProductRelationTypes.")]

Request

Reference list of Product Accessory types.

Query
cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

curl -i -X GET \
  https://demo.storm.io/api/1.1/ProductService.svc/rest/ListAccessoryTypes

Responses

Success

Body
Array [
Idinteger(int32)

The internal Id of the Entity. This Id might be different in different tiers such as Stage and Production. Use Code if hard coding is required.

Valuestring

The Value of the Entity. MaxLength: max.

Codestring

The Code of the Entity, if existing. Use this value when hard coding is required. MaxLength: 255.

]
Response
[
  {
    "Id": 0,
    "Value": "string",
    "Code": "string"
  }
]

List product accessories [Obsolete("Use ListProductRelations")]

Request

Accessories connected to a product. Accessories is defined as products that customer could choose to buy in addition to the current product.

Query
productIdinteger(int32)required

ID of current Product.

accessoryTypeinteger(int32)required

The accessory type to list. Lookup references in ListAccessoryTypes.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

assortmentSeedstringrequired

Accepts a comma separated string of Assortment internal ids. Lookup references in ListAssortments.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

sizestring

Number of items to display.

cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListProductAccessories?accessoryType=0&assortmentSeed=string&productId=0&statusSeed=string'

Responses

Success

Body
ItemCountinteger(int32)

Counts the number of products in the list. If the list is fetched with AsVariants set to true ItemCount will still just count the number of products. Not items in the list. When fetched with a method that has filters, this value will be to total after the filters have been applied.

ItemsArray of objects(ProductItem)(ProductItem)
Response
{
  "ItemCount": 0,
  "Items": [
    { … }
  ]
}

List product accessories (v2) [Obsolete("Use ListProductRelations")]

Request

Accessories connected to a product. Accessories is defined as products that customer could choose to buy in addition to the current product.

Query
productIdinteger(int32)required

ID of current Product.

accessoryTypeinteger(int32)required

The accessory type to list. Lookup references in ListAccessoryTypes.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

assortmentSeedstringrequired

Accepts a comma separated string of Assortment internal ids. Lookup references in ListAssortments.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

sizestring

Number of items to display.

cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

asVariantsstring

Specifies if the output should be grouped as products or as variants. Default is false which returns a list of products. Set to true if variants are wanted.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListProductAccessories2?accessoryType=0&assortmentSeed=string&productId=0&statusSeed=string'

Responses

Success

Body
ItemCountinteger(int32)

Counts the number of products in the list. If the list is fetched with AsVariants set to true ItemCount will still just count the number of products. Not items in the list. When fetched with a method that has filters, this value will be to total after the filters have been applied.

ItemsArray of objects(ProductItem)(ProductItem)
Response
{
  "ItemCount": 0,
  "Items": [
    { … }
  ]
}

List product accessories (v3) [Obsolete("Use ListProductRelations")]

Request

Accessories connected to a product. Accessories is defined as products that customer could choose to buy in addition to the current product.

Query
productIdinteger(int32)required

ID of current Product.

accessoryTypeSeedstringrequired

Accepts a comma separated string of Type IDs. Lookup references in ListAccessoryTypes. If empty or null, the standard type will be used.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

assortmentSeedstringrequired

Accepts a comma separated string of Assortment internal ids. Lookup references in ListAssortments.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

sizestring

Number of items to display.

cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

asVariantsstring

Specifies if the output should be grouped as products or as variants. Default is false which returns a list of products. Set to true if variants are wanted.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListProductAccessories3?accessoryTypeSeed=string&assortmentSeed=string&productId=0&statusSeed=string'

Responses

Success

Body
ItemCountinteger(int32)

Counts the number of products in the list. If the list is fetched with AsVariants set to true ItemCount will still just count the number of products. Not items in the list. When fetched with a method that has filters, this value will be to total after the filters have been applied.

ItemsArray of objects(ProductItem)(ProductItem)
Response
{
  "ItemCount": 0,
  "Items": [
    { … }
  ]
}

List product accessories (v4) [Obsolete("Use ListProductRelations")]

Request

Accessories connected to a product. Accessories is defined as products that customer could choose to buy in addition to the current product. Supports relations like product to product, product to variant, variant to product and variant to variant.

Query
productIdinteger(int32)required

ID of current Product.

accessoryTypeSeedstringrequired

Accepts a comma separated string of Type IDs. Lookup references in ListAccessoryTypes. If empty or null, the standard type will be used.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

assortmentSeedstringrequired

Accepts a comma separated string of Assortment internal ids. Lookup references in ListAssortments.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

sizestring

Number of items to display.

cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

asVariantsstring

Specifies if the output should be grouped as products or as variants. Default is false which returns a list of products. Set to true if variants are wanted.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListProductAccessories4?accessoryTypeSeed=string&assortmentSeed=string&productId=0&statusSeed=string'

Responses

Success

Body
Accessoriesobject(ProductItemPagedList)(ProductItemPagedList)
VariantAccessoriesArray of objects(VariantAccessories)(VariantAccessories)

This is a list of VariantAccessories.

Response
{
  "Accessories": {
    "ItemCount": 0,
    "Items": [ … ]
  },
  "VariantAccessories": [
    { … }
  ]
}

List product accessories (v5) [Obsolete("Use ListProductRelations")]

Request

Accessories connected to a product. Accessories is defined as products that customer could choose to buy in addition to the current product. Supports relations like product to product, product to variant, variant to product and variant to variant.

Query
productIdinteger(int32)required

ID of current Product.

accessoryTypeSeedstringrequired

Accepts a comma separated string of Type IDs. Lookup references in ListAccessoryTypes. If empty or null, the standard type will be used.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

assortmentSeedstringrequired

Accepts a comma separated string of Assortment internal ids. Lookup references in ListAssortments.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

sizestring

Number of items to display.

cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

asVariantsstring

Specifies if the output should be grouped as products or as variants. Default is false which returns a list of products. Set to true if variants are wanted.

isForAllVariantsstring

Specifies if the result should include all variants or just the one specified as productId. Default is true.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListProductAccessories5?accessoryTypeSeed=string&assortmentSeed=string&productId=0&statusSeed=string'

Responses

Success

Body
Accessoriesobject(ProductItemPagedList)(ProductItemPagedList)
VariantAccessoriesArray of objects(VariantAccessories)(VariantAccessories)

This is a list of VariantAccessories.

Response
{
  "Accessories": {
    "ItemCount": 0,
    "Items": [ … ]
  },
  "VariantAccessories": [
    { … }
  ]
}

List product cross sell [Obsolete("Use ListProductRelations")]

Request

Cross sell connected to a product. Cross sell is defined as products of equal value that customer could choose to buy instead of the current product.

Query
productIdinteger(int32)required

Internal id of current Product.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

assortmentSeedstringrequired

Accepts a comma separated string of Assortment internal ids. Lookup references in ListAssortments.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

sizestring

Number of items to display.

cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListProductCrossSell?assortmentSeed=string&productId=0&statusSeed=string'

Responses

Success

Body
ItemCountinteger(int32)

Counts the number of products in the list. If the list is fetched with AsVariants set to true ItemCount will still just count the number of products. Not items in the list. When fetched with a method that has filters, this value will be to total after the filters have been applied.

ItemsArray of objects(ProductItem)(ProductItem)
Response
{
  "ItemCount": 0,
  "Items": [
    { … }
  ]
}

List product cross sell (v2) [Obsolete("Use ListProductRelations")]

Request

Cross sell connected to a product. Cross sell is defined as products of equal value that customer could choose to buy instead of the current product.

Query
productIdinteger(int32)required

Internal id of current Product.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

assortmentSeedstringrequired

Accepts a comma separated string of Assortment internal ids. Lookup references in ListAssortments.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

sizestring

Number of items to display.

cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

asVariantsstring

Specifies if the output should be grouped as products or as variants. Default is false which returns a list of products. Set to true if variants are wanted.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListProductCrossSell2?assortmentSeed=string&productId=0&statusSeed=string'

Responses

Success

Body
ItemCountinteger(int32)

Counts the number of products in the list. If the list is fetched with AsVariants set to true ItemCount will still just count the number of products. Not items in the list. When fetched with a method that has filters, this value will be to total after the filters have been applied.

ItemsArray of objects(ProductItem)(ProductItem)
Response
{
  "ItemCount": 0,
  "Items": [
    { … }
  ]
}

List product cross sell (v3) [Obsolete("Use ListProducRelations")]

Request

CrossSell connected to a product. CrossSell is defined as products that customer could choose to buy in addition to the current product. Supports relations like product to product, product to variant, variant to product and variant to variant.

Query
productIdinteger(int32)required

Internal id of current Product.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

assortmentSeedstringrequired

Accepts a comma separated string of Assortment internal ids. Lookup references in ListAssortments.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

sizestring

Number of items to display.

cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

asVariantsstring

Specifies if the output should be grouped as products or as variants. Default is false which returns a list of products. Set to true if variants are wanted.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListProductCrossSell3?assortmentSeed=string&productId=0&statusSeed=string'

Responses

Success

Body
Accessoriesobject(ProductItemPagedList)(ProductItemPagedList)
VariantAccessoriesArray of objects(VariantAccessories)(VariantAccessories)

This is a list of VariantAccessories.

Response
{
  "Accessories": {
    "ItemCount": 0,
    "Items": [ … ]
  },
  "VariantAccessories": [
    { … }
  ]
}

List product cross sell (v4) [Obsolete("Use ListProductRelations")]

Request

CrossSell connected to a product. CrossSell is defined as products that customer could choose to buy in addition to the current product. Supports relations like product to product, product to variant, variant to product and variant to variant.

Query
productIdinteger(int32)required

Internal id of current Product.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

assortmentSeedstringrequired

Accepts a comma separated string of Assortment internal ids. Lookup references in ListAssortments.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

sizestring

Number of items to display.

cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

asVariantsstring

Specifies if the output should be grouped as products or as variants. Default is false which returns a list of products. Set to true if variants are wanted.

isForAllVariantsstring

Specifies if the result should include all variants or just the one specified as productId. Default is true.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListProductCrossSell4?assortmentSeed=string&productId=0&statusSeed=string'

Responses

Success

Body
Accessoriesobject(ProductItemPagedList)(ProductItemPagedList)
VariantAccessoriesArray of objects(VariantAccessories)(VariantAccessories)

This is a list of VariantAccessories.

Response
{
  "Accessories": {
    "ItemCount": 0,
    "Items": [ … ]
  },
  "VariantAccessories": [
    { … }
  ]
}

List product relations

Request

Relations connected to a product. Relations are defined as products that customer could choose to buy in addition to the current product. Supports relations like product to product, product to variant, variant to product and variant to variant.

Query
productIdinteger(int32)required

Internal id of current Product.

relationTypeSeedstringrequired

Accepts a comma separated string of Type IDs. Lookup references in ListProductRelationTypes. If empty or null, all types will be used.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

assortmentSeedstringrequired

Accepts a comma separated string of Assortment internal ids. Lookup references in ListAssortments.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

sizestring

Number of items to display.

cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

asVariantsstring

Specifies if the output should be grouped as products or as variants. Default is false which returns a list of products. Set to true if variants are wanted.

isForAllVariantsstring

Specifies if the result should include all variants or just the one specified as productId. Default is true.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListProductRelations?assortmentSeed=string&productId=0&relationTypeSeed=string&statusSeed=string'

Responses

Success

Body
Array [
Idinteger(int32)

This is the type internal id for the relation type

Codestring

This is the type external code for the relation type

Namestring

This is the name of the relation type

Descriptionstring

This is the description of the relation type

RelationsMetadataArray of objects(RelationMetadataItem)(RelationMetadataItem)

Indicates if the related items are product or variant specific

Relationsobject(ProductItemPagedList)(ProductItemPagedList)
VariantRelationsArray of objects(VariantRelations)(VariantRelations)

This is a list of variant relations.

]
Response
[
  {
    "Id": 0,
    "Code": "string",
    "Name": "string",
    "Description": "string",
    "RelationsMetadata": [ … ],
    "Relations": { … },
    "VariantRelations": [ … ]
  }
]

List product relation types

Request

Reference list of Product Relation types. The ids in the list can be used as accessoryTypeSeed in calls to ListProductAccessories/ListProductRelations.

Query
cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

curl -i -X GET \
  https://demo.storm.io/api/1.1/ProductService.svc/rest/ListProductRelationTypes

Responses

Success

Body
Array [
Idinteger(int32)

The internal Id of the Entity. This Id might be different in different tiers such as Stage and Production. Use Code if hard coding is required.

Valuestring

The Value of the Entity. MaxLength: max.

Codestring

The Code of the Entity, if existing. Use this value when hard coding is required. MaxLength: 255.

]
Response
[
  {
    "Id": 0,
    "Value": "string",
    "Code": "string"
  }
]

List product upsell [Obsolete("Use ListProductRelations")]

Request

Upsell connected to a product. Upsell is defined as more expensive products that customer could choose to buy instead of the current product.

Query
productIdinteger(int32)required

Internal id of current Product.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

assortmentSeedstringrequired

Accepts a comma separated string of Assortment internal ids. Lookup references in ListAssortments.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

sizestring

Number of items to display.

cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListProductUpsell?assortmentSeed=string&productId=0&statusSeed=string'

Responses

Success

Body
ItemCountinteger(int32)

Counts the number of products in the list. If the list is fetched with AsVariants set to true ItemCount will still just count the number of products. Not items in the list. When fetched with a method that has filters, this value will be to total after the filters have been applied.

ItemsArray of objects(ProductItem)(ProductItem)
Response
{
  "ItemCount": 0,
  "Items": [
    { … }
  ]
}

List product upsell (v2) [Obsolete("Use ListProductRelations")]

Request

Upsell connected to a product. Upsell is defined as more expensive products that customer could choose to buy instead of the current product.

Query
productIdinteger(int32)required

Internal id of current Product.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

assortmentSeedstringrequired

Accepts a comma separated string of Assortment internal ids. Lookup references in ListAssortments.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

sizestring

Number of items to display.

cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

asVariantsstring

Specifies if the output should be grouped as products or as variants. Default is false which returns a list of products. Set to true if variants are wanted.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListProductUpsell2?assortmentSeed=string&productId=0&statusSeed=string'

Responses

Success

Body
ItemCountinteger(int32)

Counts the number of products in the list. If the list is fetched with AsVariants set to true ItemCount will still just count the number of products. Not items in the list. When fetched with a method that has filters, this value will be to total after the filters have been applied.

ItemsArray of objects(ProductItem)(ProductItem)
Response
{
  "ItemCount": 0,
  "Items": [
    { … }
  ]
}

List product upsell (v3) [Obsolete("Use ListProductRelations")]

Request

UpSell connected to a product. UpSell is defined as products that customer could choose to buy in addition to the current product. Supports relations like product to product, product to variant, variant to product and variant to variant.

Query
productIdinteger(int32)required

Internal id of current Product.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

assortmentSeedstringrequired

Accepts a comma separated string of Assortment internal ids. Lookup references in ListAssortments.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

sizestring

Number of items to display.

cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

asVariantsstring

Specifies if the output should be grouped as products or as variants. Default is false which returns a list of products. Set to true if variants are wanted.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListProductUpSell3?assortmentSeed=string&productId=0&statusSeed=string'

Responses

Success

Body
Accessoriesobject(ProductItemPagedList)(ProductItemPagedList)
VariantAccessoriesArray of objects(VariantAccessories)(VariantAccessories)

This is a list of VariantAccessories.

Response
{
  "Accessories": {
    "ItemCount": 0,
    "Items": [ … ]
  },
  "VariantAccessories": [
    { … }
  ]
}

List product upsell (v4) [Obsolete("Use ListProductRelations")]

Request

UpSell connected to a product. UpSell is defined as products that customer could choose to buy in addition to the current product. Supports relations like product to product, product to variant, variant to product and variant to variant.

Query
productIdinteger(int32)required

Internal id of current Product.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

assortmentSeedstringrequired

Accepts a comma separated string of Assortment internal ids. Lookup references in ListAssortments.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

sizestring

Number of items to display.

cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

asVariantsstring

Specifies if the output should be grouped as products or as variants. Default is false which returns a list of products. Set to true if variants are wanted.

isForAllVariantsstring

Specifies if the result should include all variants or just the one specified as productId. Default is true.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListProductUpSell4?assortmentSeed=string&productId=0&statusSeed=string'

Responses

Success

Body
Accessoriesobject(ProductItemPagedList)(ProductItemPagedList)
VariantAccessoriesArray of objects(VariantAccessories)(VariantAccessories)

This is a list of VariantAccessories.

Response
{
  "Accessories": {
    "ItemCount": 0,
    "Items": [ … ]
  },
  "VariantAccessories": [
    { … }
  ]
}

Reviews

Operations

SkuTypes

Operations

Status

Operations

Variants

Operations

Warehouses

Operations