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.
https://{slug}.api-se.playground.norce.tech/commerce/
https://{slug}.api-se.stage.norce.tech/commerce/
https://{slug}.api-se.norce.tech/commerce/
Contains endpoints for manage baskets and their lifecycle, see more information here.
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.
Used when updating the Checkout with a DeliveryMethod. See UpdateDeliveryMethod4 for more info. Only intended to be used in API version 1.1.
The Price of the DeliveryMethod, excluding VAT. Prices set here will be handled as manual prices. If no prices are set the Price will be taken from Norce and be treated as a normal price.
The Price of the DeliveryMethod, including VAT. Prices set here will be handled as manual prices. If this is set it will override Price.
The DropPoint entity represents a pickup place for deliveries. Only used for external or integrated DeliveryMethod providers.
An external Code for the DeliveryMethod. This should not be set if the Code defined in Norce is to be used.
{ "Id": 0, "Price": 0, "PriceIncVat": 0, "DropPoint": { "Code": "string", "RoutingCode": "string", "Depot": "string", "Name1": "string", "Name2": "string", "Address1": "string", "Address2": "string", "PostalCode": "string", "City": "string", "CountryCode": "string", "Contact": "string", "Phone": "string", "Fax": "string", "Email": "string", "Latitude": 0.1, "Longitude": 0.1, "Distance": 0.1, "OpeningHours": [ … ], "IsSelected": true }, "Code": "string", "Carrier": "string" }
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.
The PartNo of this Item. Must be specified when adding items to a basket. MaxLength: 50
Manufacturer part number. Populated by Norce. MaxLength: 50
Sub header of the product. Populated by Norce. MaxLength: 255
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.
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.
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 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.
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 Norce. MaxLength: 100
Information about OnHand for a given SKU. There are generally three different types of OnHand in Norce. One for the Web, one for the chosen supplier and one for any specified Store.
Information about OnHand for a given SKU. There are generally three different types of OnHand in Norce. One for the Web, one for the chosen supplier and one for any specified Store.
The rule based price, excluding VAT, from a priceList, if specified.
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.
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.
A comma separated list of internal category ids ordered so the primary category is first.
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.
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 Norce Admin. MaxLength: 255
Used when setting price on a BasketItem from the application. Manual prices are not discountable when applying promotions or company discounts.
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.
The rule based price, including VAT, from a priceList, if specified.
{ "Id": 0, "LineNo": 0, "ParentLineNo": 0, "ProductId": 0, "PartNo": "string", "ManufacturerPartNo": "string", "Name": "string", "SubHeader": "string", "ThumbnailImage": "string", "FlagIdSeed": "string", "Type": 0, "PriceDisplay": 0, "Price": 0, "PriceOriginal": 0, "Cost": 0, "VatRate": 0, "Quantity": 0, "Uom": "string", "UomCount": 0, "Comment": "string", "PriceListId": 0, "ReferId": 0, "ReferUrl": "string", "IsEditable": true, "IsDiscountable": true, "Info": [ { … } ], "OptionalItems": [ {} ], "OnHandValue": 0, "IncomingValue": 0, "NextDeliveryDate": "2019-08-24T14:15:22Z", "LeadtimeDayCount": 0, "PromotionIdSeed": "string", "ImageKey": "9afa8b7e-ca15-438f-a9d6-f679c437e59c", "ManufacturerName": "string", "CategoryId": 0, "OnHand": { "Value": 0, "IncomingValue": 0, "NextDeliveryDate": "2019-08-24T14:15:22Z", "LeadtimeDayCount": 0, "LastChecked": "2019-08-24T14:15:22Z", "IsActive": true, "IsReturnable": true, "Info": [ … ] }, "OnHandSupplier": { "Value": 0, "IncomingValue": 0, "NextDeliveryDate": "2019-08-24T14:15:22Z", "LeadtimeDayCount": 0, "LastChecked": "2019-08-24T14:15:22Z", "IsActive": true, "IsReturnable": true, "Info": [ … ] }, "PriceRecommended": 0, "ManufacturerId": 0, "UniqueName": "string", "StatusId": 0, "StockDisplayBreakPoint": 0, "PriceCatalog": 0, "IsBuyable": true, "SubDescription": "string", "CategoryIdSeed": "string", "RecommendedQuantity": 0, "IsRecommendedQuantityFixed": true, "AppliedPromotions": [ { … } ], "RequirementPromotionIdSeed": "string", "IsSubscribable": true, "DescriptionHeader": "string", "IsPriceManual": true, "PriceStandard": 0, "EanCode": "string", "CostUnit": 0, "PriceDisplayIncVat": 0, "PriceListLocked": true, "PriceOriginalIncVat": 0, "PriceRecommendedIncVat": 0, "PriceCatalogIncVat": 0, "PriceStandardIncVat": 0, "Weight": 0, "Height": 0, "Width": 0, "Length": 0, "IsDropShipOnly": true }