Interface RecurringOrder

Represents a recurring order that automates the reordering process for a customer.

interface RecurringOrder {
    businessUnit?: BusinessUnitKeyReference;
    cart: CartReference;
    createdAt: string;
    createdBy?: CreatedBy;
    custom?: CustomFields;
    customer?: CustomerReference;
    customerEmail?: string;
    expiresAt?: string;
    id: string;
    key?: string;
    lastModifiedAt: string;
    lastModifiedBy?: LastModifiedBy;
    lastOrderAt?: string;
    nextOrderAt?: string;
    originOrder?: OrderReference;
    recurringOrderState: RecurringOrderState;
    resumesAt?: string;
    schedule: RecurrencePolicySchedule;
    skipConfiguration?: SkipConfiguration;
    startsAt: string;
    state?: StateReference;
    version: number;
}

Hierarchy (View Summary)

Properties

businessUnit? cart createdAt createdBy? custom? customer? customerEmail? expiresAt? id key? lastModifiedAt lastModifiedBy? lastOrderAt? nextOrderAt? originOrder? recurringOrderState resumesAt? schedule skipConfiguration? startsAt state? version

Properties

Optional ReadonlybusinessUnit

businessUnit?: BusinessUnitKeyReference

Reference to a Business Unit the RecurringOrder belongs to.

Readonlycart

cart: CartReference

Reference to the Cart for a RecurringOrder.

ReadonlycreatedAt

createdAt: string

Optional ReadonlycreatedBy

createdBy?: CreatedBy

IDs and references that created the RecurringOrder.

Optional Readonlycustom

custom?: CustomFields

Custom Fields of the RecurringOrder.

Optional Readonlycustomer

customer?: CustomerReference

The Customer that the RecurringOrder belongs to.

Optional ReadonlycustomerEmail

customerEmail?: string

Email address of the Customer that the RecurringOrder belongs to.

Optional ReadonlyexpiresAt

expiresAt?: string

Date and time (UTC) the RecurringOrder expires.

Readonlyid

id: string

Unique identifier of the RecurringOrder.

Optional Readonlykey

key?: string

User-defined unique identifier for the RecurringOrder.

ReadonlylastModifiedAt

lastModifiedAt: string

Optional ReadonlylastModifiedBy

lastModifiedBy?: LastModifiedBy

IDs and references that last modified the RecurringOrder.

Optional ReadonlylastOrderAt

lastOrderAt?: string

Date and time (UTC) when the last order was created from this RecurringOrder.

Optional ReadonlynextOrderAt

nextOrderAt?: string

Date and time (UTC) when the next order will be created from this RecurringOrder.

Optional ReadonlyoriginOrder

originOrder?: OrderReference

Reference to the Order that generated this RecurringOrder.

ReadonlyrecurringOrderState

recurringOrderState: RecurringOrderState

Current state of the RecurringOrder.

Optional ReadonlyresumesAt

resumesAt?: string

Date and time (UTC) the RecurringOrder resumes subsequent order creation after it is unpaused.

Readonlyschedule

schedule: RecurrencePolicySchedule

Schedule of the RecurringOrder.

Optional ReadonlyskipConfiguration

skipConfiguration?: SkipConfiguration

Information about current and future skips of this RecurringOrder.

ReadonlystartsAt

startsAt: string

Date and time (UTC) the RecurringOrder starts creating new orders.

Optional Readonlystate

state?: StateReference

State of the RecurringOrder in a custom workflow.

Readonlyversion

version: number

Current version of the RecurringOrder.

Settings

Member Visibility

On This Page

Properties