Typescript SDK Type Docs
    Preparing search index...

    Interface RecurringOrderDraft

    Recurring Orders are automatically assigned the Store and/or Business Unit from the associated Cart.

    interface RecurringOrderDraft {
        cart: CartResourceIdentifier;
        cartVersion: number;
        custom?: CustomFieldsDraft;
        expiresAt?: string;
        key?: string;
        startsAt?: string;
        state?: StateResourceIdentifier;
    }
    Index

    Properties

    cart cartVersion custom? expiresAt? key? startsAt? state?

    Properties

    cart: CartResourceIdentifier

    ResourceIdentifier to the Cart from which the RecurringOrder is created.

    cartVersion: number

    Current version of the referenced Cart.

    custom?: CustomFieldsDraft

    Custom Fields for the RecurringOrder.

    expiresAt?: string

    Date and time (UTC) when the RecurringOrder will expire.

    key?: string

    User-defined unique identifier of the RecurringOrder.

    startsAt?: string

    Date and time (UTC) when the RecurringOrder will start. When specified, the date and time must be in the future. If not specified, the recurring order will start immediately.

    state?: StateResourceIdentifier

    State for the RecurringOrder in a custom workflow.

    Settings

    Member Visibility

    On This Page

    Properties