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.
(Optional) A comma separated list of internal pricelist ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.
(Optional) Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.
A list of BasketItems to update. If quantity is zero it and it's child items will be deleted. Otherwise only Quantity, Comment, Name and Info fields will be updated. To update the Price set Price and IsPriceManual.
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.
https://customer-slug.api-se.playground.norce.tech/commerce/shopping/1.1/UpdateBasketItems
https://customer-slug.api-se.stage.norce.tech/commerce/shopping/1.1/UpdateBasketItems
https://customer-slug.api-se.norce.tech/commerce/shopping/1.1/UpdateBasketItems
curl -i -X POST \
https://customer-slug.api-se.playground.norce.tech/commerce/shopping/1.1/UpdateBasketItems \
-H 'ApplicationId: YOUR_API_KEY_HERE' \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '[
{
"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": [
{
"TypeId": 0,
"Value": "string",
"Code": "string"
}
],
"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": [
{
"Id": 0,
"Value": "string",
"Code": "string"
}
]
},
"OnHandSupplier": {
"Value": 0,
"IncomingValue": 0,
"NextDeliveryDate": "2019-08-24T14:15:22Z",
"LeadtimeDayCount": 0,
"LastChecked": "2019-08-24T14:15:22Z",
"IsActive": true,
"IsReturnable": true,
"Info": [
{
"Id": 0,
"Value": "string",
"Code": "string"
}
]
},
"PriceRecommended": 0,
"ManufacturerId": 0,
"UniqueName": "string",
"StatusId": 0,
"StockDisplayBreakPoint": 0,
"PriceCatalog": 0,
"IsBuyable": true,
"SubDescription": "string",
"CategoryIdSeed": "string",
"RecommendedQuantity": 0,
"IsRecommendedQuantityFixed": true,
"AppliedPromotions": [
{
"Id": 0,
"Name": "string",
"DiscountCode": "string",
"AppliedAmount": 0,
"AppliedAmountIncVat": 0
}
],
"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
}
]'Success
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.
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 information types with values that may be propagated on the order.
The Summary is a grouping of BasketItem totals. This can be used to display summaries for a Basket.
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 Norce. Can be set in CreateBasket or updated in UpdatePaymentMethod.
The DeliveryMethodId from Norce. 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.
{ "Id": 0, "CustomerId": 0, "CompanyId": 0, "SalesContactId": 0, "StatusId": 0, "CurrencyId": 0, "CurrencyCode": "str", "Comment": "string", "OrderReference": "string", "DiscountCode": "string", "ReferId": 0, "ReferUrl": "string", "ValidTo": "2019-08-24T14:15:22Z", "IsEditable": true, "Items": [ { … } ], "Info": [ { … } ], "Summary": { "Items": { … }, "Freigt": { … }, "Fees": { … }, "Total": { … } }, "AppliedPromotions": [ { … } ], "IpAddress": "string", "AttestedBy": 0, "TypeId": 0, "DoHold": true, "IsBuyable": true, "InvoiceReference": "string", "PaymentMethodId": 0, "DeliveryMethodId": 0, "SalesAreaId": 0, "ExternalDiscountCode": "string" }
(Optional) A comma separated list of internal pricelist ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.
(Optional) Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.
https://customer-slug.api-se.playground.norce.tech/commerce/shopping/1.1/UpdateBasketItemQuantityWithChildren
https://customer-slug.api-se.stage.norce.tech/commerce/shopping/1.1/UpdateBasketItemQuantityWithChildren
https://customer-slug.api-se.norce.tech/commerce/shopping/1.1/UpdateBasketItemQuantityWithChildren
curl -i -X POST \
https://customer-slug.api-se.playground.norce.tech/commerce/shopping/1.1/UpdateBasketItemQuantityWithChildren \
-H 'ApplicationId: YOUR_API_KEY_HERE' \
-H 'Authorization: YOUR_API_KEY_HERE'Success
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.
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 information types with values that may be propagated on the order.
The Summary is a grouping of BasketItem totals. This can be used to display summaries for a Basket.
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 Norce. Can be set in CreateBasket or updated in UpdatePaymentMethod.
The DeliveryMethodId from Norce. 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.
{ "Id": 0, "CustomerId": 0, "CompanyId": 0, "SalesContactId": 0, "StatusId": 0, "CurrencyId": 0, "CurrencyCode": "str", "Comment": "string", "OrderReference": "string", "DiscountCode": "string", "ReferId": 0, "ReferUrl": "string", "ValidTo": "2019-08-24T14:15:22Z", "IsEditable": true, "Items": [ { … } ], "Info": [ { … } ], "Summary": { "Items": { … }, "Freigt": { … }, "Fees": { … }, "Total": { … } }, "AppliedPromotions": [ { … } ], "IpAddress": "string", "AttestedBy": 0, "TypeId": 0, "DoHold": true, "IsBuyable": true, "InvoiceReference": "string", "PaymentMethodId": 0, "DeliveryMethodId": 0, "SalesAreaId": 0, "ExternalDiscountCode": "string" }
https://customer-slug.api-se.playground.norce.tech/commerce/shopping/1.1/CloseBasketForPostPurchaseUpsell
https://customer-slug.api-se.stage.norce.tech/commerce/shopping/1.1/CloseBasketForPostPurchaseUpsell
https://customer-slug.api-se.norce.tech/commerce/shopping/1.1/CloseBasketForPostPurchaseUpsell
curl -i -X POST \
https://customer-slug.api-se.playground.norce.tech/commerce/shopping/1.1/CloseBasketForPostPurchaseUpsell \
-H 'ApplicationId: YOUR_API_KEY_HERE' \
-H 'Authorization: YOUR_API_KEY_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.