v55

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

Create price books

Create or replace existing price books with support for hierarchical pricing structures.

<h3>Creating Base Price Books</h3>

Base price books are the foundation of your pricing hierarchy:

  • Required Fields: priceBookId, name, currency
  • Currency Definition: Sets the currency for the entire branch of child price books
  • No Parent: Base price books cannot reference a parent price book
  • Unique ID: Must have a unique priceBookId across all price books
<h3>Creating Child Price Books</h3>

Child price books inherit from their parent and can extend the hierarchy:

  • Required Fields: priceBookId, name, parentId
  • Parent Reference: Must reference an existing parent price book
  • Currency Inheritance: Automatically inherits currency from parent
  • Hierarchy Depth: Can create up to 3 levels of nesting
<h3>Hierarchy Management</h3>
  • Parent Assignment: Once a parentId is assigned, it cannot be changed via update operations
  • Restructuring: To change parent-child relationships, delete and recreate the child price book
  • Validation: The system validates parent references and hierarchy depth limits

Use the update price books operation to modify existing price book names or base price book currencies.

post/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.