v55

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-012046146.0 KB
Price Books

Update price books

Update existing price books with limitations on hierarchical changes.

<h3>Updatable Fields</h3>
  • Name: Can be updated for both base and child price books
  • Currency: Can only be updated for base price books (affects entire hierarchy)
  • Parent ID: Cannot be updated - use delete and recreate to change hierarchy
<h3>Update Restrictions</h3>
  • Parent Assignment: Cannot change parentId via update operations
  • Hierarchy Changes: To restructure the hierarchy, delete and recreate child price books
  • Currency Inheritance: Child price books automatically inherit currency changes from parent
  • Validation: System validates that parentId references exist and hierarchy depth is maintained
<h3>Update Strategies</h3>
  • Base Price Books: Update name and currency as needed
  • Child Price Books: Include correct parentId in request (will be ignored if different)
  • Hierarchy Restructuring: Delete child price book and recreate with new parent reference

Note: Before submitting an update request, verify that the target entity exists by checking the available price books in Commerce Optimizer. Update operations do not verify that the entity exists. Requests targeting a nonexistent entity are accepted, but the update has no effect.

patch/v1/catalog/price-books

Headers

Content-Type'application/json' required
Authorizationstring required

Authorization Bearer token.

Content-Encoding'gzip'

Use this header if the payload is compressed with gzip.

Request body

Example request

[
  {
    "priceBookId": "us-base",
    "name": "US Base Pricing",
    "currency": "USD"
  }
]

Response

All items in the request are accepted for further processing.