Interface Order

Represents an order with various properties and methods for order operations.

interface Order {
    AdditionalData: string;
    AddOrderNotes: ((note: string, displayToCustomer?: boolean) => boolean);
    AssignedDepartmentId?: number;
    BillingAddress: Address;
    Cancel: ((notifyCustomer: boolean, notifyMis: boolean) => boolean);
    CaptureOrder: (() => boolean);
    CheckoutAttributes: any;
    CreatedOnUtc: Date;
    CustomData1: string;
    CustomerId: number;
    CustomTag1: string;
    CustomTag2: string;
    CustomTag3: string;
    CustomTag4: string;
    DeliverBy: Date;
    DispatchBy: Date;
    ExtraData: any;
    GetInvoice: ((keyValues?: object) => FileInstance);
    GetPackingSlip: ((keyValues?: object) => FileInstance);
    Id: number;
    ImpersonatingUserId: number;
    OrderLineItems: OrderProductVariant[];
    OrderNotes: string[];
    OrderStatus: string;
    PaymentStatus: string;
    SetExtraData: ((key: string, value: string) => void);
    SetStatus: ((status: string) => boolean);
    SetTrackingNumber: ((trackingNumber: string) => boolean);
    ShippingAddress: Address;
    ShippingMethod: string;
    ShippingStatus: string;
    TrackingNumber: string;
    UpdateCustomData: ((keyValues: object) => ResultObject);
    UpdatePaymentStatus: ((paymentStatus: string) => boolean);
    UpdateShippingStatus: ((shippingStatus: string) => boolean);
    UrlForCustomer: string;
}

Properties

AdditionalData AddOrderNotes AssignedDepartmentId? BillingAddress Cancel CaptureOrder CheckoutAttributes CreatedOnUtc CustomData1 CustomerId CustomTag1 CustomTag2 CustomTag3 CustomTag4 DeliverBy DispatchBy ExtraData GetInvoice GetPackingSlip Id ImpersonatingUserId OrderLineItems OrderNotes OrderStatus PaymentStatus SetExtraData SetStatus SetTrackingNumber ShippingAddress ShippingMethod ShippingStatus TrackingNumber UpdateCustomData UpdatePaymentStatus UpdateShippingStatus UrlForCustomer

Properties

AdditionalData

AdditionalData: string

Gets or sets additional data for the order.

AddOrderNotes

AddOrderNotes: ((note: string, displayToCustomer?: boolean) => boolean)

Adds a note to the order.

Type declaration

    • (note, displayToCustomer?): boolean

    • Parameters

      • note: string

        The note to be added to the order.

      • OptionaldisplayToCustomer: boolean

        Optional. Indicates whether the note should be displayed to the customer.

      Returns boolean

      A boolean indicating success or failure of adding the note.

OptionalAssignedDepartmentId

AssignedDepartmentId?: number

Gets or sets the assigned department ID for the order.

BillingAddress

BillingAddress: Address

Gets or sets the billing address of the order.

Cancel

Cancel: ((notifyCustomer: boolean, notifyMis: boolean) => boolean)

Cancels the order.

Type declaration

    • (notifyCustomer, notifyMis): boolean

    • Parameters

      • notifyCustomer: boolean

        Whether to notify the customer about the cancellation.

      • notifyMis: boolean

        Whether to notify MIS about the cancellation. Returns true if the cancellation was successful, false otherwise.

      Returns boolean

CaptureOrder

CaptureOrder: (() => boolean)

Captures the order. Returns true if the capture was successful, false otherwise.

CheckoutAttributes

CheckoutAttributes: any

Gets or sets the checkout attributes for the order.

CreatedOnUtc

CreatedOnUtc: Date

Gets or sets the UTC creation date and time of the order.

CustomData1

CustomData1: string

Gets or sets custom data 1 for the order.

CustomerId

CustomerId: number

Gets or sets the customer ID associated with the order.

CustomTag1

CustomTag1: string

Gets or sets custom tag 1 for the order.

