STORM API
/
Shopping Service
/
Promotions

Documentation ShoppingService (1.1)

Entities and methods to handle baskets and payments.

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

Basket

Operations

Checkout

Operations

DeliveryMethods

Operations

InfoTypes

Operations

OnHand

Operations

OrderRequest

Operations

Payments

Operations

Promotions

Operations

Get a promotion

Request

Gets a promotion.

Query
idinteger(int32)

Internal id of promotion

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/ShoppingService.svc/rest/GetPromotion

Responses

Success

Body
Idinteger or null(int32)

The internal id of the Promotion.

Namestring

The Name of the Promotion. MaxLength: 255.

Headerstring

SubHeader from Storm. MaxLength: 255.

ShortDescriptionstring

DescriptionHeader from Storm. MaxLength: 255.

Description1string

Description from Storm. MaxLength: max.

Description2string

SubDescription from Storm. MaxLength: max.

StartDatestring or null(date-time)

The StartDate of the Promotion, if any. Only valid promotions will be returned.

EndDatestring or null(date-time)

The EndDate of the Promotion, if any. Only valid promotions will be returned.

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.

RequirementSeedstring

A comma separated list of fulfilled requirements for this promotion. MaxLength: max.

DiscountCodestring

Will contain the discountCode if the promotion has a discountCode requirement. MaxLength: max.

IsExcludedFromPriceCalculationboolean

A value of true means the promotion was applied last an not included in any price calculations.

AllowProductListingboolean

This flag can be checked to see whether the promotion allows listing of products from requirements. Use Products.ListProductsByPromotionRequirement to list products. Note that if this property is true and no product requirements exists, no products will be listed.

ImagesArray of objects(File)(File)

A list of additional images files uploaded for the promotion. Images can be differentiated by using different types. See ListPromotionImageTypes for available types.

ProductFiltersArray of objects(PromotionProductFilter)(PromotionProductFilter)

A list of productFilters for the promotion. Can be used to filter or fetch promotions matched by Products. match the products properties against the filter values Each ProductFilter must match all existing values and if any ProductFilter matches the promotion will be valid for that product.

AppliedAmountnumber or null(decimal)

Applied discount amount, excluding VAT, if fetched on AppliedPromotions property on the basket. In that case it will be the sum of all applied amounts on all Basket.Items. This value is rounded to two decimals.

EffectSeedstring

A comma separated list of applicable effects for this promotion. MaxLength: max.

FreightDiscountPctnumber or null(decimal)

FreightDiscountPct can be used to calculate external freight prices. The value is given as percentage as 100.00 for 100% discount. Only used for FreightDiscounts.

IsStackableboolean

Promotion effect quantity or basket discount is multiplied with how many times requirement is fulfilled.

AppliedAmountIncVatnumber or null(decimal)

Applied discount amount, including VAT, for this Promotion on this BasketItem.

ExclusivityTypeinteger(int32)

ExclusivityType allows setting promotions as NotExclusive = 0, Exclusive = 1, or IgnoreExclusivity = 2.

Response
{
  "Id": 0,
  "Name": "string",
  "Header": "string",
  "ShortDescription": "string",
  "Description1": "string",
  "Description2": "string",
  "StartDate": "2019-08-24T14:15:22Z",
  "EndDate": "2019-08-24T14:15:22Z",
  "ImageKey": "string",
  "RequirementSeed": "string",
  "DiscountCode": "string",
  "IsExcludedFromPriceCalculation": true,
  "AllowProductListing": true,
  "Images": [
    { … }
  ],
  "ProductFilters": [
    { … }
  ],
  "AppliedAmount": 0,
  "EffectSeed": "string",
  "FreightDiscountPct": 0,
  "IsStackable": true,
  "AppliedAmountIncVat": 0,
  "ExclusivityType": 0
}

List promotion image types

Request

Lists the ids for all supported promotion image 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/ShoppingService.svc/rest/ListPromotionImageTypes

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 promotion requirement types

Request

Lists the ids for all supported promotion requirement 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/ShoppingService.svc/rest/ListPromotionRequirementTypes

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 active promotions

Request

Lists active promotions.

Query
excludeRequirementSeedstring

Specifies a comma separated list of requirements. If none is supplied, all promotions will be returned. Otherwise promotions will be filtered on those not having any of the requirements.

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/ShoppingService.svc/rest/ListPromotions

Responses

Success

