Shopping Service schemas
Entities and methods to handle baskets and payments.
Basket
Basket
Represents a basket where you can add/remove/update items and information such as discountcodes and pass forward information types.
The internal id of the basket. Used to get a specific basket. Ignored in CreateBasket.
The customer internal id for a specific customer associated with this basket. This can be set in CreateBasket if the user is logged in. Otherwise use UpdateBuyer to set customer.
The company internal id for a specific company associated with this basket. This can be set in CreateBasket if the user is logged in with a company. Otherwise use UpdateBuyer to set customer and company.
Internal id for the current status of the basket. See ListBasketStatuses.
The currency internal id of the basket. This defines the currency used when processing payments. Can be set when creating a Basket or change later with UpdateBasket. Use either CurrencyId or CurrencyCode. If not specified, the default for the Application will be used.
The CurrencyCode of the basket. This defines the currency used when processing payments. Can be set when creating a Basket or change later with UpdateBasket. Use either CurrencyId or CurrencyCode. If not specified, the default for the Application will be used. MaxLength: 3.
Free text comment that will be propagated to the order. MaxLength: 250.
An OrderReference which will be tagged on the order. Can be set in CreateBasket or updated in UpdateBasket. MaxLength: 50.
A comma separated list of used discount codes. To clear the value set it to null or String.Empty an call UpdateBasket. MaxLength: max.
MaxLength: 255.
Specifies if the basket is editable. If not, any method that changes the basket will throw Exceptions (Bad Request). It will be false when the basket is no longer a basket. That is when it's paid for or cancelled.
List of the items in the basket.
List of information types with values that may be propagated on the order.
Contains all Promotions valid for a Basket, whether or not they are applied. If any promotions are applied more info about them are added to the corresponding Basket.Items.
The user's IpAddress when the basket was created. The value should be fetched from the user request to the application. MaxLength: 50.
The internal type id of the Basket. Can be 1 = Basket, 2 = Saved Basket, 3 = Template Basket for Subscriptions.
DoHold specifies if the resulting order should be on hold until all items on the order can be shipped or not. Default is false. This can be set in the Checkout with UpdateBasket if the Customer does not want part deliveries.
IsBuyable is a rule based property indicating if the Basket's status allows the basket to be purchased. It should be regarded as readonly.
An InvoiceReference which will be tagged on the order. Can be set in CreateBasket or updated in UpdateBasket. MaxLength: 50.
The PaymentMethodId from Storm. Can be set in CreateBasket or updated in UpdatePaymentMethod.
The DeliveryMethodId from Storm. Can be set in CreateBasket or updated in UpdateDeliveryMethod.
The SalesArea internal id of the basket. This defines the default VAT-rate used. Can be set when creating a Basket or change later with UpdateBasket. If not specified, the default for the Application will be used.
BasketItem
Internal id of the basket item. Used to refer to this particular row in different methods.
Line number of the item. Used to refer to this particular row in different methods.
If this item is part of a bundle, an attached item from promotion or such this property will refer to the associated line number.
Internal product id of the product for this basket item.
The PartNo of this Item. Must be specified when adding items to a basket. MaxLength: 50.
Manufacturer part number. Populated by Storm. MaxLength: 50.
Name of the product. Populated by Storm. MaxLength: 255.
Sub header of the product. Populated by Storm. MaxLength: 255.
MaxLength: 255. Obsolete! - Use ImageKey with preset
A comma separated list of internal flag ids. MaxLength: max.
The internal type id of the underlying product. See ListSkuTypes under Products.
This is the price, excluding VAT, after applying company discounts and promotions. It is what the customer is paying.
This is the snapshot value, excluding VAT, of PriceDisplay when the basket is bought. Should be null. Can be used to set a price from the application when updating or creating BasketItems. Then IsPriceManual must be set to true as well.
This is the original price of the SKU, excluding VAT.
CostPurchase from Storm Admin, excluding VAT.
A rate to multiply with price to get price inc VAT. 25% VAT equals a VatRate of 1.25.
The Quantity of this Item. Must be specified when adding items to a basket.
MaxLength: 50.
Free text comment for this basket item. MaxLength: 255.
The internal pricelist id of this Item. Must be specified when adding items to a basket. Use the PriceListId from Product or ProductItem.
Used to tag a BasketItem with some external id.
Used to tag a BasketItem with an incoming URL. MaxLength: 255.
Indicates if a basket item is editable or not. This can happen when the API splits rows in promotions. Can be checked to see if an item should be allowed for UpdateBasketItem.
List of information types and values associated with this particular basket item.
Obsolete! - Moved to OnHand property
Obsolete! - Moved to OnHand property
Obsolete! - Moved to OnHand property
Obsolete! - Moved to OnHand property
Internal ids of promotions applied on this product. MaxLength: max.
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.
Name of the manufacturer of the product. Populated by Storm. MaxLength: 100.
Obsolete! - Use CategoryIdSeed
The rule based price, excluding VAT, from a priceList, if specified.
Internal manufacturer id for the product. Populated by Storm.
A unique name that can be used in Urls and to get a Product. GetProduct and GetProductByUniqueName gets the same Product. MaxLength: 500.
The status of the underlying product. Lookup references in ListStatuses.
A value that can be used for display logic regarding OnHand.
The original price, excluding VAT, if specified.
Indicates if the item is buyable or not. Will always be false if the status is closed. An exception will be thrown if IsBuyable is false and an attempt to buy the item is made.
Sub description from Storm Admin. MaxLength: max.
A comma separated list of internal category ids ordered so the primary category is first. MaxLength: max.
Indicates the default value used as quantity when buying the product. If IsRecommendedQuantityFixed is true, only multiples of this quantity should be allowed.
If this is set to true only multiples of RecommendedQuantity should be allowed.
Applied promotions for this item, if any. It will contain some info about what promotion was applied and amount applied.
A comma separated list of promotion internal ids for this item that are fulfilling the requirements. MaxLength: max.
True if this item can be added to a Subscription. False otherwise. Can be used when copying BasketItems from one Basket to a TemplateBasket in a Subacription.
DescriptionHeader for the product as specified in Storm Admin. MaxLength: 255.
Used when setting price on a BasketItem from the application. Manual prices are not discountable when applying promotions or company discounts.
The standard price, excluding VAT, if specified.
SKU EAN code. MaxLength: 50.
CostUnit, excluding VAT, from Storm Admin.
This is the price including VAT after applying company discounts and promotions. It is what the customer is paying.
Set to true to exclude this item's price list from business logic when selecting cheapest price. Will be set to false if price list is unavailable.
This is the original price of the SKU, including VAT.
The rule based price, including VAT, from a priceList, if specified.
The original price, including VAT, if specified.
The standard price, including VAT, if specified.
BasketPagedList
Total number of baskets.
List of baskets.
InsertItemsPostPurchaseData
Used as input to InsertItemsPostPurchase since WCF cannot take more than one complex type at once as parameter.
The items to add to the purchase. The items to insert must have its PartNo, Quantity and PriceListId set. ParentLineNo, Name, Comment, ReferId and ReferUrl can be used if other values than the default are wanted. All other properties will be populated from the system.
Roundtrip of the parameters received in the original payment response.
SavedBasket
Internal id of the saved basket.
Name given to this specific saved basket. MaxLength: 50.
Creation date.
Internal customer id of associated customer, if any.
Valid date, if any.
Summary
The Summary is a grouping of BasketItem totals. This can be used to display summaries for a Basket.
SummaryItem
The SummaryItem is the summary used for each item in Summary.
Total Amount exclusive VAT. PriceDisplay * Quantity.
The total VAT amount.
Total Amount including VAT. PriceDisplayIncVat * Quantity.
Checkout
Checkout
Used to connect a specific basket with customer information, payment and delivery options.
List of available payment methods for this checkout. May be changed depending on basket contents. Generated by Storm.
List of available delivery methods for this checkout. May be changed depending on basket contents. Generated by Storm.
List of payment attemtps made for this checkout. Each payment method selected will create it's own entry in this list.
Payment
Represents a single payment attempt for this basket.
System generated id for this particular payment. Client specific.
Payment amount, including VAT.
Card number if payment has been made by credit card or gift card. Populated by PSP. MaxLength: max.
Internal id of the payment method for this payment. Application specific.
Internal id of the payment service for this payment. System specific. Indicates the PSP.
PurchaseEx2Data
Used as input to PurchaseEx2 since WCF cannot take more than one complex type at once as parameter.
General: 'test'=true to enable tests. When 'test' is used no payments will be processed for real. Payments may interpret supplied values such as cardNumber or ssn to simulate failures. Not implemented. Klarna: 'sessionId'=id. Used to provide a sessionId to Klarna payments. Not implemented. Payex and Dibs. Supported values are 'returnUrl' and 'cancelUrl'. Values should point to where the payment service should go in case of success/failure.
DeliveryMethods
BasketDeliveryMethodUpdate
Used when updating the Checkout with a DeliveryMethod. See UpdateDeliveryMethod4 for more info.
The internal id of the DeliveryMethod.
The Price of the DeliveryMethod, excluding VAT. Prices set here will be handled as manual prices. If not set the Price will be taken from Storm and be treated as a normal price.
An external Code for the DeliveryMethod. This should not be set if the Code defined in Storm is to be used. MaxLength: 50.
The carrier providing the delivery method MaxLength: 50.
DeliveryMethod
Represent a DeliveryMethod in Norce. DeliveryMethods can be specified in the Admin UI or fetch from integrated Delivery providers such as ShipAdvisor. Application specific.
The internal id of the DeliveryMethod.
The Name of the DeliveryMethod. MaxLength: 50.
The internal type id of the DeliveryMethod. DeliveryMethodTypes are logical groupings of different types such as home delivery, pickup and such.
The TypeName of the DeliveryMethodType. MaxLength: 50.
The Description of the DeliveryMethod. MaxLength: max.
The part number, if any, of the product representing the DeliveryMethod. Products setup for delivery methods must have a SkuType equal to Freight. These are handled by Storm and added and removed automatically. MaxLength: 50.
The Price of the DeliveryMethod, excluding VAT.
A rate to multiply with price to get price inc VAT. 25% VAT equals a VatRate of 1.25.
Indicates if the DeliveryMethod has delivery notifications.
MaxLength: 255. Obsolete! - Use ImageKey with preset
IsSelected is set to true for the currently selected DeliveryMethod on baskets. All other DeliveryMethods have this set to false. If no DeliveryMethod has been set all will have this value set to false.
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.
Indicates if the DeliveryMethod has is for Companies only.
Indicates if the DeliveryMethod has is for Customers only.
The Cost of the DeliveryMethod.
The internal store id of any Store connected to this DeliveryMethod. Most often this will be set if ZipCode mappings exist in Storm.
The internal warehouse id of any Warehouse connected to this DeliveryMethod. Most often this will be set if ZipCode mappings exist in Storm.
The internal location id of any WarehouseLocation connected to this DeliveryMethod. Most often this will be set if ZipCode mappings exist in Storm.
A list of DropPoint, if any, for the DeliveryMethod. These are not kept in Storm but fetched from integrated DeliveryMethod providers such as ShipAdvisor.
An external Code for the DeliveryMethod. MaxLength: 50.
Optional information about carrier MaxLength: 50.
DropPoint
The DropPoint entity represents a pickup place for deliveries. Only used for external or integrated DeliveryMethod providers.
Code is the external/integrated DeliveryMethod provider's code for the pickup store. MaxLength: 50.
MaxLength: 50. Obsolete! - Not used
MaxLength: 50. Obsolete! - Not used
The name of the place to pickup the goods. MaxLength: 100.
The name part 2 of the place to pickup the goods. MaxLength: 100.
The Address of the place to pickup the goods. MaxLength: 100.
The Address part 2 of the place to pickup the goods. MaxLength: 100.
The ZipCode of the place to pickup the goods. MaxLength: 50.
The City of the place to pickup the goods. MaxLength: 50.
The CountryCode of the place to pickup the goods. MaxLength: 3.
The Contact of the place to pickup the goods. MaxLength: 100.
The Phone to the place to pickup the goods. MaxLength: 50.
MaxLength: 50. Obsolete! - Not used
The Email to the place to pickup the goods. MaxLength: 255.
The Latitude part of the location of the pickup. Can be used to calculate distances.
The Longitude part of the location of the pickup. Can be used to calculate distances.
The Distance to the location of the pickup.
A list of opening hours for the pickup.
Indicates if this is the selected DropPoint or not. Gets set by Storm.
OpeningHours
MaxLength: 255.
MaxLength: 255.
InfoTypes
ExtraInfo
Information carrying entity to convey customer specific information from the basket to the order, PSP et.al.
The internal id of type. This TypeId might be different in different tiers such as Stage and Production. Use Code if hard coding is required.
The Value of the Entity. MaxLength: max.
The Code of the type, if existing. Use this value when hard coding is required. MaxLength: 50.
OnHand
No entities. See ProductOnHand
OrderRequest
No entities. Returns raw xml. TODO!
PaymentMethods
PaymentMethod
Represents a specific payment method in Norce. A PSP may be represented with multiple payment methods. Application specific.
Internal id for this payment method.
Descriptive name of the payment method. MaxLength: 50.
Internal type id for this payment method.
Clear text name of the type of this payment method. MaxLength: 50.
Free text description of the payment method. MaxLength: max.
Part number for this payment method, if configured. MaxLength: 50.
Price, excluding VAT, to use this payment method, if configured.
A rate to multiply with price to get price inc VAT. 25% VAT equals a VatRate of 1.25.
MaxLength: 500. Obsolete! - Use ImageKey with preset
Indicates if this is the currently selected payment method for the Checkout. Only one may have this flag set to true. Use UpdatePaymentMethod3 to set this property.
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.
Indicates if this payment method is only allowed for companies. Cannot be combined with IsForPersonOnly.
Indicates if this payment method is only allowed for persons. Cannot be combined with IsForCompanyOnly.
PaymentService
Represents a way of payment. A client may have several payment methods using the same service. A PSP may offer several payment services.
Internal id of this payment service.
Descriptive name of this payment service. MaxLength: 50.
MaxLength: 500.
MaxLength: 500. Obsolete! - Use ImageKey with preset
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.
Payments
PaymentResponse
Response from payment service calls such as GetPaymentForm, Purchase, PurchaseEx.
String response. OK if successful, otherwise may have different values depending on PSP. MaxLength: 50.
Descriptive text for the status. MaxLength: 255.
Internal id of the associated basket.
Order number if order's been created. MaxLength: 50.
Internal identifier of this specific payment attempt. MaxLength: int.
External identifier of this specific payment attempt, usually from the PSP. MaxLength: 50.
Used when a payment should be finalized on a different platform, e.g. sending a link by SMS to customer. MaxLength: 50.
Configurated redirection URL after successful payment. MaxLength: 255.
PSP specific data returned for the payment. See PSP documentation.
Indicates if the payment attempt was synchronous or not.
Internal id of the payment service used.
Promotions
AppliedPromotionOnItem
AppliedPromotionOnItem entity represents promotions applied on Basket.Items. Only Basket.Items with any promotions applied will have any.
The internal id of the Promotion.
The Name of the Promotion. MaxLength: 255.
Will contain the discountCode if the promotion has a discountCode requirement. MaxLength: max.
Applied discount amount, excluding VAT, for this Promotion on this BasketItem.
Applied discount amount, including VAT, for this Promotion on this BasketItem.
Promotion
The Promotion entity represents a promotion in Norce. It contains some meta data from the Promotion as well as applied total amount when applicable.
The internal id of the Promotion.
The Name of the Promotion. MaxLength: 255.
SubHeader from Storm. MaxLength: 255.
DescriptionHeader from Storm. MaxLength: 255.
Description from Storm. MaxLength: max.
SubDescription from Storm. MaxLength: max.
The StartDate of the Promotion, if any. Only valid promotions will be returned.
The EndDate of the Promotion, if any. Only valid promotions will be returned.
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.
A comma separated list of fulfilled requirements for this promotion. MaxLength: max.
Will contain the discountCode if the promotion has a discountCode requirement. MaxLength: max.
A value of true means the promotion was applied last an not included in any price calculations.
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.
A list of additional images files uploaded for the promotion. Images can be differentiated by using different types. See ListPromotionImageTypes for available types.
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.
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.
A comma separated list of applicable effects for this promotion. MaxLength: max.
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.
Promotion effect quantity or basket discount is multiplied with how many times requirement is fulfilled.
Applied discount amount, including VAT, for this Promotion on this BasketItem.
ExclusivityType allows setting promotions as NotExclusive = 0, Exclusive = 1, or IgnoreExclusivity = 2.
PromotionProductFilter
PromotionProductFilter shows what any product in the requirement or effect is filtered by. Values should be AND:ed if used to filter products.
An optional Manufacturer internal id for filtered products.
An optional CategorySeed for filtered products. MaxLength: int.
An optional SKU Type internal id for filtered products.
An optional Product internal id for filtered products.
An optional VariantProduct internal id for filtered products. Equal to use PartNo.
An optional PartNo for filtered products. Equal to use VariantProductId. MaxLength: 50.
An optional pricelist internal id for filtered products.
An optional Flag internal id for filtered products. Only set if flagId is inclusive.
Subscriptions
Subscription
A Subscription is created by a user. A subscription is backed by a quotation acting as a template for creating orders at scheduled intervals.
A unique internal id for this Subscription. When creating new Subscription this should be left as null and will be ignored.
The name of the Subscription. This will also be the name of the template basket. Can be used to distinguish Subscriptions from each other. MaxLength: 50.
The internal status id for this Subscription. When a Subscription is created the status will be 0 (Inactive) and ignored. To activate a Subscription it must pass through the Checkout process. See ListSubscriptionStatus for valid values. Can only be changed between Active and Paused. To delete a Subscription use DeleteSubscription.
A date used to temporarily pause the Subscription and automatically activate it again on the specified date. If no HoldFromDate is specified the pause will start immediately.
An optional start date for the Subscription. The Subscription can be activated but no orders will be processed before this date if specified. Can only be changed if a specified date has not passed or if the Subscription is still inactive. If no StartDate is specified when activating the Subscription this will be set to the activation date.
An optional end date for the Subscription. The Subscription will be deleted after this date if specified. See DeleteSubscription for details about deleting subscriptions.
The schedules for this Subscription. Any Subscription must have at least one schedule when activated.
A date used to temporarily pause the Subscription from the specified date and automatically activate it again on HoldUtilDate. If this is specified HoldUntilDate must also be specified.
Calculated date for next time an order will be created by this subscription
SubscriptionSchedule
A specific schedule for a Subscription. Schedules are used to determine when orders should be created from the template basket. The StartDate of the Subscription is used as start for the Schedule.
A unique internal id for this SubscriptionSchedule. When creating new schedules this should be left as null.
Specifies if the schedule is active or not. Only active schedules are considered when creating orders.
Specifies how often the Frequency should be applied. If Frequency is 'Daily' and RecurValue is 2 then the schedule is every second day.
Specifies if the schedule should be applied on a Monday. Only used when Frequency is 'Weekly'. At least one of the IsOnDay values must be specified.
Specifies if the schedule should be applied on a Tuesday. Only used when Frequency is 'Weekly'. At least one of the IsOnDay values must be specified.
Specifies if the schedule should be applied on a Wednesday. Only used when Frequency is 'Weekly'. At least one of the IsOnDay values must be specified.
Specifies if the schedule should be applied on a Thursday. Only used when Frequency is 'Weekly'. At least one of the IsOnDay values must be specified.
Specifies if the schedule should be applied on a Friday. Only used when Frequency is 'Weekly'. At least one of the IsOnDay values must be specified.
Specifies if the schedule should be applied on a Saturday. Only used when Frequency is 'Weekly'. At least one of the IsOnDay values must be specified.
Specifies if the schedule should be applied on a Sunday. Only used when Frequency is 'Weekly'. At least one of the IsOnDay values must be specified.
Specifies if the schedule should be applied on a specific day. Only used when Frequency is 'Monthly' and not any of the MonthlyInterval values are used.
Specifies at what time the schedule should be applied. Just the Hours and Minutes parts are used. Formats 'hh:mm.ss' or 'hh:mm'.
SubscriptionScheduleData
General data for scheduling Subscriptions. Data can be used to populate drop lists with values needed when creating SubscriptionSchedules.
A list of frequencies. Defines how often should a Subscription should produce an order. See SubscriptionSchedule for usage.
A list of intervals used together with MonthlyIntervalValues. See SubscriptionSchedule for usage.
A list of interval values used together with MonthlyIntervals. See SubscriptionSchedule for usage.
SubscriptionType
A SubscriptionType specified for the application. Used by Subscription. SubscriptionTypes are created in the Admin UI.
A internal id for this type.
An external code use to identify this type. Used when creating Subscription. MaxLength: 50.
The name of the type. MaxLength: 50.
A description of the type. MaxLength: 500.
An optional end date for the SubscriptionType. Subscriptions created for this SubscriptionType can not have an end date later than this.