COMMERCE SERVICES

Shopping Service

DeliveryMethod

Norce Commerce Shopping v1.1 service (1.1)

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.

Download OpenAPI description

openapi-v1.json

openapi-v1.yaml

Servers

Playground

https://{slug}.api-se.playground.norce.tech/commerce/

Stage

https://{slug}.api-se.stage.norce.tech/commerce/

Production

https://{slug}.api-se.norce.tech/commerce/

Basket

Contains endpoints for manage baskets and their lifecycle, see more information here.

Operations

Checkout

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.

Operations

DeliveryMethods

Contains endpoints for viewing metadata about configured delivery methods, when using Norces internal shipping logic.

Operations

InfoTypes

Contains endpoints for viewing metadata for extended fields on the basket and basketitems.

Operations

OnHand

Contains endpoints for looking up availability on baskets.

Operations

OrderRequest

Contains endpoints for viewing orders snapshots.

Operations

Payments

Contains endpoints for legacy purchases, still used by older solutions and Non-PSP purchases.

Operations

Promotions

Contains endpoints for viewing more promotion information.

Operations

Schemas

DeliveryData

object(DeliveryData)

{}

DeliveryMethod

Represent a DeliveryMethod in Norce. DeliveryMethods can be specified in Norce Admin or fetch from integrated Delivery providers such as ShipAdvisor. Application specific.

Idinteger or null(int32)

The internal id of the DeliveryMethod.

Namestring or null

The Name of the DeliveryMethod.

TypeIdinteger or null(int32)

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

TypeNamestring or null

The TypeName of the DeliveryMethodType.

Descriptionstring or null

The Description of the DeliveryMethod.

PartNostring or null

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 Norce and added and removed automatically.

Pricenumber or null(decimal)

The Price of the DeliveryMethod, excluding VAT.

VatRatenumber or null(decimal)

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

IsNotifiableboolean or null

Indicates if the DeliveryMethod has delivery notifications.

IsSelectedboolean or null

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(uuid)

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 or null

Indicates if the DeliveryMethod has is for Companies only.

IsForPersonOnlyboolean or null

Indicates if the DeliveryMethod has is for Customers only.

Costnumber or null(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 Norce.

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 Norce.

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 Norce.

DropPointsArray of objects or null(DropPoint)

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

Codestring or null

An external Code for the DeliveryMethod.

Carrierstring or null

Optional information about carrier

ImagePathstring or nullDeprecated

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

DropPoint

The DropPoint entity represents a pickup place for deliveries. Only used for external or integrated DeliveryMethod providers.

Codestring or null

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

Name1string or null

The name of the place to pickup the goods.

Name2string or null

The name part 2 of the place to pickup the goods.

Address1string or null

The Address of the place to pickup the goods.

Address2string or null

The Address part 2 of the place to pickup the goods.

PostalCodestring or null

The ZipCode of the place to pickup the goods.

Citystring or null

The City of the place to pickup the goods.

CountryCodestring or null

The CountryCode of the place to pickup the goods.

Contactstring or null

The Contact of the place to pickup the goods.

Phonestring or null

The Phone to the place to pickup the goods.

Emailstring or null

The Email to the place to pickup the goods.

Latitudenumber or null(double)

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

Longitudenumber or null(double)

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

Distancenumber or null(double)

The Distance to the location of the pickup.

OpeningHoursArray of objects or null(OpeningHours)

A list of opening hours for the pickup.

IsSelectedboolean or null

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

RoutingCodestring or nullDeprecated

Depotstring or nullDeprecated

Faxstring or nullDeprecated

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