COMMERCE SERVICES

Shopping Service

DeliveryMethod

Documentation ShoppingService (1.1)

Entities and methods to handle baskets and payments.

Download OpenAPI description

openapi.json

openapi.yaml

Servers

https://customer-slug.api-se.norce.tech/commerce/shopping/1.1/

Schemas

Checkout

Basketobject(Basket)(Basket)

Buyerobject(CustomersCustomer)(CustomersCustomer)

Payerobject(CustomersCustomer)(CustomersCustomer)

ShipToobject(CustomersCustomer)(CustomersCustomer)

PaymentMethodsArray of objects(PaymentMethod)(PaymentMethod)

List of available payment methods for this checkout. May be changed depending on basket contents. Generated by Storm.

DeliveryMethodsArray of objects(DeliveryMethod)(DeliveryMethod)

List of available delivery methods for this checkout. May be changed depending on basket contents. Generated by Storm.

PaymentsArray of objects(Payment)(Payment)

List of payment attemtps made for this checkout. Each payment method selected will create it's own entry in this list.

{
  "Basket": {
    "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": { … },
    "AppliedPromotions": [ … ],
    "IpAddress": "string",
    "AttestedBy": 0,
    "TypeId": 0,
    "DoHold": true,
    "IsBuyable": true,
    "InvoiceReference": "string",
    "PaymentMethodId": 0,
    "DeliveryMethodId": 0,
    "SalesAreaId": 0
  },
  "Buyer": {
    "Id": 0,
    "Key": "string",
    "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": "string",
    "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": "string",
    "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": [
    { … }
  ]
}

DeliveryMethod

Idinteger(int32)

The internal id of the DeliveryMethod.

Namestring

The Name of the DeliveryMethod. MaxLength: 50.

TypeIdinteger(int32)

The internal type id of the DeliveryMethod. DeliveryMethodTypes are logical groupings of different types such as home delivery, pickup and such.

TypeNamestring

The TypeName of the DeliveryMethodType. MaxLength: 50.

Descriptionstring

The Description of the DeliveryMethod. MaxLength: max.

PartNostring

The part number, if any, of the product representing the DeliveryMethod. Products setup for delivery methods must have a SkuType equal to Freight. These are handled by Storm and added and removed automatically. MaxLength: 50.

Pricenumber(decimal)

The Price of the DeliveryMethod, excluding VAT.

VatRatenumber(decimal)

A rate to multiply with price to get price inc VAT. 25% VAT equals a VatRate of 1.25.

IsNotifiableboolean

Indicates if the DeliveryMethod has delivery notifications.

ImagePathstring

MaxLength: 255. Obsolete! - Use ImageKey with preset

IsSelectedboolean

IsSelected is set to true for the currently selected DeliveryMethod on baskets. All other DeliveryMethods have this set to false. If no DeliveryMethod has been set all will have this value set to false.

ImageKeystring or null(guid)

A unique id for the image at our image server. Url for images are formed like http://[client specific CDN]/{ImageKey}. Preset, height and width can be sent as parameters.

IsForCompanyOnlyboolean

Indicates if the DeliveryMethod has is for Companies only.

IsForPersonOnlyboolean

Indicates if the DeliveryMethod has is for Customers only.

Costnumber(decimal)

The Cost of the DeliveryMethod.

StoreIdinteger or null(int32)

The internal store id of any Store connected to this DeliveryMethod. Most often this will be set if ZipCode mappings exist in Storm.

WarehouseIdinteger or null(int32)

The internal warehouse id of any Warehouse connected to this DeliveryMethod. Most often this will be set if ZipCode mappings exist in Storm.

LocationIdinteger or null(int32)

The internal location id of any WarehouseLocation connected to this DeliveryMethod. Most often this will be set if ZipCode mappings exist in Storm.

DropPointsArray of objects(DropPoint)(DropPoint)

A list of DropPoint, if any, for the DeliveryMethod. These are not kept in Storm but fetched from integrated DeliveryMethod providers such as ShipAdvisor.

Codestring

An external Code for the DeliveryMethod. MaxLength: 50.

Carrierstring

Optional information about carrier MaxLength: 50.

{
  "Id": 0,
  "Name": "string",
  "TypeId": 0,
  "TypeName": "string",
  "Description": "string",
  "PartNo": "string",
  "Price": 0,
  "VatRate": 0,
  "IsNotifiable": true,
  "ImagePath": "string",
  "IsSelected": true,
  "ImageKey": "string",
  "IsForCompanyOnly": true,
  "IsForPersonOnly": true,
  "Cost": 0,
  "StoreId": 0,
  "WarehouseId": 0,
  "LocationId": 0,
  "DropPoints": [
    { … }
  ],
  "Code": "string",
  "Carrier": "string"
}

DropPoint

Codestring

Code is the external/integrated DeliveryMethod provider's code for the pickup store. MaxLength: 50.

RoutingCodestring

MaxLength: 50. Obsolete! - Not used

Depotstring

MaxLength: 50. Obsolete! - Not used

Name1string

The name of the place to pickup the goods. MaxLength: 100.

Name2string

The name part 2 of the place to pickup the goods. MaxLength: 100.

Address1string

The Address of the place to pickup the goods. MaxLength: 100.

Address2string

The Address part 2 of the place to pickup the goods. MaxLength: 100.

PostalCodestring

The ZipCode of the place to pickup the goods. MaxLength: 50.

Citystring

The City of the place to pickup the goods. MaxLength: 50.

CountryCodestring

The CountryCode of the place to pickup the goods. MaxLength: 3.

Contactstring

The Contact of the place to pickup the goods. MaxLength: 100.

Phonestring

The Phone to the place to pickup the goods. MaxLength: 50.

Faxstring

MaxLength: 50. Obsolete! - Not used

Emailstring

The Email to the place to pickup the goods. MaxLength: 255.

Latitudenumber(double)

The Latitude part of the location of the pickup. Can be used to calculate distances.

Longitudenumber(double)

The Longitude part of the location of the pickup. Can be used to calculate distances.

Distancenumber(double)

The Distance to the location of the pickup.

OpeningHoursArray of objects(OpeningHours)(OpeningHours)

A list of opening hours for the pickup.

IsSelectedboolean

Indicates if this is the selected DropPoint or not. Gets set by Storm.

{
  "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
}

Basket

Operations

Checkout

Operations

DeliveryMethods

Operations

InfoTypes

Operations

OnHand

Operations

OrderRequest

Operations

Payments

Operations

Promotions

Operations

Subscriptions

Operations