getLineItemInfo

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

The getLineItemInfo method can be used to access information about the line item to be processed by the CUWO.

The method is defined as:

/**
 * Returns information about the line item for the custom workflow.
 */
public getLineItemInfo() : string<LineItemInfo>

The return value is a string holding the NFON-serialization of a LineItemInfo structure.

This structure has the following form:

{
    "@type" : "n4.cuwo.LineItemInfo",
    "enforeID" : "...",
    "externalID" : "...",
    "type" : null,            // n4.metacompany.jobs.LineItemType
    "name" : "...",
    "product" : null,         // n4.cuwo.ProductInfo
    "totalPriceNet" : null,   // n4.model.common.Money
    "totalPriceGross" : null, // n4.model.common.Money
    "pricePerUnit" : null,    // n4.model.common.Money
    "quantityUnit" : null,    // n4.model.common.Quantity
    "priceIsGross" : true,
    "externalData" : "...",
    "requiresCustomCancelFlow" : false,
    "requiresCustomRefundFlow" : false,
}

The method is only available for the CUWOs:

  • AssembleProduct
  • CancelLineItem
  • RefundLineItem