COMMERCE SERVICES

Shopping Service

ErrorMessage_v1_1

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

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
}

ErrorMessage_v1_1

Error message for version 1.1

MessageIdinteger or null(int32)

Unique identifier for the message.

Messagestring or null

The error message.

Orchestrationstring or null

Orchestration

TimeStampstring or null(date-time)

The time the error occurred.

Recordstring or null

An xml representation of Messages.

MessagesArray of objects or null(StringStringKeyValuePair)

A dictionary of additional messages or data related to the error.

{
  "MessageId": 0,
  "Message": "string",
  "Orchestration": "string",
  "TimeStamp": "2019-08-24T14:15:22Z",
  "Record": "string",
  "Messages": [
    { … }
  ]
}

ExtraInfo

Information carrying entity to convey customer specific information from the basket to the order, PSP et.al.

TypeIdinteger or null(int32)

The internal id of type. This TypeId might be different in different tiers such as Stage and Production. Use Code if hard coding is required.

Valuestring or null

The Value of the Entity.

Codestring or null

The Code of the type, if existing. Use this value when hard coding is required.

{
  "TypeId": 0,
  "Value": "string",
  "Code": "string"
}