Update a single price book

post deprecated

https://{domain_prefix}.retail.lightspeed.app/api/2.0/price_books/{price_book_id}

DEPRECATED This endpoint has a 3.0 equivalent. We recommend using that instead, which now uses PUT method.

Update a price book by ID

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

price_book_id

string

required

The price book id

Body Params

name

string

required

Price Book name.

customer_group_id

string

required

The ID of the customer group

string

Auto-generated object ID.

valid_from

string | null

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

valid_to

string | null

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

restrict_to_platform_key

string | null

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

outlet_id

string | null

The ID of an outlet for which the Price Book should be used.+ type: GENERAL (string) - Internal value. Safe to ignore.

restrict_to_platform_label

string | null

One of In Store, Ecommerce, All Platforms.

customer_group

object

version

int64

Auto-incrementing object version number.

deleted_at

string | null

Deletion timestamp in UTC.

created_at

string

Created timestamp in UTC.

updated_at

string

Updated timestamp in UTC.

outlet

object

Response

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200