Interface OrderEditDraft

interface OrderEditDraft {
    comment?: string;
    custom?: CustomFieldsDraft;
    dryRun?: boolean;
    key?: string;
    resource: OrderReference;
    stagedActions?: StagedOrderUpdateAction[];
}

Index

Properties

comment? custom? dryRun? key? resource stagedActions?

Properties

`Optional` `Readonly` comment

comment?: string

This field can be used to add additional textual information regarding the edit.

`Optional` `Readonly` custom

custom?: CustomFieldsDraft

The custom fields.

`Optional` `Readonly` dryRun

dryRun?: boolean

When set to true the edit is applied on the Order without persisting it.

`Optional` `Readonly` key

key?: string

User-defined unique identifier for the OrderEdit.

`Readonly` resource

resource: OrderReference

The order to be updated with this edit.

`Optional` `Readonly` stagedActions

stagedActions?: StagedOrderUpdateAction[]

The actions to apply to resource.

Generated using TypeDoc