Body
Array [
Idinteger or null(int32)

The internal id of the Promotion.

Namestring

The Name of the Promotion. MaxLength: 255.

Headerstring

SubHeader from Storm. MaxLength: 255.

ShortDescriptionstring

DescriptionHeader from Storm. MaxLength: 255.

Description1string

Description from Storm. MaxLength: max.

Description2string

SubDescription from Storm. MaxLength: max.

StartDatestring or null(date-time)

The StartDate of the Promotion, if any. Only valid promotions will be returned.

EndDatestring or null(date-time)

The EndDate of the Promotion, if any. Only valid promotions will be returned.

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.

RequirementSeedstring

A comma separated list of fulfilled requirements for this promotion. MaxLength: max.

DiscountCodestring

Will contain the discountCode if the promotion has a discountCode requirement. MaxLength: max.

IsExcludedFromPriceCalculationboolean

A value of true means the promotion was applied last an not included in any price calculations.

AllowProductListingboolean

This flag can be checked to see whether the promotion allows listing of products from requirements. Use Products.ListProductsByPromotionRequirement to list products. Note that if this property is true and no product requirements exists, no products will be listed.

ImagesArray of objects(File)(File)

A list of additional images files uploaded for the promotion. Images can be differentiated by using different types. See ListPromotionImageTypes for available types.

ProductFiltersArray of objects(PromotionProductFilter)(PromotionProductFilter)

A list of productFilters for the promotion. Can be used to filter or fetch promotions matched by Products. match the products properties against the filter values Each ProductFilter must match all existing values and if any ProductFilter matches the promotion will be valid for that product.

AppliedAmountnumber or null(decimal)

Applied discount amount, excluding VAT, if fetched on AppliedPromotions property on the basket. In that case it will be the sum of all applied amounts on all Basket.Items. This value is rounded to two decimals.

EffectSeedstring

A comma separated list of applicable effects for this promotion. MaxLength: max.

FreightDiscountPctnumber or null(decimal)

FreightDiscountPct can be used to calculate external freight prices. The value is given as percentage as 100.00 for 100% discount. Only used for FreightDiscounts.

IsStackableboolean

Promotion effect quantity or basket discount is multiplied with how many times requirement is fulfilled.

AppliedAmountIncVatnumber or null(decimal)

Applied discount amount, including VAT, for this Promotion on this BasketItem.

ExclusivityTypeinteger(int32)

ExclusivityType allows setting promotions as NotExclusive = 0, Exclusive = 1, or IgnoreExclusivity = 2.

]
Response
[
  {
    "Id": 0,
    "Name": "string",
    "Header": "string",
    "ShortDescription": "string",
    "Description1": "string",
    "Description2": "string",
    "StartDate": "2019-08-24T14:15:22Z",
    "EndDate": "2019-08-24T14:15:22Z",
    "ImageKey": "string",
    "RequirementSeed": "string",
    "DiscountCode": "string",
    "IsExcludedFromPriceCalculation": true,
    "AllowProductListing": true,
    "Images": [ … ],
    "ProductFilters": [ … ],
    "AppliedAmount": 0,
    "EffectSeed": "string",
    "FreightDiscountPct": 0,
    "IsStackable": true,
    "AppliedAmountIncVat": 0,
    "ExclusivityType": 0
  }
]

List promotions by basket

Request

Lists all promotions where any BasketItem is either in a requirement or in an effect for the promotion. Fulfilled promotions are excluded from the result. Promotions based on discount codes, customer or company are also excluded. This can be used to display promotions not yet fulfilled in a Checkout.

Query
basketIdinteger(int32)required

The internal basket id.

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/ShoppingService.svc/rest/ListPromotionsByBasket?basketId=0'

Responses

Success

Body
Array [
Idinteger or null(int32)

The internal id of the Promotion.

Namestring

The Name of the Promotion. MaxLength: 255.

Headerstring

SubHeader from Storm. MaxLength: 255.

ShortDescriptionstring

DescriptionHeader from Storm. MaxLength: 255.

Description1string

Description from Storm. MaxLength: max.

Description2string

SubDescription from Storm. MaxLength: max.

StartDatestring or null(date-time)

The StartDate of the Promotion, if any. Only valid promotions will be returned.

EndDatestring or null(date-time)

The EndDate of the Promotion, if any. Only valid promotions will be returned.

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.

RequirementSeedstring

A comma separated list of fulfilled requirements for this promotion. MaxLength: max.

DiscountCodestring

Will contain the discountCode if the promotion has a discountCode requirement. MaxLength: max.

IsExcludedFromPriceCalculationboolean

A value of true means the promotion was applied last an not included in any price calculations.

AllowProductListingboolean

This flag can be checked to see whether the promotion allows listing of products from requirements. Use Products.ListProductsByPromotionRequirement to list products. Note that if this property is true and no product requirements exists, no products will be listed.

ImagesArray of objects(File)(File)

A list of additional images files uploaded for the promotion. Images can be differentiated by using different types. See ListPromotionImageTypes for available types.

ProductFiltersArray of objects(PromotionProductFilter)(PromotionProductFilter)

A list of productFilters for the promotion. Can be used to filter or fetch promotions matched by Products. match the products properties against the filter values Each ProductFilter must match all existing values and if any ProductFilter matches the promotion will be valid for that product.

AppliedAmountnumber or null(decimal)

Applied discount amount, excluding VAT, if fetched on AppliedPromotions property on the basket. In that case it will be the sum of all applied amounts on all Basket.Items. This value is rounded to two decimals.

EffectSeedstring

A comma separated list of applicable effects for this promotion. MaxLength: max.

FreightDiscountPctnumber or null(decimal)

FreightDiscountPct can be used to calculate external freight prices. The value is given as percentage as 100.00 for 100% discount. Only used for FreightDiscounts.

IsStackableboolean

Promotion effect quantity or basket discount is multiplied with how many times requirement is fulfilled.

AppliedAmountIncVatnumber or null(decimal)

Applied discount amount, including VAT, for this Promotion on this BasketItem.

ExclusivityTypeinteger(int32)

ExclusivityType allows setting promotions as NotExclusive = 0, Exclusive = 1, or IgnoreExclusivity = 2.

]
Response
[
  {
    "Id": 0,
    "Name": "string",
    "Header": "string",
    "ShortDescription": "string",
    "Description1": "string",
    "Description2": "string",
    "StartDate": "2019-08-24T14:15:22Z",
    "EndDate": "2019-08-24T14:15:22Z",
    "ImageKey": "string",
    "RequirementSeed": "string",
    "DiscountCode": "string",
    "IsExcludedFromPriceCalculation": true,
    "AllowProductListing": true,
    "Images": [ … ],
    "ProductFilters": [ … ],
    "AppliedAmount": 0,
    "EffectSeed": "string",
    "FreightDiscountPct": 0,
    "IsStackable": true,
    "AppliedAmountIncVat": 0,
    "ExclusivityType": 0
  }
]

Subscriptions

Operations