Added

Quoter API - Distributors, Product Cloud, quote editing and sending


Summary

You can now manage your distributor connections, search the product catalog, look up a product and check distributor pricing and availability through the API. Quotes, sections and line items can be edited and deleted, a quote can be sent by email, and images can be uploaded for use on quotes. The API major version remains v1.

The reference also documents existing quote behavior that clients generated from the previous reference should handle: the quote owner's id can be null, and the quote list filters use the eq: and in: operator syntax. See Changed below.


Changes

New endpoints

Distributors

  • GET /v1/distributors

    • N/A → Available
    • Type: addition
    • Notes: Lists your account's distributor connections, with cursor pagination, filters, sorting and fields. Credentials are never returned.
  • POST /v1/distributors

    • N/A → Available
    • Type: addition
    • Notes: Connects a distributor with its credentials. Credentials are write-only.
  • GET /v1/distributors/{distributor_id}

    • N/A → Available
    • Type: addition
    • Notes: Fetches one distributor connection. Credentials are never returned.
  • PATCH /v1/distributors/{distributor_id}

    • N/A → Available
    • Type: addition
    • Notes: Updates a distributor connection's label, credentials or enabled flag. Only the fields you send change.
  • DELETE /v1/distributors/{distributor_id}

    • N/A → Available
    • Type: addition
    • Notes: Removes a distributor connection. Price and availability checks stop using it immediately.

Product Cloud

  • POST /v1/product-cloud/search

    • N/A → Available
    • Type: addition
    • Notes: Searches the product catalog by keyword. Each result carries the distributor SKUs known for it, and the response includes filter options to narrow the search. Results are paginated with cursor.
  • POST /v1/product-cloud/product-lookup

    • N/A → Available
    • Type: addition
    • Notes: Returns one product by its manufacturer part number.
  • POST /v1/product-cloud/pna

    • N/A → Available
    • Type: addition
    • Notes: Checks price and availability for up to 10 of your distributor connections in one request, using the stored credentials.

Quotes

  • PATCH /v1/quotes/{quote_id}

    • N/A → Available
    • Type: addition
    • Notes: Updates a quote.
  • DELETE /v1/quotes/{quote_id}

    • N/A → Available
    • Type: addition
    • Notes: Deletes a quote.
  • PATCH /v1/quotes/{quote_id}/sections/{section_id}

    • N/A → Available
    • Type: addition
    • Notes: Updates a quote section.
  • DELETE /v1/quotes/{quote_id}/sections/{section_id}

    • N/A → Available
    • Type: addition
    • Notes: Deletes a quote section.
  • DELETE /v1/quotes/{quote_id}/sections/{section_id}/line-items/{line_item_id}

    • N/A → Available
    • Type: addition
    • Notes: Removes a line item from a section.
  • POST /v1/quotes/{quote_id}/send

    • N/A → Available
    • Type: addition
    • Notes: Emails the quote. Returns 202 with the quote while the email is queued; email.status reports delivery as it progresses.

Files

  • POST /v1/files/images
    • N/A → Available
    • Type: addition
    • Notes: Uploads an image and returns its public URL, for example to use as a quote's cover page background.

