STORM API
/
Product Service
/
Navigation

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

Get navigation structure

Request

Gets the NavigationStructure for the Application. The NavigationStructure is used to get the list of NavigationNodes. See IProductService.ListNavigationNodes for more information.

Query
idstring

Specifies id for the navigation structure. If none is supplied, the default structure for the Application is returned.

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/GetNavigationStructure

Responses

Success

Body
Idinteger(int32)

The internal Id is used to get the NavigationNodeList for this structure.

Namestring

The Name of the NavigationStructure. MaxLength: 50.

Descriptionstring

The Description of the NavigationStructure. MaxLength: 500.

IsDefaultboolean

Indicates if the NavigationStructure is a default structure or not.

Response
{
  "Id": 0,
  "Name": "string",
  "Description": "string",
  "IsDefault": true
}

List navigation nodes

Request

Lists the NavigationNodes for the NavigationStructure. See NavigationNode for more information.

Query
navigationIdinteger(int32)required

Specifies id for the navigation structure.

descendantOfstring

Specifies the parent hierarchy for the NavigationNodes to list. If none is supplied all nodes will be listed. Sample: /1/

maxRecursionsstring

Specifies the number of levels deep to go. If none is supplied all nodes will be listed.

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/ListNavigationNodes?navigationId=0'

Responses

Success

Body
Array [
Keystring(guid)

Key is unique for the NavigationNode and used when listing the content displayed for the node.

Hierarchystring

Hierarchy represents the current navigation path within the NavigationNode structure. Hierarchy is used to get the sub nodes for current node. MaxLength: 4000.

TypeIdinteger(int32)

TypeId defines the content type of the NavigationNode.

Namestring

The display name of the NavigationNode. MaxLength: 50.

TargetPathstring

The target path, if any, for the NavigationNode. This can be a direct link to any page that defines the content for the node. Depending on TypeId. MaxLength: 500.

ManufacturerSeedstring

The manufacturer seed, if any, for the NavigationNode. MaxLength: 255.

CategorySeedstring

The category seed, if any, for the NavigationNode. MaxLength: 255.

FlagIdSeedstring

A comma separated list of flag internal ids, if any, for the NavigationNode. MaxLength: 255.

ImageKeystring or null(guid)

The image key for the first underlying category, if any. Url for images are formed like http://[client specific CDN]/{ImageKey}. Preset, height and width can be sent as parameters.

Descriptionstring

The description for the first underlying category, if any. MaxLength: max.

ProductCountinteger or null(int32)

A count of existing products under this node. It will have a value if fetched from an operation which calculates the value, null otherwise.

]
Response
[
  {
    "Key": "string",
    "Hierarchy": "string",
    "TypeId": 0,
    "Name": "string",
    "TargetPath": "string",
    "ManufacturerSeed": "string",
    "CategorySeed": "string",
    "FlagIdSeed": "string",
    "ImageKey": "string",
    "Description": "string",
    "ProductCount": 0
  }
]

List navigation nodes (extended)

Request

Lists the NavigationNodes. Same as ListNavigationNodes but this one will calculate ProductCount.

Query
navigationIdinteger(int32)required

Specifies id for the navigation structure.

descendantOfstring

Specifies the parent hierarchy for the NavigationNodes to list. If none is supplied all nodes will be listed. Sample: /1/

maxRecursionsstring

Specifies the number of levels deep to go. If none is supplied all nodes will be listed.

hideEmptyNodesstring

If set to true only nodes with underlying products will be fetched. If false, all nodes will be fetched. Default value is false.

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.

asVariantsstring

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

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/ListNavigationNodesEx?assortmentSeed=string&navigationId=0&statusSeed=string'

Responses

Success

Body
Array [
Keystring(guid)

Key is unique for the NavigationNode and used when listing the content displayed for the node.

Hierarchystring

Hierarchy represents the current navigation path within the NavigationNode structure. Hierarchy is used to get the sub nodes for current node. MaxLength: 4000.

TypeIdinteger(int32)

TypeId defines the content type of the NavigationNode.

Namestring

The display name of the NavigationNode. MaxLength: 50.

TargetPathstring

The target path, if any, for the NavigationNode. This can be a direct link to any page that defines the content for the node. Depending on TypeId. MaxLength: 500.

ManufacturerSeedstring

The manufacturer seed, if any, for the NavigationNode. MaxLength: 255.

CategorySeedstring

The category seed, if any, for the NavigationNode. MaxLength: 255.

FlagIdSeedstring

A comma separated list of flag internal ids, if any, for the NavigationNode. MaxLength: 255.

ImageKeystring or null(guid)

The image key for the first underlying category, if any. Url for images are formed like http://[client specific CDN]/{ImageKey}. Preset, height and width can be sent as parameters.

Descriptionstring

The description for the first underlying category, if any. MaxLength: max.

ProductCountinteger or null(int32)

A count of existing products under this node. It will have a value if fetched from an operation which calculates the value, null otherwise.

]
Response
[
  {
    "Key": "string",
    "Hierarchy": "string",
    "TypeId": 0,
    "Name": "string",
    "TargetPath": "string",
    "ManufacturerSeed": "string",
    "CategorySeed": "string",
    "FlagIdSeed": "string",
    "ImageKey": "string",
    "Description": "string",
    "ProductCount": 0
  }
]

List navigation node types

Request

Lists the available NavigationNode.TypeIds.

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/ListNavigationNodeTypeIds

Responses

Success

Body
Array [
Idinteger(int32)

The internal Id of the Entity.

Namestring

The Name of the Entity. MaxLength: 50.

Descriptionstring

The Description of the Entity. MaxLength: 500.

ImageKeystring or null(guid)

A unique id for the image at our image server. Url for images are formed like http://[client specific CDN]/{ImageKey}. Preset, height and width can be sent as parameters.

Codestring

The Code of the Entity. MaxLength: 50.

]
Response
[
  {
    "Id": 0,
    "Name": "string",
    "Description": "string",
    "ImageKey": "string",
    "Code": "string"
  }
]

OnHand

Operations

Parametric

Operations

PriceLists

Operations

Products

Operations

Promotions

Operations

Relations

Operations

Reviews

Operations

SkuTypes

Operations

Status

Operations

Variants

Operations

Warehouses

Operations