v1

latestOpenAPI 3.0.1Apache 2.02026-07-26193304444.4 KB
Price Books

Update a single price book

Update a price book by ID

🔒 Requires: products:write:price_books customers:read scopes

put/price_books/{id}

Path parameters

idstring required

The price book id

Request body

customer_group_idsstring[] required
namestring required

Price Book name.

outlet_idsstring[] required
restrict_to_platformstring nullable

"0" - all platforms, "1" - in store, "2" - ecommerce.

valid_fromstring nullable

The date when the Price Book becomes valid (active).

valid_tostring nullable

The date when the Price Book becomes invalid (inactive).

Response