STORM API

Product Service

Documentation ProductService (1.1)

Download OpenAPI description

openapi.json

openapi.yaml

Servers

https://demo.storm.io/api/1.1/

Assortments

Operations

Configurations

Operations

Families

Operations

Files

Operations

Filters

Operations

Flags

Operations

InfoTypes

Operations

Manufacturers

Operations

Get a manufacturer

Request

Get a specific manufacturer by internal id.

Query

idinteger(int32)required

Internal id for manufacturer.

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/GetManufacturer?id=0'

Responses

Success

Body

Idinteger(int32)

The internal Id of the Manufacturer.

Namestring

The Name of the Manufacturer. MaxLength: 100.

OrgNostring

The organizational number of the Manufacturer. MaxLength: 50.

WebSitestring

The url to the Manufacturer's web site. MaxLength: 255.

LogoPathstring

MaxLength: 255. Obsolete! - Use LogoKey

SupportUrlstring

The url to the Manufacturer's support page on their web site. MaxLength: 255.

SupportEmailstring

The email address to the Manufacturer's support. MaxLength: 255.

SupportPhonestring

The phone number to the Manufacturer's support. MaxLength: 500.

SupportOpenHoursstring

The opening hours for the Manufacturer's support. MaxLength: max.

SupportPolicystring

The url to the Manufacturer's support policy web page. MaxLength: max.

SupportDescriptionstring

The url to the Manufacturer's support description web page. MaxLength: max.

Keystring(guid)

The system wide unique Key of the Manufacturer.

LogoKeystring or null(guid)

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

UniqueNamestring

A unique name that can be used in Urls and to get this entity. GetManufacturer and GetManufacturerByUniqueName gets the same Manufacturer. MaxLength: 255.

Response

{
  "Id": 0,
  "Name": "string",
  "OrgNo": "string",
  "WebSite": "string",
  "LogoPath": "string",
  "SupportUrl": "string",
  "SupportEmail": "string",
  "SupportPhone": "string",
  "SupportOpenHours": "string",
  "SupportPolicy": "string",
  "SupportDescription": "string",
  "Key": "string",
  "LogoKey": "string",
  "UniqueName": "string"
}

Get a manufacturer by unique name

Request

Get a specific manufacturer by unique name.

Query

uniqueNamestringrequired

Unique name for the manufacturer.

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/GetManufacturerByUniqueName?uniqueName=string'

Responses

Success

Body

Idinteger(int32)

The internal Id of the Manufacturer.

Namestring

The Name of the Manufacturer. MaxLength: 100.

OrgNostring

The organizational number of the Manufacturer. MaxLength: 50.

WebSitestring

The url to the Manufacturer's web site. MaxLength: 255.

LogoPathstring

MaxLength: 255. Obsolete! - Use LogoKey

SupportUrlstring

The url to the Manufacturer's support page on their web site. MaxLength: 255.

SupportEmailstring

The email address to the Manufacturer's support. MaxLength: 255.

SupportPhonestring

The phone number to the Manufacturer's support. MaxLength: 500.

SupportOpenHoursstring

The opening hours for the Manufacturer's support. MaxLength: max.

SupportPolicystring

The url to the Manufacturer's support policy web page. MaxLength: max.

SupportDescriptionstring

The url to the Manufacturer's support description web page. MaxLength: max.

Keystring(guid)

The system wide unique Key of the Manufacturer.

LogoKeystring or null(guid)

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

UniqueNamestring

A unique name that can be used in Urls and to get this entity. GetManufacturer and GetManufacturerByUniqueName gets the same Manufacturer. MaxLength: 255.

Response

{
  "Id": 0,
  "Name": "string",
  "OrgNo": "string",
  "WebSite": "string",
  "LogoPath": "string",
  "SupportUrl": "string",
  "SupportEmail": "string",
  "SupportPhone": "string",
  "SupportOpenHours": "string",
  "SupportPolicy": "string",
  "SupportDescription": "string",
  "Key": "string",
  "LogoKey": "string",
  "UniqueName": "string"
}

List manufacturers

Request

Main manufacturer list. This function will not calculate ProductCount. Use ListManufacturersEx for that.

Query

searchStringstring

Free text search string.

pageNostring

Page numbers start with 1. Default is 1. If you specify a pageNo outside the range of items, an empty list will be returned. PageSize is mandatory for pageNo to work.

pageSizestring

Number of items to display per page. Mandatory if using pageNo.

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

Responses

Success

Body

ItemCountinteger(int32)

The total item count. Can be used to manage paging. Use PageSize to calculate number of pages.

ItemsArray of objects(ManufacturerItem)(ManufacturerItem)

Current list of ManufacturerItems for the current page if paging is used. Otherwise all items will be in the list.

Response

{
  "ItemCount": 0,
  "Items": [
    { … }
  ]
}

List manufacturers (extended)

Request

Main product list. Same as ListManufacturers but this one will calculate ProductCount.

Query

searchStringstring

Free text search string on manufacturer.

statusSeedstringrequired

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

assortmentSeedstringrequired

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

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.

pageNostring

Page numbers start with 1. Default is 1. If you specify a pageNo outside the range of items, an empty list will be returned. PageSize is mandatory for pageNo to work.

pageSizestring

Number of items to display per page. Mandatory if using pageNo.

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

Responses

Success

Body

ItemCountinteger(int32)

The total item count. Can be used to manage paging. Use PageSize to calculate number of pages.

ItemsArray of objects(ManufacturerItem)(ManufacturerItem)

Current list of ManufacturerItems for the current page if paging is used. Otherwise all items will be in the list.

Response

{
  "ItemCount": 0,
  "Items": [
    { … }
  ]
}

Search manufacturers

Request

Query

searchStringstringrequired

The string to search for. Searchable fields are manufacturerCode, orgNo, name and prefix.

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/SearchManufacturers?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"
  }
]

OnHand

Operations

Parametric

Operations

PriceLists

Operations

Products

Operations

Promotions

Operations

Relations

Operations

Reviews

Operations

SkuTypes

Operations

Status

Operations

Variants

Operations

Warehouses

Operations

Documentation ProductService (1.1)

Assortments

Categories

Configurations

Families

Files

Filters

Flags

InfoTypes

Manufacturers

Get a manufacturer

Request

Responses

Did the information on the page help you?

Get a manufacturer by unique name

Request

Responses

Did the information on the page help you?

List manufacturers

Request

Responses

Did the information on the page help you?

List manufacturers (extended)

Request

Responses

Did the information on the page help you?

Search manufacturers

Request

Responses

Did the information on the page help you?

Navigation

OnHand

Parametric

PriceLists

Products

Promotions

Relations

Reviews

SkuTypes

Status

Variants

Warehouses