Get Quote Catalog

GET

/quote-catalog

• Production
• QA

The product catalog the quote builder picks from: active, quotable products with price, cost and category.

flat and search return {items, total, page, limit}; grouped returns {groups, total, truncated} (unpaged, capped at 2,000 rows). search without q is a 422.

Authorizations

• BearerAuth

Parameters

Query Parameters

mode

Flat (paged), grouped (by category) or search.

string

default: flat

Allowed values: flat grouped search

Flat (paged), grouped (by category) or search.

q

Any of:

string

string

<= 200 characters

null

null

Search text (name or SKU). Required for mode=search.

category

Any of:

string

string

<= 100 characters

null

null

region

Any of:

string

string

<= 40 characters

null

null

Region code for the price multiplier.

page

integer

default: 1 >= 1

limit

integer

default: 100 >= 1 <= 500

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Responses

200

Successful Response

object

data

required

An open envelope for a quote, template, contact or job result.

object

key

additional properties

any

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

notes

Any of:

Array<string>

Array<string>

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

total_available

Any of:

integer

integer

null

null

total_is_lower_bound

Any of:

boolean

boolean

null

null

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string