scheduledOrderId

The repository ID of the scheduled order. Note, this is not the ID of the scheduled order template, but the ID of the scheduled order item.

name

The name of the scheduled order.

scheduleType

The type of scheduled order. Values can be either calendar or interval.

startDate

The start date used for the order.

endDateOption

Options that can be set for the end date of the scheduled order. The options include none, afterOccurrences or endBy.

numberOfOccurances

This parameter is used with the afterOccurances option to calculate the end date of the scheduled order.

endDate

The end date of the scheduled order. Used with the endBy parameter.

daysOption

This calendar property sets the delivery days of the scheduled order. The options for this property are allDays, selectedDays and selectedDates.

selectedDays

An integer array of selected days, for example, “2,4” indicate Monday and Wednesday. Values start at 1, indicating Sunday, and end with 7, indicating Saturday.

selectedDates

An integer array of values between 1 and 31.

occurrencesOption

Identifies the occurrence of the scheduled order. Options are allOccurrences or selectedOccurrences. Occurrences are configurable when using selectedDays.

selectedOccurrences

An integer array for occurrences of the scheduled order. Options are:

1 – First
2 – Second
3 – Third
4 – Fourth
5 – Last

Use this parameter with selectedDays to identify specific occurrences within a month.

monthsOption

Allows you to select specific months, selectedMonths, or to use all months, allMonths, for the scheduled order.

selectedMonths

Sets the delivery months of the scheduled orders. Values are 0 – 11, which indicate January – December.

selectedHours

Identifies the selected hours in an integer array. Values are 0 – 23, where 0 indicates 12:00, and 23 indicates 23:00 or 11:00 p.m.

selectedMinutes

Identifies the selected minutes in an integer array. Values are 0 – 59.

selectedInterval

Identifies the interval option for the schedule. Selected intervals are used when creating a periodic schedule. When daysOption parameters reference this parameter, it is used for creating calendar schedules.

intervalOption

Indicates the interval option, which is either weeks or days. Selected intervals are used when creating a periodic schedule. When daysOption parameters reference this parameter, it is used for creating calendar schedules.