Price Books

Price catalogs that assign a per-customer or per-segment list price to products and services.

Linking products & services. A price book relates to many products and services, and each link carries its own listprice. Manage links through the related-record write endpoints: POST /api/v1/pricebooks/{id}/related/products (and /services) to link an item with a price, PATCH …/related/products/{relatedId} to change the price, and DELETE …/related/products/{relatedId} to unlink. The same links are writable from the other side (POST /api/v1/products/{id}/related/pricebooks). Call GET /api/v1/pricebooks/related-modules to discover which relations are writable and the attributes they accept.

Reading linked prices. GET /api/v1/pricebooks/{id}/related/products returns each linked product with a relation_attributes block containing its listprice and the book's usedcurrency.

Resolving an applicable price. When listing or searching price books you may filter by these synthetic fields to find the books that apply and read back the resolved price:

  • filter[product_id] / filter[service_id] — restrict to books that contain that catalog item, and add a read-only resolved_listprice to each returned price book.
  • filter[qty] — restrict to books whose quantity range covers that quantity.
  • filter[when] — an ISO-8601 date; restrict to books whose start/end window covers that date.