COMMERCE SERVICES

Shopping Service

Payment

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

OpeningHours

Dayinteger or null(int32)

Enum0123456

Openstring or null

Closestring or null

{
  "Day": 0,
  "Open": "string",
  "Close": "string"
}

Payment

Represents a single payment attempt for this basket.

PaymentCodeinteger or null(int32)

System generated id for this particular payment. Client specific.

Amountnumber or null(decimal)

Payment amount, including VAT.

CardNostring or null

Card number if payment has been made by credit card or gift card. Populated by PSP.

PaymentMethodIdinteger or null(int32)

Internal id of the payment method for this payment. Application specific.

PaymentServiceIdinteger or null(int32)

Internal id of the payment service for this payment. System specific. Indicates the PSP.

{
  "PaymentCode": 0,
  "Amount": 0,
  "CardNo": "string",
  "PaymentMethodId": 0,
  "PaymentServiceId": 0
}

PaymentMethod

Represents a specific payment method in Norce. A PSP may be represented with multiple payment methods. Application specific.

Idinteger or null(int32)

Internal id for this payment method.

Namestring or null

Descriptive name of the payment method.

TypeIdinteger or null(int32)

Internal type id for this payment method.

TypeNamestring or null

Clear text name of the type of this payment method.

Descriptionstring or null

Free text description of the payment method.

PartNostring or null

Part number for this payment method, if configured.

Pricenumber or null(decimal)

Price, excluding VAT, to use this payment method, if configured.

VatRatenumber or null(decimal)

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

IsSelectedboolean or null

Indicates if this is the currently selected payment method for the Checkout. Only one may have this flag set to true. Use UpdatePaymentMethod3 to set this property.

Serviceobject or null

Represents a way of payment. A client may have several payment methods using the same service. A PSP may offer several payment services.

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 this payment method is only allowed for companies. Cannot be combined with IsForPersonOnly.

IsForPersonOnlyboolean or null

Indicates if this payment method is only allowed for persons. Cannot be combined with IsForCompanyOnly.

ImagePathstring or nullDeprecated

{
  "Id": 0,
  "Name": "string",
  "TypeId": 0,
  "TypeName": "string",
  "Description": "string",
  "PartNo": "string",
  "Price": 0,
  "VatRate": 0,
  "ImagePath": "string",
  "IsSelected": true,
  "Service": {
    "Id": 0,
    "Name": "string",
    "Description": "string",
    "ImagePath": "string",
    "ImageKey": "9afa8b7e-ca15-438f-a9d6-f679c437e59c"
  },
  "ImageKey": "9afa8b7e-ca15-438f-a9d6-f679c437e59c",
  "IsForCompanyOnly": true,
  "IsForPersonOnly": true
}