List products to add to an estimate

Searches the company's active product catalog for products to add to an estimate. Each product carries the unit_price it would be added at, priced from its current cost for the property's service area plus the company's margin. On the first page, alternates lists the products the estimate's kit offers as swaps for items already on it.

Results are paginated (25 per page by default, up to 100), and filter_options lists the category, type and variant values you can filter by. Add the products you choose with POST /estimates/{id}/add_line_items.

The token's role must be allowed to edit this estimate.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Query Params
string

Text to match against the product's name, SKU or nickname.

integer

The page to return, starting at 1.

integer

How many products to return per page. Defaults to 25, at most 100.

categories[]
array of strings

Only return products in these categories. Repeat the parameter for several.

categories[]
types[]
array of strings

Only return products of these product types. Repeat the parameter for several.

types[]
variant_names[]
array of strings

Only return products that have a variant with one of these names. Repeat the parameter for several.

variant_names[]
Response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json