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.
An Account is related to a Customer. Each Account can belong to only one Application. When creating Customers you need to define a Customer.Account if you want the customer to be able to login. This is useful when the application supports My page with order history and such.
The internal Id of the Account. This value should be used as updatedBy/createdBy in API-Methods. When creating a new Account on a Customer leave this blank as Norce will generate the Id.
This is the login name used when logging in. Normally this is the email address. Care must be taken when user updates their emailAddress. Normally this update is just for Customer.Email. It is up to the Application to keep Customer.Email in sync with Account.LoginName if they are the same. MaxLength: 255
This is the full name of the connected Customer's first and last name. MaxLength: 100
This is an integer list of Role.Ids. See Application.Roles for available roles for the Application. This can be used to authorize roles to different parts of an Application.
This is an IdValue list of Authorizations. See Application.Authorizations for available values for the Application. This can be used to authorize users to different parts of an Application.
Indicates if the Account is Active or not. Use UpdateAccountStatus to change this value.
{ "Id": 0, "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd", "LoginName": "string", "Name": "string", "Roles": [ 0 ], "Authorizations": [ { … } ], "IsActive": true, "NewPassword": "string" }
Information about an address. Addresses appear as InvoiceAddress or DeliveryAddresses or when ever an Address is needed
The internal Id of the Address. When creating a new Address leave this blank as Norce will generate the Id.
The internal Id for the country associated to the Address. When creating or updating Country on an Address either specify the CountryId or just the Country string. If Id is specified it will be used to resolve the Name. If none is specified the default for the Application will be used.
The country name of the Address. When creating or updating Country on an Address either specify the CountryId or just the Country string. If Name is specified it will be used to resolve the Name and Id. Name should then be specified as Country.Code since Names are culture specific. If none is specified the default for the Application will be used. MaxLength: 50
Indicates if the address had been validated. It is up to the Application to validate addresses. Use normal address-methods to update this value.
The Global Location Number (GLN) is part of the GS1 systems of standards. It is a simple tool used to identify a location and can identify locations uniquely where required. This is only used for invoice addresses. MaxLength: 50
Phone number for shipping address. Only applicable in shipping addresses. MaxLength: 50
{ "Id": 0, "CareOf": "string", "Line1": "string", "Line2": "string", "Zip": "string", "City": "string", "CountryId": 0, "Country": "string", "Region": "string", "IsValidated": true, "GlobalLocationNo": "string", "ShippingPhoneNumber": "string", "Code": "string" }
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 }