Interface OrderEdit

interface OrderEdit {
    comment?: string;
    createdAt: string;
    createdBy?: CreatedBy;
    custom?: CustomFields;
    id: string;
    key?: string;
    lastModifiedAt: string;
    lastModifiedBy?: LastModifiedBy;
    resource: OrderReference;
    result: OrderEditResult;
    stagedActions: StagedOrderUpdateAction[];
    version: number;
}

Hierarchy (View Summary)

Properties

comment? createdAt createdBy? custom? id key? lastModifiedAt lastModifiedBy? resource result stagedActions version

Properties

Optional Readonlycomment

comment?: string

User-defined information regarding the Order Edit.

ReadonlycreatedAt

createdAt: string

Date and time (UTC) the Order Edit was initially created.

Optional ReadonlycreatedBy

createdBy?: CreatedBy

IDs and references that created the OrderEdit.

Optional Readonlycustom

custom?: CustomFields

Custom Fields of the Order Edit.

Readonlyid

id: string

Unique identifier of the Order Edit.

Optional Readonlykey

key?: string

User-defined unique identifier of the Order Edit.

ReadonlylastModifiedAt

lastModifiedAt: string

Date and time (UTC) the Order Edit was last updated.

Optional ReadonlylastModifiedBy

lastModifiedBy?: LastModifiedBy

IDs and references that last modified the OrderEdit.

Readonlyresource

resource: OrderReference

Reference to the Order updated with this edit.

Readonlyresult

result: OrderEditResult

For applied edits, it's a summary of the changes on the Order. For unapplied edits, it's a preview of the changes.

ReadonlystagedActions

stagedActions: StagedOrderUpdateAction[]

Update actions applied to the Order referenced by resource.

Readonlyversion

version: number

Current version of the Order Edit.

Settings

Member Visibility

On This Page

Properties