Schemas

AppliedPromotionOnItem

Idinteger or null(int32)

The internal id of the Promotion.

Namestring

The Name of the Promotion. MaxLength: 255.

DiscountCodestring

Will contain the discountCode if the promotion has a discountCode requirement. MaxLength: max.

AppliedAmountnumber or null(decimal)

Applied discount amount, excluding VAT, for this Promotion on this BasketItem.

AppliedAmountIncVatnumber or null(decimal)

Applied discount amount, including VAT, for this Promotion on this BasketItem.

{
  "Id": 0,
  "Name": "string",
  "DiscountCode": "string",
  "AppliedAmount": 0,
  "AppliedAmountIncVat": 0
}

Basket

Idinteger or null(int32)

The internal id of the basket. Used to get a specific basket. Ignored in CreateBasket.

CustomerIdinteger or null(int32)

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.

CompanyIdinteger or null(int32)

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.

SalesContactIdinteger or null(int32)

StatusIdinteger(int32)

Internal id for the current status of the basket. See ListBasketStatuses.

CurrencyIdinteger(int32)

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.

CurrencyCodestring

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.

Commentstring

Free text comment that will be propagated to the order. MaxLength: 250.

OrderReferencestring

An OrderReference which will be tagged on the order. Can be set in CreateBasket or updated in UpdateBasket. MaxLength: 50.

DiscountCodestring

A comma separated list of used discount codes. To clear the value set it to null or String.Empty an call UpdateBasket. MaxLength: max.

ReferIdinteger or null(int32)

ReferUrlstring

MaxLength: 255.

ValidTostring or null(date-time)

IsEditableboolean

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.

ItemsArray of objects(BasketItem)(BasketItem)

List of the items in the basket.

InfoArray of objects(ExtraInfo)(ExtraInfo)

List of information types with values that may be propagated on the order.

Summaryobject(Summary)(Summary)

AppliedPromotionsArray of objects(Promotion)(Promotion)

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.

IpAddressstring

The user's IpAddress when the basket was created. The value should be fetched from the user request to the application. MaxLength: 50.

AttestedByinteger or null(int32)

TypeIdinteger(int32)

The internal type id of the Basket. Can be 1 = Basket, 2 = Saved Basket, 3 = Template Basket for Subscriptions.

DoHoldboolean

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.

IsBuyableboolean

IsBuyable is a rule based property indicating if the Basket's status allows the basket to be purchased. It should be regarded as readonly.

InvoiceReferencestring

An InvoiceReference which will be tagged on the order. Can be set in CreateBasket or updated in UpdateBasket. MaxLength: 50.

PaymentMethodIdinteger or null(int32)

The PaymentMethodId from Storm. Can be set in CreateBasket or updated in UpdatePaymentMethod.

DeliveryMethodIdinteger or null(int32)

The DeliveryMethodId from Storm. Can be set in CreateBasket or updated in UpdateDeliveryMethod.

SalesAreaIdinteger(int32)

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": "string",
  "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
}

BasketDeliveryMethodUpdate

Idinteger(int32)

The internal id of the DeliveryMethod.

Pricenumber or null(decimal)

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 Storm and be treated as a normal price.

DropPointobject(DropPoint)(DropPoint)

Codestring

An external Code for the DeliveryMethod. This should not be set if the Code defined in Storm is to be used. MaxLength: 50.

Carrierstring

The carrier providing the delivery method MaxLength: 50.

PriceIncVatnumber or null(decimal)

The Price of the DeliveryMethod, including VAT. Prices set here will be handled as manual prices. If this is set it will override Price.

{
  "Id": 0,
  "Price": 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",
  "PriceIncVat": 0
}

Documentation ShoppingService (1.1)

Schemas

AppliedPromotionOnItem

Basket

BasketDeliveryMethodUpdate

Basket

Checkout

DeliveryMethods

InfoTypes

OnHand

OrderRequest

Payments

Promotions

Subscriptions