Pricebooks

Search for pricebook items across multiple pricebooks

This endpoint allows you to search for products/items across one or more supplier pricebooks using a text-based search query. The search is performed across item names, product codes, and search values.

Search Behavior:

  • Searches match when the search term appears anywhere within searchable fields (substring matching)
  • Results are ranked by relevance (exact matches and word-start matches ranked higher)
  • Pagination uses cursor-based navigation with encoded ranking information

allSuppliers

When allSuppliers is provided and set to true, it will override the list of supplierIds array.

For example the below payload will search across all suppliers for the term "hammer" and apply the pricing tier with id 123:

{
  "search": "hammer",
  "pricingTierId": 123,
  "allSuppliers": true,
  "supplierIds": [
    101,
    102,
    103
  ]
}

To narrow search by specific suppliers, set allSuppliers to false and provide a list of supplier IDs:

{
  "search": "hammer",
  "pricingTierId": 123,
  "allSuppliers": false,
  "supplierIds": [
    101,
    102,
    103
  ]
}
post/pricebooks/search

Query parameters

pageSizeinteger
'asc'
OR
'desc'
pageCursorstring

Request body

searchstring required

Search term for pricebook items (minimum 3 characters). Searches across:

  • name - Product or item name
  • productCode - Product identification code
  • supplierSku - Supplier SKU/part number
pricingTierIdnumber

Filter results to show prices for a specific pricing tier ID. If not provided, the default pricing tier will be used

allSuppliersboolean

When true (default), searches across all supplier pricebooks. When false, only searches pricebooks specified in supplierIds

supplierIdsnumber[]

Array of supplier/pricebook IDs to limit the search scope. Only used when allSuppliers is false

Example request

{
  "search": "hammer",
  "pricingTierId": 123,
  "supplierIds": [
    101,
    102,
    103
  ]
}

Response

Successful Response

resultstring required

Example response

{
  "data": [
    {
      "unitType": "each"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.