getLineItems

WARNING: This method is planned to be deprecated in a future API version. Likely to be replaced by getWorkflowParameters.

The getLineItems method can be used to access information about the line items to be processed by the CUWO.

The method is defined as:

/**
 * Returns information about the line item(s) for the custom workflow.
 */
public getLineItems() : string<DataList<LineItem>>

The return value is a string holding the NFON-serialization of a DataList of LineItem structures.

This structure has the following form:

[
    {
        "@type" : "n4.cuwo.callbacks.lineitems.LineItem",
        "id" : "...",
        "product" : null,               // n4.apis.shared.ProductReference
        "lot" : null,                   // n4.apis.shared.LotReference
        "quantity" : null,              // n4.model.common.Quantity
        "basePriceAndQuantity" : null,  // n4.apis.shared.ProductPriceAndQuantity
        "dependency" : null,            // n4.apis.basket.items.LineItemDependency
        "extraChargeType" : null,       // n4.apis.shared.ExtraChargeType
        "externalID" : "...",
        "externalData" : "...",
    },
    // ...
]

The method is only available for the CUWOs:

• AssembleProduct
• CancelLineItem
• RefundLineItem