CustomTag2

CustomTag2: string

Gets or sets custom tag 2 for the order.

CustomTag3

CustomTag3: string

Gets or sets custom tag 3 for the order.

CustomTag4

CustomTag4: string

Gets or sets custom tag 4 for the order.

DeliverBy

DeliverBy: Date

Gets or sets the delivery by date and time for the order.

DispatchBy

DispatchBy: Date

Gets or sets the dispatch by date and time for the order.

ExtraData

ExtraData: any

Gets or sets extra data for the order.

GetInvoice

GetInvoice: ((keyValues?: object) => FileInstance)

Gets the invoice for the order.

Type declaration

    • (keyValues?): FileInstance

    • Parameters

      • OptionalkeyValues: object

        Optional key-values parameter for additional options. Returns a FileInstanceObject representing the invoice.

      Returns FileInstance

GetPackingSlip

GetPackingSlip: ((keyValues?: object) => FileInstance)

Gets the packing slip for the order.

Type declaration

    • (keyValues?): FileInstance

    • Parameters

      • OptionalkeyValues: object

        Optional key-values parameter for additional options. Returns a FileInstanceObject representing the packing slip.

      Returns FileInstance

Id

Id: number

Gets or sets the ID of the order.

ImpersonatingUserId

ImpersonatingUserId: number

Gets or sets the ID of the impersonating user for the order.

OrderLineItems

OrderLineItems: OrderProductVariant[]

Gets or sets the order line items.

OrderNotes

OrderNotes: string[]

Gets or sets the order notes.

OrderStatus

OrderStatus: string

Gets or sets the status of the order.

PaymentStatus

PaymentStatus: string

Gets or sets the payment status of the order.

SetExtraData

SetExtraData: ((key: string, value: string) => void)

Sets or updates the extra data for the order.

Type declaration

    • (key, value): void

    • Parameters

      • key: string

        The key of the extra data.

      • value: string

        The value of the extra data. If null, the extra data is deleted.

      Returns void

SetStatus

SetStatus: ((status: string) => boolean)

Sets the status of the order.

Type declaration

    • (status): boolean

    • Parameters

      • status: string

        The new status to set. Returns true if the update was successful, false otherwise.

      Returns boolean

SetTrackingNumber

SetTrackingNumber: ((trackingNumber: string) => boolean)

Sets the tracking number for the order.

Type declaration

    • (trackingNumber): boolean

    • Parameters

      • trackingNumber: string

        The tracking number to set. Returns true if the update was successful, false otherwise.

      Returns boolean

ShippingAddress

ShippingAddress: Address

Gets or sets the shipping address of the order.

ShippingMethod

ShippingMethod: string

Gets or sets the shipping method for the order.

ShippingStatus

ShippingStatus: string

Gets or sets the shipping status of the order.

TrackingNumber

TrackingNumber: string

Gets or sets the tracking number for the order.

UpdateCustomData

UpdateCustomData: ((keyValues: object) => ResultObject)

Updates the custom data for the order.

Type declaration

    • (keyValues): ResultObject

    • Parameters

      • keyValues: object

        Key-values parameter representing the custom data to update. Returns a ResultObject representing the result of the update.

      Returns ResultObject

UpdatePaymentStatus

UpdatePaymentStatus: ((paymentStatus: string) => boolean)

Updates the payment status of the order.

Type declaration

    • (paymentStatus): boolean

    • Parameters

      • paymentStatus: string

        The new payment status. Returns true if the update was successful, false otherwise.

      Returns boolean

UpdateShippingStatus

UpdateShippingStatus: ((shippingStatus: string) => boolean)

Updates the shipping status of the order.

Type declaration

    • (shippingStatus): boolean

    • Parameters

      • shippingStatus: string

        The new shipping status. Returns true if the update was successful, false otherwise.

      Returns boolean

UrlForCustomer

UrlForCustomer: string

Gets or sets the URL for the customer to view the order.

Settings

Member Visibility

On This Page

Properties