Skip to main content

​
Read Methods

All read methods are available to both standalone and quoting_extension tool types.

​
context.get()

Returns the current user and tenant context. 
const ctx = await window.pipeline.context.get();
// Returns:
// {
//   userName: "Jane Smith",
//   userEmail: "jane@example.com",
//   userRole: "H_Admin",
//   tenantName: "Acme Corp",
//   tenantId: "abc-123",
//   cultureCode: "en-NZ"
// }

​
customers.list(options?)

Returns a paginated list of customers. 
const result = await window.pipeline.customers.list({ page: 1, pageSize: 50 });
// Returns:
// {
//   items: [{ id: "...", name: "John Doe", email: "john@example.com", phone: "021..." }],
//   totalCount: 150,
//   page: 1,
//   pageSize: 50
// }

​
products.list(options?)

Returns a paginated list of products/services. The sku field is the human-readable product code from Stock_SKU.SKU — use this for stable cross-environment product references (GUIDs can vary between environments). 
const result = await window.pipeline.products.list({ page: 1, pageSize: 50 });
// Returns:
// {
//   items: [
//     { id: "a1b2c3d4-...", sku: "WGT-001", name: "Widget A", price: 29.99, unit: "T_ITEM" }
//   ],
//   totalCount: 42,
//   page: 1,
//   pageSize: 50
// }
Response item fields: id (GUID), sku (human-readable code), name, price (retail sell price), unit (UOM token).

​
taskTemplates.list(options?)

Returns task templates from G_Task_Templates, filtered to active rows in the current tenant. Use this to resolve a task template’s code (e.g. T_DEFAULT_INSTALLATION_TASK) to its GUID so the GUID can be passed as linkedItemId on a lineType: "task" line in quotes.addLines. When codes is provided, page/pageSize are ignored and all matching rows are returned. When codes is omitted, results paginate the full active task-template list. 
const result = await window.pipeline.taskTemplates.list({
  codes: ["T_DEFAULT_INSTALLATION_TASK", "T_DEFAULT_REMOVAL_TASK"]
});
// Returns:
// {
//   items: [
//     { id: "8a9d034f-...", code: "T_DEFAULT_INSTALLATION_TASK", name: "T_DEFAULT_INSTALLATION_TASK" }
//   ],
//   totalCount: 2,
//   page: 1,
//   pageSize: 50
// }
Request fields: codes (string[], optional), page (number, optional), pageSize (number, optional). Response item fields: id (GUID), code (stable token), name.

​
costItems.list(options?)

Returns cost-of-business items from COB_Items, filtered to active rows in the current tenant. Use this to resolve a COB item’s code (e.g. COS-TRAVEL-TIME, COS-SITE-VISIT) to its GUID for use as linkedItemId on a lineType: "cost" line. 
const result = await window.pipeline.costItems.list({
  codes: ["COS-TRAVEL-TIME", "COS-SITE-VISIT", "COS-SHIPPING", "COS-DISPOSAL"]
});
// Returns:
// {
//   items: [
//     { id: "95abe0dc-...", code: "COS-TRAVEL-TIME", name: "Travel time", type: "T_TRAVEL" }
//   ],
//   totalCount: 4,
//   page: 1,
//   pageSize: 50
// }
Request fields: codes (string[], optional), page (number, optional), pageSize (number, optional). Response item fields: id (GUID), code (stable token), name, type (COB_Items.T_Type token, e.g. "T_FINANCIAL", "T_TRAVEL").

​
jobs.list(options?)

Returns a paginated list of active jobs for the tenant. Available to all tool types. 
const result = await window.pipeline.jobs.list({ page: 1, pageSize: 50 });
// Returns:
// {
//   items: [
//     {
//       id: "e5f6a7b8-...",
//       ref: "JOB-0042",
//       customerName: "Acme Corp",
//       customerIdGuid: "c1d2e3f4-...",
//       status: "InProgress"
//     }
//   ],
//   totalCount: 12,
//   page: 1,
//   pageSize: 50
// }
Response item fields: id (GUID), ref (human-readable job reference), customerName, customerIdGuid (GUID), status.

​
quotes.list(options?)

Returns a paginated list of quotes. 
const result = await window.pipeline.quotes.list({ page: 1, pageSize: 50 });
// Returns:
// {
//   items: [{ id: "...", ref: "QR-001", customerName: "John Doe", total: 115.00, status: "Draft", date: "2026-04-16T00:00:00" }],
//   totalCount: 25,
//   page: 1,
//   pageSize: 50
// }

​
Write Methods

​
quotes.create(request)

Creates a new quote in Pipeline. Available to all tool types. Marketplace tools do NOT need API keys or inbound tokens — the bridge handles all authentication through the current user’s Pipeline session. 
const result = await window.pipeline.quotes.create({
  customerName: "John Doe",
  customerEmail: "john@example.com",
  customerPhone: "021 123 4567",
  upsertByEmail: true,
  title: "Quick Quote",
  quoteRef: "",
  lines: [
    {
      description: "Widget A",
      productCode: "WGT-001",
      qty: 2,
      unitPrice: 29.99,
      taxRate: 0.15
    }
  ]
});
// Returns:
// {
//   id: "abc-123-...",
//   ref: "QR-042",
//   total: 68.98
// }
Request fields:
FieldTypeRequiredDescription
customerNamestringNoCustomer display name
customerEmailstringConditionalRequired when upsertByEmail is true
customerPhonestringNoCustomer phone number
upsertByEmailbooleanNoIf true, creates or matches customer by email
titlestringNoQuote title
quoteRefstringNoCustom quote reference
linesarrayYesAt least one line item required
Line item fields:
FieldTypeRequiredDescription
descriptionstringNoLine item description
productCodestringNoProduct code reference
qtynumberYesQuantity (1-10000)
unitPricenumberYesUnit price (0-1000000)
taxRatenumberYesTax rate as decimal (e.g. 0.15 for 15%)
Validation rules:
  • Lines array must not be empty
  • Maximum 200 line items per quote
  • Quantity must be > 0 and <= 10,000
  • Unit price must be >= 0 and <= 1,000,000

