Skip to content
COMMERCE SERVICES
/
Shopping Service
/
/
SubscriptionScheduleData

Documentation ShoppingService (1.1)

Entities and methods to handle baskets and payments.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
https://customer-slug.api-se.norce.tech/commerce/shopping/1.1/

Schemas

Schemas

SubscriptionSchedule

Idinteger or null(int32)

A unique internal id for this SubscriptionSchedule. When creating new schedules this should be left as null.

IsActiveboolean

Specifies if the schedule is active or not. Only active schedules are considered when creating orders.

Frequencyobject(IdValue)(IdValue)
RecurValueinteger(int32)

Specifies how often the Frequency should be applied. If Frequency is 'Daily' and RecurValue is 2 then the schedule is every second day.

IsOnMondayboolean

Specifies if the schedule should be applied on a Monday. Only used when Frequency is 'Weekly'. At least one of the IsOnDay values must be specified.

IsOnTuesdayboolean

Specifies if the schedule should be applied on a Tuesday. Only used when Frequency is 'Weekly'. At least one of the IsOnDay values must be specified.

IsOnWednesdayboolean

Specifies if the schedule should be applied on a Wednesday. Only used when Frequency is 'Weekly'. At least one of the IsOnDay values must be specified.

IsOnThursdayboolean

Specifies if the schedule should be applied on a Thursday. Only used when Frequency is 'Weekly'. At least one of the IsOnDay values must be specified.

IsOnFridayboolean

Specifies if the schedule should be applied on a Friday. Only used when Frequency is 'Weekly'. At least one of the IsOnDay values must be specified.

IsOnSaturdayboolean

Specifies if the schedule should be applied on a Saturday. Only used when Frequency is 'Weekly'. At least one of the IsOnDay values must be specified.

IsOnSundayboolean

Specifies if the schedule should be applied on a Sunday. Only used when Frequency is 'Weekly'. At least one of the IsOnDay values must be specified.

MonthlyDayinteger(int32)

Specifies if the schedule should be applied on a specific day. Only used when Frequency is 'Monthly' and not any of the MonthlyInterval values are used.

MonthlyIntervalobject(IdValue)(IdValue)
MonthlyIntervalValueobject(IdValue)(IdValue)
TimeOfDaystring

Specifies at what time the schedule should be applied. Just the Hours and Minutes parts are used. Formats 'hh:mm.ss' or 'hh:mm'.

{
  "Id": 0,
  "IsActive": true,
  "Frequency": {
    "Id": 0,
    "Value": "string",
    "Code": "string"
  },
  "RecurValue": 0,
  "IsOnMonday": true,
  "IsOnTuesday": true,
  "IsOnWednesday": true,
  "IsOnThursday": true,
  "IsOnFriday": true,
  "IsOnSaturday": true,
  "IsOnSunday": true,
  "MonthlyDay": 0,
  "MonthlyInterval": {
    "Id": 0,
    "Value": "string",
    "Code": "string"
  },
  "MonthlyIntervalValue": {
    "Id": 0,
    "Value": "string",
    "Code": "string"
  },
  "TimeOfDay": "string"
}

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

Basket

Operations

Checkout

Operations

DeliveryMethods

Operations

InfoTypes

Operations

OnHand

Operations

OrderRequest

Operations

Payments

Operations

Promotions

Operations

Subscriptions

Operations