# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand. overlay: 1.0.0 info: title: API Evangelist conversational phrasing for 2026-07 Price Books API version: 1.0.0 extends: openapi/lightspeed-price-books-api-openapi.yml actions: - target: $.info update: x-apievangelist-phrasing: method: generated generated: '2026-09-26' generator: build-phrasing.py label: Generated by API Evangelist operations: 10 - target: $.paths['/price_book_products'].get update: x-apievangelist-phrasing: intent: List price book products across all books effect: read questions: - Which products have special prices across all my price books? - Can I page through every price book entry in the store at once? instructions: - text: List all price book product entries across every price book. - text: Show price book products after cursor {after}. slots: after: query.after method: generated generated: '2026-09-26' - target: $.paths['/price_books'].get update: x-apievangelist-phrasing: intent: List price books effect: read questions: - What price books do I have set up for customer groups and outlets? - Can I find the price books that apply to one customer group? - Is there a way to include deleted price books in the list? instructions: - text: List price books for customer group {group}. slots: group: query.customer_group_id - text: List price books with the deleted filter set to {deleted}. slots: deleted: query.deleted method: generated generated: '2026-09-26' - target: $.paths['/price_books'].post update: x-apievangelist-phrasing: intent: Create a price book effect: write questions: - How do I create special pricing for a customer group at certain outlets? - Can a price book be valid only between two dates? instructions: - text: Create price book {name} for customer groups {groups} at outlets {outlets}. slots: name: requestBody.name groups: requestBody.customer_group_ids outlets: requestBody.outlet_ids - text: Create price book {name} for groups {groups} and outlets {outlets}, valid from {from} to {to}. slots: name: requestBody.name groups: requestBody.customer_group_ids outlets: requestBody.outlet_ids from: requestBody.valid_from to: requestBody.valid_to method: generated generated: '2026-09-26' - target: $.paths['/price_books/{id}'].get update: x-apievangelist-phrasing: intent: Get a single price book effect: read questions: - Which outlets and customer groups does a specific price book cover? - Can I check when a price book starts and stops being valid? instructions: - text: Get price book {id}. slots: id: path.id - text: Show the validity dates of price book {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/price_books/{id}'].put update: x-apievangelist-phrasing: intent: Update a price book's settings effect: write questions: - Can I rename a price book or change which outlets it applies to? - How do I extend the end date of an existing price book? instructions: - text: Rename price book {id} to {name}. slots: id: path.id name: requestBody.name - text: Change price book {id} to end on {to}. slots: id: path.id to: requestBody.valid_to method: generated generated: '2026-09-26' - target: $.paths['/price_books/{price_book_id}/products'].get update: x-apievangelist-phrasing: intent: List products in one price book effect: read questions: - What prices does a particular price book set for its products? - Are the retail prices returned from a price book tax inclusive or exclusive? instructions: - text: List the products in price book {book}. slots: book: path.price_book_id - text: Show price book {book} prices for products {products}. slots: book: path.price_book_id products: query.product_ids method: generated generated: '2026-09-26' - target: $.paths['/price_books/{price_book_id}/products'].put update: x-apievangelist-phrasing: intent: Update price book products with PUT effect: write questions: - Is there a PUT version of the call that updates products in a price book? - How many price book products can one PUT update carry? instructions: - text: Use PUT to update products {entries} in price book {book}. slots: entries: requestBody.data book: path.price_book_id - text: Send a PUT replacing the price entries of price book {book} with {entries}. slots: book: path.price_book_id entries: requestBody.data method: generated generated: '2026-09-26' - target: $.paths['/price_books/{price_book_id}/products'].post update: x-apievangelist-phrasing: intent: Add products to a price book effect: write questions: - How do I put new products with special prices into a price book? - Can I add up to 100 products to a price book in one request? instructions: - text: Add products {entries} to price book {book}. slots: entries: requestBody.data book: path.price_book_id - text: Create new price entries {entries} in price book {book}. slots: entries: requestBody.data book: path.price_book_id method: generated generated: '2026-09-26' - target: $.paths['/price_books/{price_book_id}/products'].delete update: x-apievangelist-phrasing: intent: Remove products from a price book effect: destructive questions: - Can I remove some products from a price book without deleting the book? - What is the limit on price book entries I can delete in one call? instructions: - text: Remove entries {entries} from price book {book}. slots: entries: requestBody.data book: path.price_book_id - text: Delete product price entries from price book {book}. slots: book: path.price_book_id method: generated generated: '2026-09-26' - target: $.paths['/price_books/{price_book_id}/products'].patch update: x-apievangelist-phrasing: intent: Patch price book products effect: write questions: - Can I PATCH the prices of products already in a price book? - Does patching price book products accept tax-inclusive prices for a tax-inclusive store? instructions: - text: Patch the product prices {entries} in price book {book}. slots: entries: requestBody.data book: path.price_book_id - text: Use PATCH to change existing entries in price book {book} to {entries}. slots: book: path.price_book_id entries: requestBody.data method: generated generated: '2026-09-26'