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 to connect a specific basket with customer information, payment and delivery options.
Represents a basket where you can add/remove/update items and information such as discountcodes and pass forward information types.
List of available payment methods for this checkout. May be changed depending on basket contents. Generated by Norce.
List of available delivery methods for this checkout. May be changed depending on basket contents. Generated by Norce.
{ "Basket": { "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": { … }, "AppliedPromotions": [ … ], "IpAddress": "string", "AttestedBy": 0, "TypeId": 0, "DoHold": true, "IsBuyable": true, "InvoiceReference": "string", "PaymentMethodId": 0, "DeliveryMethodId": 0, "SalesAreaId": 0, "ExternalDiscountCode": "string" }, "Buyer": { "Id": 0, "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd", "Code": "string", "Email": "string", "Ssn": "string", "FirstName": "string", "LastName": "string", "Phone": "string", "CellPhone": "string", "ReferId": 0, "ReferUrl": "string", "Account": { … }, "Companies": [ … ], "DeliveryAddresses": [ … ], "InvoiceAddress": { … }, "Flags": [ … ], "UseInvoiceAddressAsDeliveryAddress": true, "Info": [ … ], "PricelistIds": [ … ], "CrmId": "string", "IsActive": true, "Created": "2019-08-24T14:15:22Z", "Updated": "2019-08-24T14:15:22Z" }, "Payer": { "Id": 0, "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd", "Code": "string", "Email": "string", "Ssn": "string", "FirstName": "string", "LastName": "string", "Phone": "string", "CellPhone": "string", "ReferId": 0, "ReferUrl": "string", "Account": { … }, "Companies": [ … ], "DeliveryAddresses": [ … ], "InvoiceAddress": { … }, "Flags": [ … ], "UseInvoiceAddressAsDeliveryAddress": true, "Info": [ … ], "PricelistIds": [ … ], "CrmId": "string", "IsActive": true, "Created": "2019-08-24T14:15:22Z", "Updated": "2019-08-24T14:15:22Z" }, "ShipTo": { "Id": 0, "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd", "Code": "string", "Email": "string", "Ssn": "string", "FirstName": "string", "LastName": "string", "Phone": "string", "CellPhone": "string", "ReferId": 0, "ReferUrl": "string", "Account": { … }, "Companies": [ … ], "DeliveryAddresses": [ … ], "InvoiceAddress": { … }, "Flags": [ … ], "UseInvoiceAddressAsDeliveryAddress": true, "Info": [ … ], "PricelistIds": [ … ], "CrmId": "string", "IsActive": true, "Created": "2019-08-24T14:15:22Z", "Updated": "2019-08-24T14:15:22Z" }, "PaymentMethods": [ { … } ], "DeliveryMethods": [ { … } ], "Payments": [ { … } ] }
Information about a Company.
The internal Norce Id for the Company. When creating a new Company leave this blank as Norce will generate the Id.
The external code. Usually the id in the erp system. MaxLength: 50
The organizational number of the Company. Used to identify the Company for some payment methods. The combination of OrgNo and Name must be unique. MaxLength: 50
Used to tag a Company with an incoming URL. MaxLength: 255
A list of delivery Addresses for the Company. When needed the first address in the list will be used. So it is vital in the checkout process to either sort them or just supply one delivery address. Company addresses will override Customer addresses if both exists in the Checkout process.
Information about an address. Addresses appear as InvoiceAddress or DeliveryAddresses or when ever an Address is needed
Can be used when updating or inserting addresses on Company. If set to true the invoice address will be used as a delivery address as well. Then just an invoice address needs to be passed in. The deliveryAddress will be ignored. If set to false both invoice address and delivery address must be specified.
Contains a list of id-value pairs specific to the client for this company. Use ApplicationService.ListCompanyInfoTypes for id lookup.
Contains a list of priceList ids valid for this company. It will be empty if no priceLists exist. It can be used to check products lists if they are from a company specific priceList. No need to pass this into List-methods since they are considered any way in the methods. This property should be considered as ReadOnly as priceLists are maintained else where.
Points to an optional parent company. Used when companies are connected some how.
Contains a list of delivery method ids valid for this company. It will be empty if no delivery methods exist.
Contains a list of payment method ids valid for this company. It will be empty if no payment methods exist.
A list of Flags of the Company. See Flag for information about flags. Flags can be used in Promotions or otherwise to provide custom handling of specific Companies.
{ "Id": 0, "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd", "Code": "string", "Name": "string", "OrgNo": "string", "Phone": "string", "ReferId": 0, "ReferUrl": "string", "DeliveryAddresses": [ { … } ], "InvoiceAddress": { "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" }, "UseInvoiceAddressAsDeliveryAddress": true, "Info": [ { … } ], "PricelistIds": [ 0 ], "ParentId": 0, "DeliveryMethodIds": [ 0 ], "PaymentMethodIds": [ 0 ], "Email": "string", "Flags": [ { … } ], "VatNo": "string" }
Information about a Customer.
The internal Norce Id of the Customer. When creating a new Customer leave this blank as Norce will generate the Id.
The external code. Usually the id in the erp system. MaxLength: 50
The social security number of the Customer. Used to identify the Customer for some payment methods. MaxLength: 50
Used to tag a Customer with an incoming URL. MaxLength: 255
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.
A list of Companies. A Customer can have many Companies. The first will be used as default. In the Checkout process just pass in one Company if any is to be used or the first will be used as default.
A list of delivery Addresses for the Customer. When needed the first address in the list will be used. So it is vital in the checkout process to either sort them or just supply one delivery address. Company addresses will override Customer addresses if both exists in the Checkout process.
Information about an address. Addresses appear as InvoiceAddress or DeliveryAddresses or when ever an Address is needed
A list of Flags for the Customer. See Flag for information about flags. Flags can be used in Promotions or otherwise to provide custom handling of specific Customers.
Can be use when updating or inserting addresses on Customer. If set to true the invoice address will be used as a delivery address as well. Then just an invoice address needs to be passed in. The deliveryAddress will be ignored. If set to false both invoice address and delivery address must be specified.
Contains a list of id-value pairs specific to the client for this customer. Use ApplicationService.ListCustomerInfoTypes for id lookup.
Contains a list of priceList ids valid for this customer. It will be empty if no priceLists exist. It can be used to check products lists if they are from a customer specific priceList. No need to pass this into List-methods since they are considered any way in the methods. This property should be considered as ReadOnly as priceLists are maintained else where.
Used to save the Customers external id from a crm-system. MaxLength: 50
{ "Id": 0, "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd", "Code": "string", "Email": "string", "Ssn": "string", "FirstName": "string", "LastName": "string", "Phone": "string", "CellPhone": "string", "ReferId": 0, "ReferUrl": "string", "Account": { "Id": 0, "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd", "LoginName": "string", "Name": "string", "Roles": [ … ], "Authorizations": [ … ], "IsActive": true, "NewPassword": "string" }, "Companies": [ { … } ], "DeliveryAddresses": [ { … } ], "InvoiceAddress": { "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" }, "Flags": [ { … } ], "UseInvoiceAddressAsDeliveryAddress": true, "Info": [ { … } ], "PricelistIds": [ 0 ], "CrmId": "string", "IsActive": true, "Created": "2019-08-24T14:15:22Z", "Updated": "2019-08-24T14:15:22Z" }