COMMERCE SERVICES

Shopping Service

SubscriptionType

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

SubscriptionScheduleData

General data for scheduling Subscriptions. Data can be used to populate drop lists with values needed when creating SubscriptionSchedules.

FrequenciesArray of objects or null(IdValue)

A list of frequencies. Defines how often should a Subscription should produce an order. See SubscriptionSchedule for usage.

MonthlyIntervalsArray of objects or null(IdValue)

A list of intervals used together with MonthlyIntervalValues. See SubscriptionSchedule for usage.

MonthlyIntervalValuesArray of objects or null(IdValue)

A list of interval values used together with MonthlyIntervals. See SubscriptionSchedule for usage.

{
  "Frequencies": [
    { … }
  ],
  "MonthlyIntervals": [
    { … }
  ],
  "MonthlyIntervalValues": [
    { … }
  ]
}

SubscriptionType

A SubscriptionType specified for the application. Used by Subscription. SubscriptionTypes are created in Norce Admin.

Idinteger or null(int32)

A internal id for this type.

Codestring or null

An external code use to identify this type. Used when creating Subscription.

Namestring or null

The name of the type.

Descriptionstring or null

A description of the type.

EndDatestring or null(date-time)

An optional end date for the SubscriptionType. Subscriptions created for this SubscriptionType can not have an end date later than this.

{
  "Id": 0,
  "Code": "string",
  "Name": "string",
  "Description": "string",
  "EndDate": "2019-08-24T14:15:22Z"
}

Summary

The Summary is a grouping of BasketItem totals. This can be used to display summaries for a Basket.

Itemsobject or null

The SummaryItem is the summary used for each item in Summary.

Freigtobject or null

The SummaryItem is the summary used for each item in Summary.

Feesobject or null

The SummaryItem is the summary used for each item in Summary.

Totalobject or null

The SummaryItem is the summary used for each item in Summary.

{
  "Items": {
    "Amount": 0,
    "Vat": 0,
    "AmountIncVat": 0
  },
  "Freigt": {
    "Amount": 0,
    "Vat": 0,
    "AmountIncVat": 0
  },
  "Fees": {
    "Amount": 0,
    "Vat": 0,
    "AmountIncVat": 0
  },
  "Total": {
    "Amount": 0,
    "Vat": 0,
    "AmountIncVat": 0
  }
}