STORM API
/
Product Service
/
Categories

Documentation ProductService (1.1)

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

Assortments

Operations

Categories

Operations

List categories (abbreviated)

Request

Lists categories as defined in Storm. Used for lookup.

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

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 categories

Request

Navigational structure.

Query
categoryStructureIdstring

Specifies which category structure to use. If none is supplied, value is resolved from Application.

levelstring

If supplied, only returns structure nodes of specified level.

parentIdstring

If supplied, only returns child nodes of specified parent node.

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

Responses

Success

Body
Array [
Idinteger(int32)

The internal Id of the Category structure item.

ParentIdinteger or null(int32)

The internal Id of the parent Category structure item.

CategoryIdinteger(int32)

The internal Id of the actual Category.

Namestring

The Name of the actual Category if the specified so, otherwise it is the Name of the Category structure. MaxLength: 50.

Descriptionstring

The Description of the Category. MaxLength: max.

ImagePathstring

MaxLength: 500. Obsolete! - Use ImageKey

Levelinteger(int32)

The Level of the CategoryItem from the Category structure.

IsDisplayOnlyboolean

Indicates if the CategoryItem is just for display or not.

Keystring(guid)

The Key of the Category structure item.

ChildrenArray of objects(CategoryItem)(CategoryItem)

A list of children for the Category structure item.

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

External code for mapping to the Client's id of this entity. MaxLength: 50.

Synonymsstring

Synonyms from the Category in Storm. Can be used when indexing the category in any search engine. MaxLength: 500.

ParametricsArray of objects(CategoryParametric)(CategoryParametric)

Parametrics is a list of parameterics defined for the category.

]
Response
[
  {
    "Id": 0,
    "ParentId": 0,
    "CategoryId": 0,
    "Name": "string",
    "Description": "string",
    "ImagePath": "string",
    "Level": 0,
    "IsDisplayOnly": true,
    "Key": "string",
    "Children": [ … ],
    "ImageKey": "string",
    "Code": "string",
    "Synonyms": "string",
    "Parametrics": [ … ]
  }
]

List categories by pricelists

Request

Lists categories as defined by the products on the priceLists in Storm.

Query
pricelistSeedstringrequired

Accepts a comma separated string of pricelist internal ids.

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.

categoryStructureIdstring

Specifies which category structure to use. If none is supplied, value is resolved from Application.

levelstring

If supplied, only returns structure nodes of specified level.

parentIdstring

If supplied, only returns child nodes of specified parent node.

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/ListCategoryItemsByPricelists?assortmentSeed=string&pricelistSeed=string&statusSeed=string'

Responses

Success

Body
Array [
Idinteger(int32)

The internal Id of the Category structure item.

ParentIdinteger or null(int32)

The internal Id of the parent Category structure item.

CategoryIdinteger(int32)

The internal Id of the actual Category.

Namestring

The Name of the actual Category if the specified so, otherwise it is the Name of the Category structure. MaxLength: 50.

Descriptionstring

The Description of the Category. MaxLength: max.

ImagePathstring

MaxLength: 500. Obsolete! - Use ImageKey

Levelinteger(int32)

The Level of the CategoryItem from the Category structure.

IsDisplayOnlyboolean

Indicates if the CategoryItem is just for display or not.

Keystring(guid)

The Key of the Category structure item.

ChildrenArray of objects(CategoryItem)(CategoryItem)

A list of children for the Category structure item.

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

External code for mapping to the Client's id of this entity. MaxLength: 50.

Synonymsstring

Synonyms from the Category in Storm. Can be used when indexing the category in any search engine. MaxLength: 500.

ParametricsArray of objects(CategoryParametric)(CategoryParametric)

Parametrics is a list of parameterics defined for the category.

]
Response
[
  {
    "Id": 0,
    "ParentId": 0,
    "CategoryId": 0,
    "Name": "string",
    "Description": "string",
    "ImagePath": "string",
    "Level": 0,
    "IsDisplayOnly": true,
    "Key": "string",
    "Children": [ … ],
    "ImageKey": "string",
    "Code": "string",
    "Synonyms": "string",
    "Parametrics": [ … ]
  }
]

Search categories

Request

Query
searchStringstringrequired

The string to search for. Searchable fields are code, name, synonyms and unspsc code.

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.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/SearchCategories?searchString=string'

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"
  }
]

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

Reviews

Operations

SkuTypes

Operations

Status

Operations

Variants

Operations

Warehouses

Operations