Update Customer

Update Customer

PATCH /v1/customers/{id}

Update Customer

cURL

curl --request PATCH \
  --url https://api.wizcommerce.com/v1/customers/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "company_name": "Company Name",
  "display_id": "1234567890",
  "display_name": "Customer Display Name",
  "freight_term": "<string>",
  "shipping_method": "<string>",
  "payment_mode": "<string>",
  "payment_term": "<string>",
  "primary_contact_id": "<string>",
  "default_shipping_address_id": "<string>",
  "default_billing_address_id": "<string>",
  "reference_id": "CUS123",
  "assigned_sales_rep_ids": [
    "<string>"
  ],
  "assigned_price_list_id": "<string>",
  "first_name": "John",
  "last_name": "Doe",
  "phone": "[phone]",
  "email": "[e-mail]",
  "addresses": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "reference_id": "ADDR123",
      "first_name": "John",
      "last_name": "Doe",
      "phone": "[phone]",
      "email": "[e-mail]",
      "address_line_1": "123 Main St",
      "address_line_2": "Apt 101",
      "city": "Anytown",
      "state": "CA",
      "country": "US",
      "zip_code": "12345",
      "type": "billing",
      "is_default": true,
      "attributes": [
        {
          "name": "1234567890",
          "value": "red"
        }
      ]
    }
  ],
  "contacts": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "reference_id": "CUS123",
      "first_name": "John",
      "last_name": "Doe",
      "email": "[e-mail]",
      "phone": "[phone]",
      "designation": "Sales Manager",
      "is_default": true,
      "attributes": [
        {
          "name": "1234567890",
          "value": "red"
        }
      ]
    }
  ],
  "attributes": [
    {
      "name": "1234567890",
      "value": "red"
    }
  ]
}
'

import requests

url = "https://api.wizcommerce.com/v1/customers/{id}"

payload = {
    "company_name": "Company Name",
    "display_id": "1234567890",
    "display_name": "Customer Display Name",
    "freight_term": "<string>",
    "shipping_method": "<string>",
    "payment_mode": "<string>",
    "payment_term": "<string>",
    "primary_contact_id": "<string>",
    "default_shipping_address_id": "<string>",
    "default_billing_address_id": "<string>",
    "reference_id": "CUS123",
    "assigned_sales_rep_ids": ["<string>"],
    "assigned_price_list_id": "<string>",
    "first_name": "John",
    "last_name": "Doe",
    "phone": "[phone]",
    "email": "[e-mail]",
    "addresses": [
        {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "reference_id": "ADDR123",
            "first_name": "John",
            "last_name": "Doe",
            "phone": "[phone]",
            "email": "[e-mail]",
            "address_line_1": "123 Main St",
            "address_line_2": "Apt 101",
            "city": "Anytown",
            "state": "CA",
            "country": "US",
            "zip_code": "12345",
            "type": "billing",
            "is_default": True,
            "attributes": [
                {
                    "name": "1234567890",
                    "value": "red"
                }
            ]
        }
    ],
    "contacts": [
        {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "reference_id": "CUS123",
            "first_name": "John",
            "last_name": "Doe",
            "email": "[e-mail]",
            "phone": "[phone]",
            "designation": "Sales Manager",
            "is_default": True,
            "attributes": [
                {
                    "name": "1234567890",
                    "value": "red"
                }
            ]
        }
    ],
    "attributes": [
        {
            "name": "1234567890",
            "value": "red"
        }
    ]
}
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({
    company_name: 'Company Name',
    display_id: '1234567890',
    display_name: 'Customer Display Name',
    freight_term: '<string>',
    shipping_method: '<string>',
    payment_mode: '<string>',
    payment_term: '<string>',
    primary_contact_id: '<string>',
    default_shipping_address_id: '<string>',
    default_billing_address_id: '<string>',
    reference_id: 'CUS123',
    assigned_sales_rep_ids: ['<string>'],
    assigned_price_list_id: '<string>',
    first_name: 'John',
    last_name: 'Doe',
    phone: '[phone]',
    email: '[e-mail]',
    addresses: [
      {
        id: '123e4567-e89b-12d3-a456-426614174000',
        reference_id: 'ADDR123',
        first_name: 'John',
        last_name: 'Doe',
        phone: '[phone]',
        email: '[e-mail]',
        address_line_1: '123 Main St',
        address_line_2: 'Apt 101',
        city: 'Anytown',
        state: 'CA',
        country: 'US',
        zip_code: '12345',
        type: 'billing',
        is_default: true,
        attributes: [{name: '1234567890', value: 'red'}]
      }
    ],
    contacts: [
      {
        id: '123e4567-e89b-12d3-a456-426614174000',
        reference_id: 'CUS123',
        first_name: 'John',
        last_name: 'Doe',
        email: '[e-mail]',
        phone: '[phone]',
        designation: 'Sales Manager',
        is_default: true,
        attributes: [{name: '1234567890', value: 'red'}]
      }
    ],
    attributes: [{name: '1234567890', value: 'red'}]
  })
};

