COMMERCE SERVICES
/
Shopping Service
/
Promotions
/
Get a promotion

Norce Commerce Shopping v1.1 service (1.1)

Entities and methods to handle baskets and payments. The Shopping service is used to create and manage baskets, and prepare them for the checkout process. Commonly the checkout process is handled by the Norce Checkout API, only the legacy checkout process is handled here. For product or pricing data, use the Product service. For order history, use the Order service. To change or manage promotions use the Management API.

Download OpenAPI description
openapi-v1.json
openapi-v1.yaml
Languages
Servers
Playground

https://{slug}.api-se.playground.norce.tech/commerce/

Stage

https://{slug}.api-se.stage.norce.tech/commerce/

Production

https://{slug}.api-se.norce.tech/commerce/

Basket

Contains endpoints for manage baskets and their lifecycle, see more information here.

Operations

Checkout

Contains endpoints for initialized the checkout process, read more about it here. There is also the old legacy purchase endpoints, still used by older solutions and Non-PSP purchases.

Operations

DeliveryMethods

Contains endpoints for viewing metadata about configured delivery methods, when using Norces internal shipping logic.

Operations

InfoTypes

Contains endpoints for viewing metadata for extended fields on the basket and basketitems.

Operations

OnHand

Contains endpoints for looking up availability on baskets.

Operations

OrderRequest

Contains endpoints for viewing orders snapshots.

Operations

Payments

Contains endpoints for legacy purchases, still used by older solutions and Non-PSP purchases.

Operations

Promotions

Contains endpoints for viewing more promotion information.

Operations

List promotion requirement types

Request

Lists the ids for all supported promotion requirement types.

Query
cultureCodestring

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

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/shopping/1.1/ListPromotionRequirementTypes \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/jsonArray [
Idinteger or null(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 or null

The Value of the Entity.

Codestring or null

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

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

List promotion image types

Request

Lists the ids for all supported promotion image types.

Query
cultureCodestring

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

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/shopping/1.1/ListPromotionImageTypes \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/jsonArray [
Idinteger or null(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 or null

The Value of the Entity.

Codestring or null

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

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

Get a promotion

Request

Gets a promotion.

Query
idinteger(int32)

(Optional) Internal id of promotion

cultureCodestring

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

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/shopping/1.1/GetPromotion \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
Idinteger or null(int32)

The internal id of the Promotion.

Namestring or null[ 0 .. 255 ] characters

The Name of the Promotion. MaxLength: 255

Headerstring or null[ 0 .. 255 ] characters

SubHeader from Norce. MaxLength: 255

ShortDescriptionstring or null[ 0 .. 255 ] characters

DescriptionHeader from Norce. MaxLength: 255

Description1string or null

Description from Norce.

Description2string or null

SubDescription from Norce.

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(uuid)

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 or null

A comma separated list of fulfilled requirements for this promotion.

DiscountCodestring or null

Will contain the discountCode if the promotion has a discountCode requirement.

IsExcludedFromPriceCalculationboolean or null

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

AllowProductListingboolean or null

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 or null(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 or null(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 or null

A comma separated list of applicable effects for this promotion.

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 or null

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 or null(int32)

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

ExternalCodestring or null[ 0 .. 255 ] characters

The external code of the Promotion. This is NOT the discount code. MaxLength: 255

Response
application/json
{
  "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": "9afa8b7e-ca15-438f-a9d6-f679c437e59c",
  "RequirementSeed": "string",
  "DiscountCode": "string",
  "IsExcludedFromPriceCalculation": true,
  "AllowProductListing": true,
  "Images": [
    { … }
  ],
  "ProductFilters": [
    { … }
  ],
  "AppliedAmount": 0,
  "EffectSeed": "string",
  "FreightDiscountPct": 0,
  "IsStackable": true,
  "AppliedAmountIncVat": 0,
  "ExclusivityType": 0,
  "ExternalCode": "string"
}

List active promotions

Request

Lists active promotions.

Query
excludeRequirementSeedstring

(Optional) 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

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

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/shopping/1.1/ListPromotions \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/jsonArray [
Idinteger or null(int32)

The internal id of the Promotion.

Namestring or null[ 0 .. 255 ] characters

The Name of the Promotion. MaxLength: 255

Headerstring or null[ 0 .. 255 ] characters

SubHeader from Norce. MaxLength: 255

ShortDescriptionstring or null[ 0 .. 255 ] characters

DescriptionHeader from Norce. MaxLength: 255

Description1string or null

Description from Norce.

Description2string or null

SubDescription from Norce.

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(uuid)

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 or null

A comma separated list of fulfilled requirements for this promotion.

DiscountCodestring or null

Will contain the discountCode if the promotion has a discountCode requirement.

IsExcludedFromPriceCalculationboolean or null

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

AllowProductListingboolean or null

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 or null(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 or null(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 or null

A comma separated list of applicable effects for this promotion.

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 or null

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 or null(int32)

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

ExternalCodestring or null[ 0 .. 255 ] characters

The external code of the Promotion. This is NOT the discount code. MaxLength: 255

]
Response
application/json
[
  {
    "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": "9afa8b7e-ca15-438f-a9d6-f679c437e59c",
    "RequirementSeed": "string",
    "DiscountCode": "string",
    "IsExcludedFromPriceCalculation": true,
    "AllowProductListing": true,
    "Images": [ … ],
    "ProductFilters": [ … ],
    "AppliedAmount": 0,
    "EffectSeed": "string",
    "FreightDiscountPct": 0,
    "IsStackable": true,
    "AppliedAmountIncVat": 0,
    "ExclusivityType": 0,
    "ExternalCode": "string"
  }
]

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)

The internal basket id.

cultureCodestring

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

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/shopping/1.1/ListPromotionsByBasket \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/jsonArray [
Idinteger or null(int32)

The internal id of the Promotion.

Namestring or null[ 0 .. 255 ] characters

The Name of the Promotion. MaxLength: 255

Headerstring or null[ 0 .. 255 ] characters

SubHeader from Norce. MaxLength: 255

ShortDescriptionstring or null[ 0 .. 255 ] characters

DescriptionHeader from Norce. MaxLength: 255

Description1string or null

Description from Norce.

Description2string or null

SubDescription from Norce.

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(uuid)

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 or null

A comma separated list of fulfilled requirements for this promotion.

DiscountCodestring or null

Will contain the discountCode if the promotion has a discountCode requirement.

IsExcludedFromPriceCalculationboolean or null

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

AllowProductListingboolean or null

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 or null(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 or null(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 or null

A comma separated list of applicable effects for this promotion.

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 or null

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 or null(int32)

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

ExternalCodestring or null[ 0 .. 255 ] characters

The external code of the Promotion. This is NOT the discount code. MaxLength: 255

]
Response
application/json
[
  {
    "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": "9afa8b7e-ca15-438f-a9d6-f679c437e59c",
    "RequirementSeed": "string",
    "DiscountCode": "string",
    "IsExcludedFromPriceCalculation": true,
    "AllowProductListing": true,
    "Images": [ … ],
    "ProductFilters": [ … ],
    "AppliedAmount": 0,
    "EffectSeed": "string",
    "FreightDiscountPct": 0,
    "IsStackable": true,
    "AppliedAmountIncVat": 0,
    "ExclusivityType": 0,
    "ExternalCode": "string"
  }
]

Schemas