Update Price List

Update Price List

PATCH /v1/price-lists/{id}

Update Price List

cURL

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
}
'

import requests

url = "https://api.wizcommerce.com/v1/price-lists/{id}"

payload = {
    "name": "Price List Name",
    "description": "Price List Description",
    "priority": 1,
    "status": "active",
    "is_default": False
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Price List Name',
    description: 'Price List Description',
    priority: 1,
    status: 'active',
    is_default: false
  })
};

fetch('https://api.wizcommerce.com/v1/price-lists/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.wizcommerce.com/v1/price-lists/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Price List Name',
    'description' => 'Price List Description',
    'priority' => 1,
    'status' => 'active',
    'is_default' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.wizcommerce.com/v1/price-lists/{id}"

	payload := strings.NewReader("{\n  \"name\": \"Price List Name\",\n  \"description\": \"Price List Description\",\n  \"priority\": 1,\n  \"status\": \"active\",\n  \"is_default\": false\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.wizcommerce.com/v1/price-lists/{id}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Price List Name\",\n  \"description\": \"Price List Description\",\n  \"priority\": 1,\n  \"status\": \"active\",\n  \"is_default\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.wizcommerce.com/v1/price-lists/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Price List Name\",\n  \"description\": \"Price List Description\",\n  \"priority\": 1,\n  \"status\": \"active\",\n  \"is_default\": false\n}"

response = http.request(request)
puts response.read_body

201

{
  "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"
  }
}

{
  "code": "<string>",
  "message": "<string>",
  "details": [
    {
      "field": "<string>",
      "reason": "<string>"
    }
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "details": [
    {
      "field": "<string>",
      "reason": "<string>"
    }
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "details": [
    {
      "field": "<string>",
      "reason": "<string>"
    }
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "details": [
    {
      "field": "<string>",
      "reason": "<string>"
    }
  ]
}

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

201

application/json

desc

data · object

Show child attributes