​
quotes.addLines(lines)

Available to quoting_extension tools only. Appends one or more lines to the currently-open quote. No server round-trip — the host merges the lines into its in-memory quote and the user saves normally. Calling this method from a standalone tool will return an error. 
await window.pipeline.quotes.addLines([
  // Product line (default lineType): generic SKU, with section grouping
  {
    description: "Roller blind — Main Lounge",
    productCode: "BLIND",
    qty: 1,
    unitPrice: 480.00,
    costPrice: 290.00,
    taxRate: 15,
    location: "Main Lounge",
    specification: "Linesque Fleece, 1200×1500, Inside fit",
    unit: "T_ITEM",
    groupKey: "blind-1",
    lineType: "product",
    linkedItemId: "a1b2c3d4-...",   // Stock_SKU.IdGuid — replaces productId
    section: "Blinds"
  },
  // Task line: explicit installation task
  {
    description: "Installation",
    qty: 1,
    unitPrice: 95.00,
    costPrice: 95.00,
    taxRate: 15,
    unit: "T_ITEM",
    lineType: "task",
    linkedItemId: "8a9d034f-...",   // G_Task_Templates.IdGuid
    section: "Installation"
  },
  // Cost line: shipping pass-through
  {
    description: "Shipping (standard)",
    qty: 1,
    unitPrice: 20.00,
    costPrice: 20.00,
    taxRate: 15,
    unit: "T_ITEM",
    lineType: "cost",
    linkedItemId: "eaaebd29-...",   // COB_Items.IdGuid
    section: "Extras"
  }
]);
BridgeAddLineDto fields:
FieldTypeRequiredDescription
descriptionstringoptionalFree-text line description. Displayed as the line name in the quote.
productCodestringoptionalHuman-readable SKU/code. Stored as WorkObjectCode on the quote line.
qtynumberrequiredLine quantity. Must be > 0.
unitPricenumberrequiredRetail/sell price per unit. Markup must already be applied — the host does not re-mark up.
costPricenumberoptionalBuy/cost price per unit. When provided: BUY column = costPrice, SELL column = unitPrice (real margin visible in COB panel). When omitted: both BUY and SELL use unitPrice.
taxRatenumberrequiredTax rate. Accepted as percentage (e.g. 15) or decimal fraction (e.g. 0.15) — the host normalises.
locationstringoptionalLocation or zone label. Maps to QuoteLine.FreeTextField2. Use for room, area, or zone labels (e.g. "Patio", "Living Room").
specificationstringoptionalConfiguration or specification detail. Maps to QuoteLine.FreeTextField. Use for dimensions, colours, or model info.
unitstringoptionalUnit of measure token. Valid values: "T_ITEM" (default), "T_SQUARE_METRE" (m²), "T_LINEAR_METRE" (lm).
groupKeystringoptionalArbitrary stable string identifier. Lines sharing the same groupKey receive the same QuoteLine.GroupId on the host, keeping related lines visually grouped within their section. Lines without a groupKey are ungrouped (GroupId = 0).
lineTypestringoptionalOne of "product" | "task" | "cost". Defaults to "product". Selects which Pipeline table linkedItemId resolves into — see “Three line kinds” below.
linkedItemIdstring (GUID)optionalGUID into Stock_SKU / G_Task_Templates / COB_Items based on lineType. Replaces productId for new tools. The whole addLines batch is rejected if the GUID does not resolve to an active row in the indicated table.
sectionstringoptionalCategorical section label (e.g. "Blinds", "Motorisation", "Installation", "Extras", "Removal"). Persisted on QuoteLine.Section. The host quote UI groups lines visually by section. Max 100 chars; trimmed; null/empty renders under “Ungrouped”.
productIdstring (GUID)deprecatedUse linkedItemId with lineType="product" instead. Retained for back-compat with Ziptrak v2.1.2 and earlier. When set without linkedItemId, behaves as linkedItemId with lineType="product" — triggers task-sequence auto-injection if the SKU has one configured.
Three line kinds (lineType → linkedItemId target table):
lineTypeTarget tableBehaviour
"product" (default)Stock_SKU.IdGuidIf the linked SKU has a task sequence configured, the host auto-injects its task template lines (e.g. installation tasks).
"task"G_Task_Templates.IdGuidThe line is the task. No auto-injection. Use taskTemplates.list to resolve codes to GUIDs.
"cost"COB_Items.IdGuidThe line is a cost-of-business item (shipping, travel, disposal, etc.). No auto-injection. Use costItems.list to resolve codes to GUIDs.
Validation: the host rejects the entire addLines batch if any line has an unknown lineType, a section longer than 100 chars, or a linkedItemId that does not resolve to an active row in the indicated table. Failures surface to the extension as an exception from addLines.