fetch('https://api.wizcommerce.com/v1/customers/{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/customers/{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([
    'company_name' => 'Company Name',
    'display_id' => '1234567890',
    'display_name' => 'Customer Display Name',
    'freight_term' => '<string>',
    'shipping_method' => '<string>',
    'payment_mode' => '<string>',
    'payment_term' => '<string>',
    'primary_contact_id' => '<string>',
    'default_shipping_address_id' => '<string>',
    'default_billing_address_id' => '<string>',
    'reference_id' => 'CUS123',
    'assigned_sales_rep_ids' => [
        '<string>'
    ],
    'assigned_price_list_id' => '<string>',
    'first_name' => 'John',
    'last_name' => 'Doe',
    'phone' => '[phone]',
    'email' => '[e-mail]',
    'addresses' => [
        [
                'id' => '123e4567-e89b-12d3-a456-426614174000',
                'reference_id' => 'ADDR123',
                'first_name' => 'John',
                'last_name' => 'Doe',
                'phone' => '[phone]',
                'email' => '[e-mail]',
                'address_line_1' => '123 Main St',
                'address_line_2' => 'Apt 101',
                'city' => 'Anytown',
                'state' => 'CA',
                'country' => 'US',
                'zip_code' => '12345',
                'type' => 'billing',
                'is_default' => true,
                'attributes' => [
                                [
                                                                'name' => '1234567890',
                                                                'value' => 'red'
                                ]
                ]
        ]
    ],
    'contacts' => [
        [
                'id' => '123e4567-e89b-12d3-a456-426614174000',
                'reference_id' => 'CUS123',
                'first_name' => 'John',
                'last_name' => 'Doe',
                'email' => '[e-mail]',
                'phone' => '[phone]',
                'designation' => 'Sales Manager',
                'is_default' => true,
                'attributes' => [
                                [
                                                                'name' => '1234567890',
                                                                'value' => 'red'
                                ]
                ]
        ]
    ],
    'attributes' => [
        [
                'name' => '1234567890',
                'value' => 'red'
        ]
    ]
  ]),
  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/customers/{id}"

	payload := strings.NewReader("{\n  \"company_name\": \"Company Name\",\n  \"display_id\": \"1234567890\",\n  \"display_name\": \"Customer Display Name\",\n  \"freight_term\": \"<string>\",\n  \"shipping_method\": \"<string>\",\n  \"payment_mode\": \"<string>\",\n  \"payment_term\": \"<string>\",\n  \"primary_contact_id\": \"<string>\",\n  \"default_shipping_address_id\": \"<string>\",\n  \"default_billing_address_id\": \"<string>\",\n  \"reference_id\": \"CUS123\",\n  \"assigned_sales_rep_ids\": [\n    \"<string>\"\n  ],\n  \"assigned_price_list_id\": \"<string>\",\n  \"first_name\": \"John\",\n  \"last_name\": \"Doe\",\n  \"phone\": \"[phone]\",\n  \"email\": \"[e-mail]\",\n  \"addresses\": [\n    {\n      \"id\": \"123e4567-e89b-12d3-a456-426614174000\",\n      \"reference_id\": \"ADDR123\",\n      \"first_name\": \"John\",\n      \"last_name\": \"Doe\",\n      \"phone\": \"[phone]\",\n      \"email\": \"[e-mail]\",\n      \"address_line_1\": \"123 Main St\",\n      \"address_line_2\": \"Apt 101\",\n      \"city\": \"Anytown\",\n      \"state\": \"CA\",\n      \"country\": \"US\",\n      \"zip_code\": \"12345\",\n      \"type\": \"billing\",\n      \"is_default\": true,\n      \"attributes\": [\n        {\n          \"name\": \"1234567890\",\n          \"value\": \"red\"\n        }\n      ]\n    }\n  ],\n  \"contacts\": [\n    {\n      \"id\": \"123e4567-e89b-12d3-a456-426614174000\",\n      \"reference_id\": \"CUS123\",\n      \"first_name\": \"John\",\n      \"last_name\": \"Doe\",\n      \"email\": \"[e-mail]\",\n      \"phone\": \"[phone]\",\n      \"designation\": \"Sales Manager\",\n      \"is_default\": true,\n      \"attributes\": [\n        {\n          \"name\": \"1234567890\",\n          \"value\": \"red\"\n        }\n      ]\n    }\n  ],\n  \"attributes\": [\n    {\n      \"name\": \"1234567890\",\n      \"value\": \"red\"\n    }\n  ]\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/customers/{id}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"company_name\": \"Company Name\",\n  \"display_id\": \"1234567890\",\n  \"display_name\": \"Customer Display Name\",\n  \"freight_term\": \"<string>\",\n  \"shipping_method\": \"<string>\",\n  \"payment_mode\": \"<string>\",\n  \"payment_term\": \"<string>\",\n  \"primary_contact_id\": \"<string>\",\n  \"default_shipping_address_id\": \"<string>\",\n  \"default_billing_address_id\": \"<string>\",\n  \"reference_id\": \"CUS123\",\n  \"assigned_sales_rep_ids\": [\n    \"<string>\"\n  ],\n  \"assigned_price_list_id\": \"<string>\",\n  \"first_name\": \"John\",\n  \"last_name\": \"Doe\",\n  \"phone\": \"[phone]\",\n  \"email\": \"[e-mail]\",\n  \"addresses\": [\n    {\n      \"id\": \"123e4567-e89b-12d3-a456-426614174000\",\n      \"reference_id\": \"ADDR123\",\n      \"first_name\": \"John\",\n      \"last_name\": \"Doe\",\n      \"phone\": \"[phone]\",\n      \"email\": \"[e-mail]\",\n      \"address_line_1\": \"123 Main St\",\n      \"address_line_2\": \"Apt 101\",\n      \"city\": \"Anytown\",\n      \"state\": \"CA\",\n      \"country\": \"US\",\n      \"zip_code\": \"12345\",\n      \"type\": \"billing\",\n      \"is_default\": true,\n      \"attributes\": [\n        {\n          \"name\": \"1234567890\",\n          \"value\": \"red\"\n        }\n      ]\n    }\n  ],\n  \"contacts\": [\n    {\n      \"id\": \"123e4567-e89b-12d3-a456-426614174000\",\n      \"reference_id\": \"CUS123\",\n      \"first_name\": \"John\",\n      \"last_name\": \"Doe\",\n      \"email\": \"[e-mail]\",\n      \"phone\": \"[phone]\",\n      \"designation\": \"Sales Manager\",\n      \"is_default\": true,\n      \"attributes\": [\n        {\n          \"name\": \"1234567890\",\n          \"value\": \"red\"\n        }\n      ]\n    }\n  ],\n  \"attributes\": [\n    {\n      \"name\": \"1234567890\",\n      \"value\": \"red\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.wizcommerce.com/v1/customers/{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  \"company_name\": \"Company Name\",\n  \"display_id\": \"1234567890\",\n  \"display_name\": \"Customer Display Name\",\n  \"freight_term\": \"<string>\",\n  \"shipping_method\": \"<string>\",\n  \"payment_mode\": \"<string>\",\n  \"payment_term\": \"<string>\",\n  \"primary_contact_id\": \"<string>\",\n  \"default_shipping_address_id\": \"<string>\",\n  \"default_billing_address_id\": \"<string>\",\n  \"reference_id\": \"CUS123\",\n  \"assigned_sales_rep_ids\": [\n    \"<string>\"\n  ],\n  \"assigned_price_list_id\": \"<string>\",\n  \"first_name\": \"John\",\n  \"last_name\": \"Doe\",\n  \"phone\": \"[phone]\",\n  \"email\": \"[e-mail]\",\n  \"addresses\": [\n    {\n      \"id\": \"123e4567-e89b-12d3-a456-426614174000\",\n      \"reference_id\": \"ADDR123\",\n      \"first_name\": \"John\",\n      \"last_name\": \"Doe\",\n      \"phone\": \"[phone]\",\n      \"email\": \"[e-mail]\",\n      \"address_line_1\": \"123 Main St\",\n      \"address_line_2\": \"Apt 101\",\n      \"city\": \"Anytown\",\n      \"state\": \"CA\",\n      \"country\": \"US\",\n      \"zip_code\": \"12345\",\n      \"type\": \"billing\",\n      \"is_default\": true,\n      \"attributes\": [\n        {\n          \"name\": \"1234567890\",\n          \"value\": \"red\"\n        }\n      ]\n    }\n  ],\n  \"contacts\": [\n    {\n      \"id\": \"123e4567-e89b-12d3-a456-426614174000\",\n      \"reference_id\": \"CUS123\",\n      \"first_name\": \"John\",\n      \"last_name\": \"Doe\",\n      \"email\": \"[e-mail]\",\n      \"phone\": \"[phone]\",\n      \"designation\": \"Sales Manager\",\n      \"is_default\": true,\n      \"attributes\": [\n        {\n          \"name\": \"1234567890\",\n          \"value\": \"red\"\n        }\n      ]\n    }\n  ],\n  \"attributes\": [\n    {\n      \"name\": \"1234567890\",\n      \"value\": \"red\"\n    }\n  ]\n}"

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

201

{
  "data": {
    "id": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
    "reference_id": "1234567890",
    "display_id": "WC_1234567890",
    "name": "Customer Name",
    "display_name": "Customer Display Name",
    "first_name": "John",
    "last_name": "Doe",
    "phone": "[phone]",
    "email": "[e-mail]",
    "status": "active",
    "freight_term": "Cust. Pickup",
    "shipping_method": "DHL",
    "payment_mode": "AMEX",
    "payment_term": "NET30",
    "assigned_sales_reps": [
      {
        "id": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
        "email": "[e-mail]",
        "first_name": "John",
        "last_name": "Doe",
        "phone": "[phone]",
        "department": "Sales",
        "status": "active",
        "created_by": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
        "updated_by": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
        "created_at": "2021-01-01T00:00:00Z",
        "updated_at": "2021-01-01T00:00:00Z"
      }
    ],
    "assigned_price_list": {
      "id": "0c05a9a7-84ed-46f0-819b-653545730920",
      "name": "Price List 1",
      "status": "active",
      "reference_id": "PRC-20250101",
      "description": "Price List 1 Description",
      "created_at": "2025-01-01T00:00:00Z",
      "updated_at": "2025-01-01T00:00:00Z"
    },
    "addresses": [
      {
        "id": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
        "customer_id": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
        "reference_id": "ADDR123",
        "address_line_1": "123 Main St",
        "address_line_2": "Apt 101",
        "city": "Anytown",
        "state": "CA",
        "country": "USA",
        "zip_code": "12345",
        "first_name": "John",
        "last_name": "Doe",
        "phone": "[phone]",
        "email": "[e-mail]",
        "type": "billing",
        "status": "active",
        "is_default": false,
        "attributes": [
          {
            "id": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
            "name": "Color",
            "value": "Red",
            "created_by": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
            "updated_by": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
            "created_at": "2021-01-01T00:00:00Z",
            "updated_at": "2021-01-01T00:00:00Z"
          }
        ],
        "created_at": "2025-01-01T15:04:05Z",
        "updated_at": "2025-01-01T15:04:05Z"
      }
    ],
    "contacts": [
      {
        "id": "0c05a9a7-84ed-46f0-819b-653545730920",
        "reference_id": "CUS123",
        "first_name": "John",
        "last_name": "Doe",
        "email": "[e-mail]",
        "phone": "[phone]",
        "designation": "Sales Manager",
        "status": "active",
        "is_default": false,
        "attributes": [
          {
            "id": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
            "name": "Color",
            "value": "Red",
            "created_by": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
            "updated_by": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
            "created_at": "2021-01-01T00:00:00Z",
            "updated_at": "2021-01-01T00:00:00Z"
          }
        ],
        "created_at": "2025-01-01T15:04:05Z",
        "updated_at": "2025-01-01T15:04:05Z"
      }
    ],
    "attributes": [
      {
        "id": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
        "name": "Color",
        "value": "Red",
        "created_by": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
        "updated_by": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
        "created_at": "2021-01-01T00:00:00Z",
        "updated_at": "2021-01-01T00:00:00Z"
      }
    ],
    "created_at": "2025-01-01T15:04:05Z",
    "updated_at": "2025-01-01T15:04:05Z"
  }
}

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

company_name · string

Maximum string length: 255

Example:

"Company Name"

display_id · string

This is the display ID of the customer, it is generated by the system if not provided.

Maximum string length: 255

Example:

"1234567890"

display_name · string

Maximum string length: 255

Example:

"Customer Display Name"

freight_term · string

Maximum string length: 255

shipping_method · string

Maximum string length: 255

payment_mode · string

Maximum string length: 255

payment_term · string

Maximum string length: 255

primary_contact_id · string

default_shipping_address_id · string

default_billing_address_id · string

reference_id · string

Maximum string length: 255

Example:

"CUS123"

assigned_sales_rep_ids · string[]

List of sales rep ids, sales rep id is a uuid can be queried from sales rep api

Minimum array length: 1

assigned_price_list_id · string

Price list id is a uuid can be queried from price list api

first_name · string

Maximum string length: 255

Example:

"John"

last_name · string

Maximum string length: 255

Example:

"Doe"

phone · string

Phone number in E.164 format

Example:

"[phone]"

email · string

Example:

"[e-mail]"

addresses · object[]

Show child attributes

contacts · object[]

Show child attributes

attributes · object[]

Show child attributes

Response

201

application/json

Created

data · object

Show child attributes