Changed

  • POST /v1/quotes

    • New optional request fields; more response fields; owner.id nullable
    • Type: change
    • Notes: Accepts a cover_page object, content_blocks, billing_address, initiative_id, and first_name, last_name and organization on the contact. The returned quote now documents account, email, initiative_id, integration, recurring_interval, stage, urls and won_at, and each line item documents integration and recurring_interval. owner.id is null when the quote owner has no linked ScalePad user; this documents existing behavior, so regenerate clients that treat it as always present.
  • GET /v1/quotes

    • Filter syntax documented; unsupported filters → 400
    • Type: change
    • Notes: filter[draft], filter[primary] and filter[email_status] take eq:<value>, and filter[stage] takes in:<values>. filter[email_status] also accepts processing, and the new filter[include_drafts] returns draft quotes alongside filter[primary]. A filter on an unsupported field or with an unsupported operator returns 400.
  • GET /v1/quotes/{quote_id}

    • More response fields; owner.id nullable
    • Type: change
    • Notes: The returned quote now documents account, email, initiative_id, integration, recurring_interval, stage, urls and won_at, and each line item documents integration and recurring_interval. owner.id is null when the quote owner has no linked ScalePad user; this documents existing behavior, so regenerate clients that treat it as always present.
  • POST /v1/quotes/{quote_id}/publish

    • More response fields; owner.id nullable
    • Type: change
    • Notes: The returned quote now documents account, email, initiative_id, integration, recurring_interval, stage, urls and won_at, and each line item documents integration and recurring_interval. owner.id is null when the quote owner has no linked ScalePad user; this documents existing behavior, so regenerate clients that treat it as always present.
  • POST /v1/quotes/{quote_id}/sections

    • More response fields; owner.id nullable
    • Type: change
    • Notes: The returned quote now documents account, email, initiative_id, integration, recurring_interval, stage, urls and won_at, and each line item documents integration and recurring_interval. owner.id is null when the quote owner has no linked ScalePad user; this documents existing behavior, so regenerate clients that treat it as always present.
  • POST /v1/quotes/{quote_id}/sections/{section_id}/line-items

    • New optional request field; more response fields; owner.id nullable
    • Type: change
    • Notes: Each line item accepts integration to record the external record it is linked to. The returned quote now documents account, email, initiative_id, integration, recurring_interval, stage, urls and won_at, and each line item documents integration and recurring_interval. owner.id is null when the quote owner has no linked ScalePad user; this documents existing behavior, so regenerate clients that treat it as always present.
  • PATCH /v1/quotes/{quote_id}/sections/{section_id}/line-items/{line_item_id}

    • New optional request field; more response fields; owner.id nullable
    • Type: change
    • Notes: Accepts integration to record the external record the line item is linked to. The returned quote now documents account, email, initiative_id, integration, recurring_interval, stage, urls and won_at, and each line item documents integration and recurring_interval. owner.id is null when the quote owner has no linked ScalePad user; this documents existing behavior, so regenerate clients that treat it as always present.
  • GET /v1/categories

    • Unsupported filters → 400
    • Type: change
    • Notes: A filter on an unsupported field or with an unsupported operator returns 400.
  • GET /v1/contacts

    • Unsupported filters → 400
    • Type: change
    • Notes: A filter on an unsupported field or with an unsupported operator returns 400.
  • GET /v1/item-group-item-assignments

    • Unsupported filters → 400
    • Type: change
    • Notes: A filter on an unsupported field or with an unsupported operator returns 400.
  • GET /v1/item-groups

    • Unsupported filters → 400
    • Type: change
    • Notes: A filter on an unsupported field or with an unsupported operator returns 400.
  • GET /v1/item-option-values

    • Unsupported filters → 400
    • Type: change
    • Notes: A filter on an unsupported field or with an unsupported operator returns 400.
  • GET /v1/item-options

    • Unsupported filters → 400
    • Type: change
    • Notes: A filter on an unsupported field or with an unsupported operator returns 400.
  • GET /v1/item-tiers

    • Unsupported filters → 400
    • Type: change
    • Notes: A filter on an unsupported field or with an unsupported operator returns 400.
  • GET /v1/items

    • Unsupported filters → 400
    • Type: change
    • Notes: A filter on an unsupported field or with an unsupported operator returns 400.
  • GET /v1/manufacturers

    • Unsupported filters → 400
    • Type: change
    • Notes: A filter on an unsupported field or with an unsupported operator returns 400.
  • GET /v1/quote-templates

    • Unsupported filters → 400
    • Type: change
    • Notes: A filter on an unsupported field or with an unsupported operator returns 400. The endpoint no longer documents a 422.
  • GET /v1/suppliers

    • Unsupported filters → 400
    • Type: change
    • Notes: A filter on an unsupported field or with an unsupported operator returns 400.

Deprecated

  • POST /v1/quotes
    • cover_page_title, cover_page_subtitle and cover_page_content available → deprecated, sunset November 30, 2027
    • Type: deprecation
    • Notes: Send the same values inside cover_page instead. The flat fields keep working until the sunset date.

Dates

  • Effective: [2026-11-06]