Skip to content

Documentation ShoppingService (1.1)

Entities and methods to handle baskets and payments.

Download OpenAPI description
Languages
Servers
https://customer-slug.api-se.norce.tech/commerce/shopping/1.1/

Schemas

Schemas

Summary

Itemsobject(SummaryItem)(SummaryItem)
Freigtobject(SummaryItem)(SummaryItem)
Feesobject(SummaryItem)(SummaryItem)
Totalobject(SummaryItem)(SummaryItem)
{ "Items": { "Amount": 0, "Vat": 0, "AmountIncVat": 0 }, "Freigt": { "Amount": 0, "Vat": 0, "AmountIncVat": 0 }, "Fees": { "Amount": 0, "Vat": 0, "AmountIncVat": 0 }, "Total": { "Amount": 0, "Vat": 0, "AmountIncVat": 0 } }

SummaryItem

Amountnumber(decimal)

Total Amount exclusive VAT. PriceDisplay * Quantity.

Vatnumber(decimal)

The total VAT amount.

AmountIncVatnumber(decimal)

Total Amount including VAT. PriceDisplayIncVat * Quantity.

{ "Amount": 0, "Vat": 0, "AmountIncVat": 0 }

CustomersAccount

Idinteger or null(int32)

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 Storm will generate the Id.

Keystring(guid)

The system wide unique Key for the Account.

LoginNamestring

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.

Namestring

This is the full name of the connected Customer's first and last name. MaxLength: 100.

RolesArray of integers(int32)

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.

AuthorizationsArray of objects(IdValue)(IdValue)

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.

IsActiveboolean

Indicates if the Account is Active or not. Use UpdateAccountStatus to change this value.

{ "Id": 0, "Key": "string", "LoginName": "string", "Name": "string", "Roles": [ 0 ], "Authorizations": [ {} ], "IsActive": true }

Basket

Operations

Checkout

Operations

DeliveryMethods

Operations

InfoTypes

Operations

OnHand

Operations

OrderRequest

Operations

Payments

Operations

Promotions

Operations

Subscriptions

Operations