HomeTutorialsAPI ReferenceChangelog
Log In
API Reference

Update a single price book

put
https://{domain_prefix}.retail.lightspeed.app/api/3.0/price_books/

Update a price book by ID

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The price book id

Body Params
string
required

Price Book name.

customer_group_ids
array of strings
required
customer_group_ids*
outlet_ids
array of strings
outlet_ids
string | null

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

string | null

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

string | null

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

Response

Updated 5 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?