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.
AppliedPromotionOnItem entity represents promotions applied on Basket.Items. Only Basket.Items with any promotions applied will have any.
Will contain the discountCode if the promotion has a discountCode requirement.
Applied discount amount, excluding VAT, for this Promotion on this BasketItem.
{ "Id": 0, "Name": "string", "DiscountCode": "string", "AppliedAmount": 0, "AppliedAmountIncVat": 0 }
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.
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" }
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" }