@gradientedge/commercetools-utils
    Preparing search index...

    Interface RecurringOrder

    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?: Counter;
        startsAt: string;
        state?: StateReference;
        store?: StoreKeyReference;
        version: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    businessUnit?: BusinessUnitKeyReference

    Reference to the Business Unit that the RecurringOrder belongs to.

    cart: CartReference

    Reference to the Cart for a RecurringOrder. The referenced Cart will have the RecurringOrder CartOrigin.

    createdAt: string

    Date and time (UTC) when the RecurringOrder was created.

    createdBy?: CreatedBy

    IDs and references that created the RecurringOrder.

    custom?: CustomFields

    Custom Fields of the RecurringOrder.

    customer?: CustomerReference

    The Customer that the RecurringOrder belongs to.

    customerEmail?: string

    Email address of the Customer that the RecurringOrder belongs to.

    expiresAt?: string

    Date and time (UTC) when the RecurringOrder expires.

    id: string

    Unique identifier of the RecurringOrder.

    key?: string

    User-defined unique identifier of the RecurringOrder.

    lastModifiedAt: string

    Date and time (UTC) when the RecurringOrder was last updated.

    lastModifiedBy?: LastModifiedBy

    IDs and references that last modified the RecurringOrder.

    lastOrderAt?: string

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

    nextOrderAt?: string

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

    originOrder: OrderReference

    Reference to the original Order that generated this RecurringOrder. This field is automatically populated when the RecurringOrder is created via the Create Order from Cart endpoint and the Cart contains Line Items with defined recurrenceInfo. When the RecurringOrder is created directly via the Create RecurringOrder endpoint, this field remains empty.

    recurringOrderState: RecurringOrderState

    Current state of the RecurringOrder.

    resumesAt?: string

    Date and time (UTC) when the RecurringOrder resumes creating Orders after being unpaused.

    schedule: RecurrencePolicySchedule

    Schedule of the RecurringOrder.

    skipConfiguration?: Counter

    Information about current and future skips for this RecurringOrder.

    startsAt: string

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

    state?: StateReference

    State of the RecurringOrder in a custom workflow.

    store?: StoreKeyReference

    Reference to a Store.

    version: number

    Current version of the RecurringOrder.

    Settings

    Member Visibility

    On This Page

    Properties