Interface OrderProductVariant

Interface representing an order product variant object. Provides properties and methods to manage details and actions related to an order product variant.

interface OrderProductVariant {
    AdminComment: string;
    Attributes: {
        [key: string]: string;
    };
    AttributeSummary: string;
    Cancel: (() => boolean);
    ClearJobFolder: ((deleteStatus: number) => void);
    CreateBackup: (() => FileInstance);
    CustomData1: string;
    CustomData2: string;
    CustomTag1: string;
    CustomTag2: string;
    CustomTag3: string;
    CustomTag4: string;
    DeliveryType: ProductDeliveryType[];
    ExtraData: {
        [key: string]: string;
    };
    GetBackup: (() => FileInstance);
    GetInvoice: ((keyValues?: any) => FileInstance);
    GetJobTicket: ((keyValues?: any) => FileInstance);
    GetLatestStatus: (() => JobStatus);
    GetOutputFile: (() => FileInstance);
    GetPackingSlip: ((keyValues?: any) => FileInstance);
    GetPreviewFile: ((page?: number) => FileInstance);
    GetStatusHistory: (() => string[]);
    HasBackup: (() => boolean);
    Height: number;
    History: any[];
    Id: number;
    IsCancelled: boolean;
    JobId: string;
    JobProcessingFolderPath: string;
    Length: number;
    LoadMetaData: ((metaDataToLoad?: number) => JobMetaDataInstanceObject);
    Name: string;
    NumberOfRecords: number;
    NumPages: number;
    OrderId: number;
    OrderProductStatus: string;
    PONumber: string;
    PriceExclTax: number;
    PriceInclTax: number;
    ProcessingType: string;
    Product: Product;
    ProductName: string;
    ProductTags: string[];
    Quantity: number;
    Quote: any;
    ReleaseQuoteResources: (() => void);
    Remove: ((statusObject: JobStatus) => boolean);
    RemoveBackup: (() => void);
    SetCustomHiddenStatus: ((status: string, description: string) => void);
    SetCustomStatus: ((status: string, description: string) => void);
    SetExtraData: ((key: string, value: string) => void);
    SetOutputFile: ((file: FileInstance) => OutputResult);
    SetQuantity: ((quantity: number) => boolean);
    SetStatus: ((status: string, description: string) => void);
    ShippedQuantity: number;
    ShortDescription: string;
    Sku: string;
    SpecificationAttributes: {
        [key: string]: string;
    };
    Type: string;
    TypeLetter: string;
    UnitPriceExclTax: number;
    UnitPriceInclTax: number;
    UpdateCustomData: ((keyValues: any) => ResultObject);
    Weight: number;
    Width: number;
}

Hierarchy (view full)

Properties

AdminComment Attributes AttributeSummary Cancel ClearJobFolder CreateBackup CustomData1 CustomData2 CustomTag1 CustomTag2 CustomTag3 CustomTag4 DeliveryType ExtraData GetBackup GetInvoice GetJobTicket GetLatestStatus GetOutputFile GetPackingSlip GetPreviewFile GetStatusHistory HasBackup Height History Id IsCancelled JobId JobProcessingFolderPath Length LoadMetaData Name NumberOfRecords NumPages OrderId OrderProductStatus PONumber PriceExclTax PriceInclTax ProcessingType Product ProductName ProductTags Quantity Quote ReleaseQuoteResources Remove RemoveBackup SetCustomHiddenStatus SetCustomStatus SetExtraData SetOutputFile SetQuantity SetStatus ShippedQuantity ShortDescription Sku SpecificationAttributes Type TypeLetter UnitPriceExclTax UnitPriceInclTax UpdateCustomData Weight Width

Properties

AdminComment

AdminComment: string

Admin comment associated with the order product variant.

Attributes

Attributes: {
    [key: string]: string;
}

Attributes associated with the product variant.

AttributeSummary

AttributeSummary: string

