Quote Line Items List | Pricefx Knowledge Base

The quote_line_items_list tool returns one Quote with its status, customer, and a link, and, for each line item, the product, quantity, unit of measure, and calculated prices. Use the line Id from the result to get the full pricing breakdown of one line item with the Quote Get Line Item Detail tool.

Tool Name – quote_line_items_list

Title – Quote Line Items List

Type – Private

Access Profile – Operator

Permissions

The quote_line_items_list tool uses your Pricefx permissions. You can retrieve line-item information only for Quotes that you have permission to view.

For a Quote restricted by User Group (View Details), the quote_line_items_list tool returns an error if you are not a member of the assigned user group. The error message starts with The backend refused the request: and includes the reasoning message, for example Quote restricted by user group.

Parameters

Parameter	Required	Description
`id`	Yes, if `unique_name` and `label` are not given	Quote Id, as a number (1493) or a typed Id (1493.Q).
`unique_name`	Yes, if `id` and `label` are not given	Quote unique name, for example P-1493.
`label`	Yes, if `id` and `unique_name` are not given	Text that the Quote label contains. The search is not case-sensitive. If the text matches several Quotes, the tool returns an error that lists their unique names.
`max_line_items`	No	Maximum number of line items the tool returns. Default: 5. A value of 0 or less uses the default.

Output

Quote Fields

Field	Description
Typed Id	Quote Id with its type suffix, for example 1493.Q.
Unique Name	Quote unique name, for example P-1493.
Label	Quote label.
Customer Id / Customer Name	Customer on the Quote.
Quote Status	Quote status, for example Draft, Offer, or Deal.
Workflow Status	Approval workflow status, for example Approved.
Create Date / Created By	When the Quote was created and by which user.
Last Update Date / Last Updated By	When the Quote was last changed and by which user.
Link	Link that opens the Quote in Pricefx.
Number of Line Items	Total number of line items in the Quote, not counting folders. If this number is larger than the number of returned line items, the list was cut short.

Line Item Fields

Field	Description
Line Id	Identifier of the line item within the Quote. Use this value to get the line item details with the `quote_get_line_item_detail` tool.
SKU	SKU of the product on the line item.
Label	Name of the product on the line item.
Quantity	Quoted quantity of the product.
Unit of Measure	Unit of the quoted quantity.
Prices	Calculated prices of the line item, named by the labels configured in the Quote type, for example List Price or Net Price.

Behavior and Limitations

The tool looks up the Quote in this order: id, then unique_name, then label. It uses the first value that finds a Quote.
The tool returns the first line items, in the order they appear in the Quote.
Folders in the Quote are not counted or returned as line items.
The tool has no line item filters and no validity date. To filter line items by product, quantity, or price, or to get a Quote valid on a specific date, use the quote_get_calculated_price tool.
The tool does not return the Quote header prices. To get them, use the quote_get_calculated_price tool.
Quantity and Unit of Measure are empty when the Quote type has no line item input with a matching name. The tool looks for inputs named like Quantity, Qty, or Volume, and Unit of Measure or UoM.
Prices includes only money outputs that have "Price" in their name or label. Discounts, costs, and margins are not included.