Documentation ShoppingService (1.1)

Entities and methods to handle baskets and payments.

Download OpenAPI description

openapi.json

openapi.yaml

Servers

https://customer-slug.api-se.norce.tech/commerce/shopping/1.1/

Schemas

SubscriptionScheduleData

FrequenciesArray of objects(IdValue)(IdValue)

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

MonthlyIntervalsArray of objects(IdValue)(IdValue)

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

MonthlyIntervalValuesArray of objects(IdValue)(IdValue)

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

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

SubscriptionType

Idinteger(int32)

A internal id for this type.

Codestring

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

Namestring

The name of the type. MaxLength: 50.

Descriptionstring

A description of the type. MaxLength: 500.

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

Itemsobject(SummaryItem)(SummaryItem)

Freigtobject(SummaryItem)(SummaryItem)

Feesobject(SummaryItem)(SummaryItem)

Totalobject(SummaryItem)(SummaryItem)

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

Basket

Operations

Checkout

Operations

DeliveryMethods

Operations

InfoTypes

Operations

OnHand

Operations

OrderRequest

Operations

Payments

Operations

Promotions

Operations

Subscriptions

Operations