Summary of the attributes of the product variant.

Cancel

Cancel: (() => boolean)

Cancels the order product variant.

Type declaration

    • (): boolean

    • Returns boolean

      True if the cancellation was successful; otherwise, false.

ClearJobFolder

ClearJobFolder: ((deleteStatus: number) => void)

Clears the job folder associated with the order product variant.

Type declaration

    • (deleteStatus): void

    • Parameters

      • deleteStatus: number

        The delete status indicating what to clear.

      Returns void

CreateBackup

CreateBackup: (() => FileInstance)

Creates a backup of the output associated with the order product variant.

Type declaration

CustomData1

CustomData1: string

Custom data 1 associated with the order product variant.

CustomData2

CustomData2: string

Custom data 2 associated with the order product variant.

CustomTag1

CustomTag1: string

Custom tag 1 associated with the order product variant.

CustomTag2

CustomTag2: string

Custom tag 2 associated with the order product variant.

CustomTag3

CustomTag3: string

Custom tag 3 associated with the order product variant.

CustomTag4

CustomTag4: string

Custom tag 4 associated with the order product variant.

DeliveryType

DeliveryType: ProductDeliveryType[]

Array of delivery types associated with the order product variant.

ExtraData

ExtraData: {
    [key: string]: string;
}

Extra data associated with the order product variant.

GetBackup

GetBackup: (() => FileInstance)

Retrieves the backup file associated with the order product variant.

Type declaration

GetInvoice

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

Retrieves the invoice file associated with the order product variant.

Type declaration

    • (keyValues?): FileInstance

    • Parameters

      • OptionalkeyValues: any

        The key values for retrieving the invoice.

      Returns FileInstance

      The invoice file instance.

GetJobTicket

GetJobTicket: ((keyValues?: any) => FileInstance)

Retrieves the job ticket file associated with the order product variant.

Type declaration

    • (keyValues?): FileInstance

    • Parameters

      • OptionalkeyValues: any

        The key values for retrieving the job ticket.

      Returns FileInstance

      The job ticket file instance.

GetLatestStatus

GetLatestStatus: (() => JobStatus)

Retrieves the latest status of the order product variant.

Type declaration

GetOutputFile

GetOutputFile: (() => FileInstance)

Retrieves the output file associated with the order product variant.

Type declaration

GetPackingSlip

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

Retrieves the packing slip file associated with the order product variant.

Type declaration

    • (keyValues?): FileInstance

    • Parameters

      • OptionalkeyValues: any

        The key values for retrieving the packing slip.

      Returns FileInstance

      The packing slip file instance.

GetPreviewFile

GetPreviewFile: ((page?: number) => FileInstance)

Retrieves the preview file associated with the order product variant.

Type declaration

    • (page?): FileInstance

    • Parameters

      • Optionalpage: number

        The page number for preview.

      Returns FileInstance

      The preview file instance.

GetStatusHistory

GetStatusHistory: (() => string[])

Retrieves the status history of the order product variant.

Type declaration

    • (): string[]

    • Returns string[]

      Array of status objects representing the status history.

HasBackup

HasBackup: (() => boolean)

Checks if a backup exists for the order product variant.

Type declaration

    • (): boolean

    • Returns boolean

      True if a backup exists; otherwise, false.

Height

Height: number

Height of the order product variant.

History

History: any[]

History of the order product variant.

Id

Id: number

Identifier of the order product variant.

IsCancelled

IsCancelled: boolean

Indicates if the order product variant is cancelled.

JobId

JobId: string

Job ID associated with the order product variant.

JobProcessingFolderPath

JobProcessingFolderPath: string

Job processing folder path.

Length

Length: number

Length of the order product variant.

LoadMetaData

LoadMetaData: ((metaDataToLoad?: number) => JobMetaDataInstanceObject)

Loads metadata associated with the order product variant.

Type declaration

Name

Name: string

Name of the product variant.

