COMMERCE SERVICES
/
Shopping Service
/
Schemas
/
ExtraInfo

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
Languages
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

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

File

Idinteger or null(int32)

The internal id of the File.

Typeinteger or null(int32)

The type id of the File. Depending on context and Client. Can be used by Applications to differentiate files for different usages.

Namestring or null

The Name of the File.

Descriptionstring or null

The Description of the File.

Keystring or null(uuid)

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

{
  "Id": 0,
  "Type": 0,
  "Name": "string",
  "Description": "string",
  "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd"
}