Skip to main content
PATCH
/
v1
/
price-lists
/
{id}
Update Price List
curl --request PATCH \
  --url https://api.wizcommerce.com/v1/price-lists/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "Price List Name",
  "description": "Price List Description",
  "priority": 1,
  "status": "active",
  "is_default": false
}
'
{
  "data": {
    "id": "0c05a9a7-84ed-46f0-819b-653545730920",
    "reference_id": "PRC-20250101",
    "name": "Price List 1",
    "description": "Price List 1 Description",
    "status": "active",
    "currency": "USD",
    "created_at": "2025-01-01T00:00:00Z",
    "updated_at": "2025-01-01T00:00:00Z"
  }
}
The PATCH request is used to partially update an existing entity by the given id. This means:
  • Only the fields provided in the request body will be updated.
  • Fields not provided in the request body will remain unchanged.
  • The request is idempotent, meaning multiple identical PATCH requests will always result in the same final state.

Authorizations

​
X-API-Key
string
header
required

API Key for authentication

Path Parameters

​
id
string
required

ID

Body

application/json

Request

​
name
string
Maximum string length: 50
Example:

"Price List Name"

​
description
string
Maximum string length: 255
Example:

"Price List Description"

​
priority
integer
Example:

1

​
status
enum<string>
Available options:
active,
inactive
Example:

"active"

​
is_default
boolean
Example:

false

Response

desc

​
data
object