NumberOfRecords

NumberOfRecords: number

Number of records associated with the order product variant.

NumPages

NumPages: number

Number of pages associated with the order product variant.

OrderId

OrderId: number

Gets or sets the ID of the order product variant.

OrderProductStatus

OrderProductStatus: string

Status of the order product.

PONumber

PONumber: string

Purchase order number associated with the order product variant.

PriceExclTax

PriceExclTax: number

Price excluding tax.

PriceInclTax

PriceInclTax: number

Price including tax.

ProcessingType

ProcessingType: string

Processing type of the order product variant.

Product

Product: Product

Product object associated with the order product variant.

ProductName

ProductName: string

Product name associated with the order product variant.

ProductTags

ProductTags: string[]

Tags associated with the product variant.

Quantity

Quantity: number

Quantity of the order product variant.

Quote

Quote: any

Quote associated with the order product variant.

ReleaseQuoteResources

ReleaseQuoteResources: (() => void)

Releases the quote resources associated with the order product variant.

Remove

Remove: ((statusObject: JobStatus) => boolean)

Removes a status from the order product variant.

Type declaration

    • (statusObject): boolean

    • Parameters

      • statusObject: JobStatus

        The status object to remove.

      Returns boolean

      True if the status was removed successfully; otherwise, false.

RemoveBackup

RemoveBackup: (() => void)

Removes the backup associated with the order product variant.

SetCustomHiddenStatus

SetCustomHiddenStatus: ((status: string, description: string) => void)

Sets a custom hidden status for the order product variant.

Type declaration

    • (status, description): void

    • Parameters

      • status: string

        The custom hidden status to set.

      • description: string

        The description associated with the custom hidden status.

      Returns void

SetCustomStatus

SetCustomStatus: ((status: string, description: string) => void)

Sets a custom status for the order product variant.

Type declaration

    • (status, description): void

    • Parameters

      • status: string

        The custom status to set.

      • description: string

        The description associated with the custom status.

      Returns void

SetExtraData

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

Sets or updates the extra data associated with the order product variant.

Type declaration

    • (key, value): void

    • Parameters

      • key: string

        The key of the extra data.

      • value: string

        The value of the extra data.

      Returns void

SetOutputFile

SetOutputFile: ((file: FileInstance) => OutputResult)

Sets the output file for the order product variant.

Type declaration

SetQuantity

SetQuantity: ((quantity: number) => boolean)

Sets the quantity of the order product variant.

Type declaration

    • (quantity): boolean

    • Parameters

      • quantity: number

        The quantity to set.

      Returns boolean

      True if the quantity was updated successfully; otherwise, false.

SetStatus

SetStatus: ((status: string, description: string) => void)

Sets the status of the order product variant.

Type declaration

    • (status, description): void

    • Parameters

      • status: string

        The status to set.

      • description: string

        The description associated with the status.

      Returns void

ShippedQuantity

ShippedQuantity: number

Shipped quantity of the order product variant.

ShortDescription

ShortDescription: string

Short description of the product variant.

Sku

Sku: string

Stock keeping unit (SKU) of the product variant.

SpecificationAttributes

SpecificationAttributes: {
    [key: string]: string;
}

Specification attributes associated with the product variant.

Type

Type: string

Type of the order product variant.

TypeLetter

TypeLetter: string

Type letter associated with the order product variant.

UnitPriceExclTax

UnitPriceExclTax: number

Unit price excluding tax.

UnitPriceInclTax

UnitPriceInclTax: number

Unit price including tax.

UpdateCustomData

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

Updates the custom data associated with the order product variant.

Type declaration

    • (keyValues): ResultObject

    • Parameters

      • keyValues: any

        The key-value pairs of custom data to update.

      Returns ResultObject

      The result object of the update operation.

Weight

Weight: number

Weight of the product variant.

Width

Width: number

Width of the order product variant.

Settings

Member Visibility

On This Page

Properties