Typescript SDK Type Docs
    Preparing search index...

    Interface RecurringOrderFailedMessage

    Generated after a RecurringOrder failed to process an Order.

    interface RecurringOrderFailedMessage {
        cartId: string;
        createdAt: string;
        createdBy?: CreatedBy;
        errors?: RecurringOrderFailureError[];
        failedAt: string;
        failureReason: string;
        id: string;
        lastModifiedAt: string;
        lastModifiedBy?: LastModifiedBy;
        orderScheduledAt: string;
        resource: Reference;
        resourceUserProvidedIdentifiers?: UserProvidedIdentifiers;
        resourceVersion: number;
        sequenceNumber: number;
        type: "RecurringOrderFailed";
        version: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    cartId createdAt createdBy? errors? failedAt failureReason id lastModifiedAt lastModifiedBy? orderScheduledAt resource resourceUserProvidedIdentifiers? resourceVersion sequenceNumber type version

    Properties

    cartId: string

    ID of the Cart used in the failed Order creation attempt.

    createdAt: string

    Date and time (UTC) the Message was generated.

    createdBy?: CreatedBy

    IDs and references that created the Message.

    errors?: RecurringOrderFailureError[]

    Errors due to which the Order creation failed.

    failedAt: string

    Date and time (UTC) when the Order creation attempt failed.

    failureReason: string

    Description of why the Order creation failed, such as insufficient stock.

    id: string

    Unique identifier of the Message. Can be used to track which Messages have been processed.

    lastModifiedAt: string

    Value of createdAt.

    lastModifiedBy?: LastModifiedBy

    IDs and references that last modified the Message.

    orderScheduledAt: string

    Date and time (UTC) the Order was scheduled to be created.

    resource: Reference

    Reference to the resource on which the change or action was performed.

    resourceUserProvidedIdentifiers?: UserProvidedIdentifiers

    User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

    resourceVersion: number

    Version of the resource on which the change or action was performed.

    sequenceNumber: number

    Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

    type: "RecurringOrderFailed"

    Message Type of the Message.

    version: number

    Version of a resource. In case of Messages, this is always 1.

    Settings

    Member Visibility

    On This Page

    Properties