put

/pricelists/{price_list_id}

Updates a Price List.

Authorization

apiKey - X-Auth-Client
apiKey - X-Auth-Token

Request Parameters

1 Path Parameter

Request Body

1 Example
Schema
object

Update a PriceList

name
string

The unique name of the Price List. Required in /POST.

2 validations + required
active
boolean

Whether or not this Price List and its prices are active. Defaults to true.

1 validation

Responses

1 Example
Schema
object

PriceList Reponse returns for:

  • Create a PriceList
  • Get a PriceList
  • Update a PriceList
data
object

Common Price List properties.

meta
object

Empty meta object; may be used later.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
price_list_id
$$.env
2 variables not set
store_hash
X-Auth-Client
X-Auth-Token