Bulk Upsert Customers
curl --request POST \
--url https://api.wizcommerce.com/v1/customers/bulk \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"data": [
{
"id": "7b0d6c1e-3a52-4c8f-9f0e-1d2c3b4a5f60",
"reference_id": "CUST-1001",
"company_name": "Acme Home Retail",
"display_name": "Acme Home",
"display_id": "ACME-01",
"first_name": "Asha",
"last_name": "Rao",
"email": "asha@acmehome.com",
"phone": "+14155550101",
"status": "active",
"customer_type": "Retailer",
"assigned_sales_rep_ids": [
"5a6b7c8d-1e2f-4a3b-9c8d-7e6f5a4b3c2d"
],
"assigned_sales_rep_reference_ids": [
"REP-07"
],
"assigned_price_list_id": "9c8b7a6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
"assigned_price_list_reference_id": "WHOLESALE",
"payment_term": "Net 30",
"payment_mode": "Credit Card",
"shipping_method": "Ground",
"freight_term": "Prepaid",
"tax_rate": 8.25,
"sale_price_adjustment_percentage": 5,
"addresses": [
{
"type": "billing",
"id": "c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f",
"reference_id": "CUST-1001-BILL",
"first_name": "Asha",
"last_name": "Rao",
"phone": "+14155550101",
"email": "billing@acmehome.com",
"address_line_1": "100 Market St",
"address_line_2": "Suite 400",
"city": "San Francisco",
"state": "CA",
"country": "US",
"zip_code": "94105",
"is_default": true,
"attributes": [
{
"id": "3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21",
"name": "Region",
"value": "West"
}
]
}
],
"contacts": [
{
"first_name": "Asha",
"id": "d3e4f5a6-b7c8-4d9e-8f0a-1b2c3d4e5f6a",
"reference_id": "CUST-1001-C1",
"last_name": "Rao",
"email": "asha@acmehome.com",
"phone": "+14155550101",
"designation": "Owner",
"is_default": true,
"attributes": [
{
"id": "3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21",
"name": "Region",
"value": "West"
}
]
}
],
"attributes": [
{
"id": "3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21",
"name": "Region",
"value": "West"
}
]
}
]
}
'import requests
url = "https://api.wizcommerce.com/v1/customers/bulk"
payload = { "data": [
{
"id": "7b0d6c1e-3a52-4c8f-9f0e-1d2c3b4a5f60",
"reference_id": "CUST-1001",
"company_name": "Acme Home Retail",
"display_name": "Acme Home",
"display_id": "ACME-01",
"first_name": "Asha",
"last_name": "Rao",
"email": "asha@acmehome.com",
"phone": "+14155550101",
"status": "active",
"customer_type": "Retailer",
"assigned_sales_rep_ids": ["5a6b7c8d-1e2f-4a3b-9c8d-7e6f5a4b3c2d"],
"assigned_sales_rep_reference_ids": ["REP-07"],
"assigned_price_list_id": "9c8b7a6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
"assigned_price_list_reference_id": "WHOLESALE",
"payment_term": "Net 30",
"payment_mode": "Credit Card",
"shipping_method": "Ground",
"freight_term": "Prepaid",
"tax_rate": 8.25,
"sale_price_adjustment_percentage": 5,
"addresses": [
{
"type": "billing",
"id": "c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f",
"reference_id": "CUST-1001-BILL",
"first_name": "Asha",
"last_name": "Rao",
"phone": "+14155550101",
"email": "billing@acmehome.com",
"address_line_1": "100 Market St",
"address_line_2": "Suite 400",
"city": "San Francisco",
"state": "CA",
"country": "US",
"zip_code": "94105",
"is_default": True,
"attributes": [
{
"id": "3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21",
"name": "Region",
"value": "West"
}
]
}
],
"contacts": [
{
"first_name": "Asha",
"id": "d3e4f5a6-b7c8-4d9e-8f0a-1b2c3d4e5f6a",
"reference_id": "CUST-1001-C1",
"last_name": "Rao",
"email": "asha@acmehome.com",
"phone": "+14155550101",
"designation": "Owner",
"is_default": True,
"attributes": [
{
"id": "3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21",
"name": "Region",
"value": "West"
}
]
}
],
"attributes": [
{
"id": "3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21",
"name": "Region",
"value": "West"
}
]
}
] }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
data: [
{
id: '7b0d6c1e-3a52-4c8f-9f0e-1d2c3b4a5f60',
reference_id: 'CUST-1001',
company_name: 'Acme Home Retail',
display_name: 'Acme Home',
display_id: 'ACME-01',
first_name: 'Asha',
last_name: 'Rao',
email: 'asha@acmehome.com',
phone: '+14155550101',
status: 'active',
customer_type: 'Retailer',
assigned_sales_rep_ids: ['5a6b7c8d-1e2f-4a3b-9c8d-7e6f5a4b3c2d'],
assigned_sales_rep_reference_ids: ['REP-07'],
assigned_price_list_id: '9c8b7a6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d',
assigned_price_list_reference_id: 'WHOLESALE',
payment_term: 'Net 30',
payment_mode: 'Credit Card',
shipping_method: 'Ground',
freight_term: 'Prepaid',
tax_rate: 8.25,
sale_price_adjustment_percentage: 5,
addresses: [
{
type: 'billing',
id: 'c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f',
reference_id: 'CUST-1001-BILL',
first_name: 'Asha',
last_name: 'Rao',
phone: '+14155550101',
email: 'billing@acmehome.com',
address_line_1: '100 Market St',
address_line_2: 'Suite 400',
city: 'San Francisco',
state: 'CA',
country: 'US',
zip_code: '94105',
is_default: true,
attributes: [{id: '3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21', name: 'Region', value: 'West'}]
}
],
contacts: [
{
first_name: 'Asha',
id: 'd3e4f5a6-b7c8-4d9e-8f0a-1b2c3d4e5f6a',
reference_id: 'CUST-1001-C1',
last_name: 'Rao',
email: 'asha@acmehome.com',
phone: '+14155550101',
designation: 'Owner',
is_default: true,
attributes: [{id: '3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21', name: 'Region', value: 'West'}]
}
],
attributes: [{id: '3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21', name: 'Region', value: 'West'}]
}
]
})
};
fetch('https://api.wizcommerce.com/v1/customers/bulk', 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/bulk",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
[
'id' => '7b0d6c1e-3a52-4c8f-9f0e-1d2c3b4a5f60',
'reference_id' => 'CUST-1001',
'company_name' => 'Acme Home Retail',
'display_name' => 'Acme Home',
'display_id' => 'ACME-01',
'first_name' => 'Asha',
'last_name' => 'Rao',
'email' => 'asha@acmehome.com',
'phone' => '+14155550101',
'status' => 'active',
'customer_type' => 'Retailer',
'assigned_sales_rep_ids' => [
'5a6b7c8d-1e2f-4a3b-9c8d-7e6f5a4b3c2d'
],
'assigned_sales_rep_reference_ids' => [
'REP-07'
],
'assigned_price_list_id' => '9c8b7a6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d',
'assigned_price_list_reference_id' => 'WHOLESALE',
'payment_term' => 'Net 30',
'payment_mode' => 'Credit Card',
'shipping_method' => 'Ground',
'freight_term' => 'Prepaid',
'tax_rate' => 8.25,
'sale_price_adjustment_percentage' => 5,
'addresses' => [
[
'type' => 'billing',
'id' => 'c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f',
'reference_id' => 'CUST-1001-BILL',
'first_name' => 'Asha',
'last_name' => 'Rao',
'phone' => '+14155550101',
'email' => 'billing@acmehome.com',
'address_line_1' => '100 Market St',
'address_line_2' => 'Suite 400',
'city' => 'San Francisco',
'state' => 'CA',
'country' => 'US',
'zip_code' => '94105',
'is_default' => true,
'attributes' => [
[
'id' => '3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21',
'name' => 'Region',
'value' => 'West'
]
]
]
],
'contacts' => [
[
'first_name' => 'Asha',
'id' => 'd3e4f5a6-b7c8-4d9e-8f0a-1b2c3d4e5f6a',
'reference_id' => 'CUST-1001-C1',
'last_name' => 'Rao',
'email' => 'asha@acmehome.com',
'phone' => '+14155550101',
'designation' => 'Owner',
'is_default' => true,
'attributes' => [
[
'id' => '3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21',
'name' => 'Region',
'value' => 'West'
]
]
]
],
'attributes' => [
[
'id' => '3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21',
'name' => 'Region',
'value' => 'West'
]
]
]
]
]),
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/bulk"
payload := strings.NewReader("{\n \"data\": [\n {\n \"id\": \"7b0d6c1e-3a52-4c8f-9f0e-1d2c3b4a5f60\",\n \"reference_id\": \"CUST-1001\",\n \"company_name\": \"Acme Home Retail\",\n \"display_name\": \"Acme Home\",\n \"display_id\": \"ACME-01\",\n \"first_name\": \"Asha\",\n \"last_name\": \"Rao\",\n \"email\": \"asha@acmehome.com\",\n \"phone\": \"+14155550101\",\n \"status\": \"active\",\n \"customer_type\": \"Retailer\",\n \"assigned_sales_rep_ids\": [\n \"5a6b7c8d-1e2f-4a3b-9c8d-7e6f5a4b3c2d\"\n ],\n \"assigned_sales_rep_reference_ids\": [\n \"REP-07\"\n ],\n \"assigned_price_list_id\": \"9c8b7a6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d\",\n \"assigned_price_list_reference_id\": \"WHOLESALE\",\n \"payment_term\": \"Net 30\",\n \"payment_mode\": \"Credit Card\",\n \"shipping_method\": \"Ground\",\n \"freight_term\": \"Prepaid\",\n \"tax_rate\": 8.25,\n \"sale_price_adjustment_percentage\": 5,\n \"addresses\": [\n {\n \"type\": \"billing\",\n \"id\": \"c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f\",\n \"reference_id\": \"CUST-1001-BILL\",\n \"first_name\": \"Asha\",\n \"last_name\": \"Rao\",\n \"phone\": \"+14155550101\",\n \"email\": \"billing@acmehome.com\",\n \"address_line_1\": \"100 Market St\",\n \"address_line_2\": \"Suite 400\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"zip_code\": \"94105\",\n \"is_default\": true,\n \"attributes\": [\n {\n \"id\": \"3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21\",\n \"name\": \"Region\",\n \"value\": \"West\"\n }\n ]\n }\n ],\n \"contacts\": [\n {\n \"first_name\": \"Asha\",\n \"id\": \"d3e4f5a6-b7c8-4d9e-8f0a-1b2c3d4e5f6a\",\n \"reference_id\": \"CUST-1001-C1\",\n \"last_name\": \"Rao\",\n \"email\": \"asha@acmehome.com\",\n \"phone\": \"+14155550101\",\n \"designation\": \"Owner\",\n \"is_default\": true,\n \"attributes\": [\n {\n \"id\": \"3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21\",\n \"name\": \"Region\",\n \"value\": \"West\"\n }\n ]\n }\n ],\n \"attributes\": [\n {\n \"id\": \"3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21\",\n \"name\": \"Region\",\n \"value\": \"West\"\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.wizcommerce.com/v1/customers/bulk")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"data\": [\n {\n \"id\": \"7b0d6c1e-3a52-4c8f-9f0e-1d2c3b4a5f60\",\n \"reference_id\": \"CUST-1001\",\n \"company_name\": \"Acme Home Retail\",\n \"display_name\": \"Acme Home\",\n \"display_id\": \"ACME-01\",\n \"first_name\": \"Asha\",\n \"last_name\": \"Rao\",\n \"email\": \"asha@acmehome.com\",\n \"phone\": \"+14155550101\",\n \"status\": \"active\",\n \"customer_type\": \"Retailer\",\n \"assigned_sales_rep_ids\": [\n \"5a6b7c8d-1e2f-4a3b-9c8d-7e6f5a4b3c2d\"\n ],\n \"assigned_sales_rep_reference_ids\": [\n \"REP-07\"\n ],\n \"assigned_price_list_id\": \"9c8b7a6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d\",\n \"assigned_price_list_reference_id\": \"WHOLESALE\",\n \"payment_term\": \"Net 30\",\n \"payment_mode\": \"Credit Card\",\n \"shipping_method\": \"Ground\",\n \"freight_term\": \"Prepaid\",\n \"tax_rate\": 8.25,\n \"sale_price_adjustment_percentage\": 5,\n \"addresses\": [\n {\n \"type\": \"billing\",\n \"id\": \"c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f\",\n \"reference_id\": \"CUST-1001-BILL\",\n \"first_name\": \"Asha\",\n \"last_name\": \"Rao\",\n \"phone\": \"+14155550101\",\n \"email\": \"billing@acmehome.com\",\n \"address_line_1\": \"100 Market St\",\n \"address_line_2\": \"Suite 400\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"zip_code\": \"94105\",\n \"is_default\": true,\n \"attributes\": [\n {\n \"id\": \"3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21\",\n \"name\": \"Region\",\n \"value\": \"West\"\n }\n ]\n }\n ],\n \"contacts\": [\n {\n \"first_name\": \"Asha\",\n \"id\": \"d3e4f5a6-b7c8-4d9e-8f0a-1b2c3d4e5f6a\",\n \"reference_id\": \"CUST-1001-C1\",\n \"last_name\": \"Rao\",\n \"email\": \"asha@acmehome.com\",\n \"phone\": \"+14155550101\",\n \"designation\": \"Owner\",\n \"is_default\": true,\n \"attributes\": [\n {\n \"id\": \"3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21\",\n \"name\": \"Region\",\n \"value\": \"West\"\n }\n ]\n }\n ],\n \"attributes\": [\n {\n \"id\": \"3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21\",\n \"name\": \"Region\",\n \"value\": \"West\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wizcommerce.com/v1/customers/bulk")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": [\n {\n \"id\": \"7b0d6c1e-3a52-4c8f-9f0e-1d2c3b4a5f60\",\n \"reference_id\": \"CUST-1001\",\n \"company_name\": \"Acme Home Retail\",\n \"display_name\": \"Acme Home\",\n \"display_id\": \"ACME-01\",\n \"first_name\": \"Asha\",\n \"last_name\": \"Rao\",\n \"email\": \"asha@acmehome.com\",\n \"phone\": \"+14155550101\",\n \"status\": \"active\",\n \"customer_type\": \"Retailer\",\n \"assigned_sales_rep_ids\": [\n \"5a6b7c8d-1e2f-4a3b-9c8d-7e6f5a4b3c2d\"\n ],\n \"assigned_sales_rep_reference_ids\": [\n \"REP-07\"\n ],\n \"assigned_price_list_id\": \"9c8b7a6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d\",\n \"assigned_price_list_reference_id\": \"WHOLESALE\",\n \"payment_term\": \"Net 30\",\n \"payment_mode\": \"Credit Card\",\n \"shipping_method\": \"Ground\",\n \"freight_term\": \"Prepaid\",\n \"tax_rate\": 8.25,\n \"sale_price_adjustment_percentage\": 5,\n \"addresses\": [\n {\n \"type\": \"billing\",\n \"id\": \"c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f\",\n \"reference_id\": \"CUST-1001-BILL\",\n \"first_name\": \"Asha\",\n \"last_name\": \"Rao\",\n \"phone\": \"+14155550101\",\n \"email\": \"billing@acmehome.com\",\n \"address_line_1\": \"100 Market St\",\n \"address_line_2\": \"Suite 400\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"zip_code\": \"94105\",\n \"is_default\": true,\n \"attributes\": [\n {\n \"id\": \"3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21\",\n \"name\": \"Region\",\n \"value\": \"West\"\n }\n ]\n }\n ],\n \"contacts\": [\n {\n \"first_name\": \"Asha\",\n \"id\": \"d3e4f5a6-b7c8-4d9e-8f0a-1b2c3d4e5f6a\",\n \"reference_id\": \"CUST-1001-C1\",\n \"last_name\": \"Rao\",\n \"email\": \"asha@acmehome.com\",\n \"phone\": \"+14155550101\",\n \"designation\": \"Owner\",\n \"is_default\": true,\n \"attributes\": [\n {\n \"id\": \"3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21\",\n \"name\": \"Region\",\n \"value\": \"West\"\n }\n ]\n }\n ],\n \"attributes\": [\n {\n \"id\": \"3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21\",\n \"name\": \"Region\",\n \"value\": \"West\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "7b0d6c1e-3a52-4c8f-9f0e-1d2c3b4a5f60",
"reference_id": "CUST-1001",
"display_id": "ACME-01",
"warnings": [
{
"field": "attributes[0].name",
"reason": "Attribute with name Region does not exist; skipped"
}
]
}
]
}{
"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>"
}
]
}{
"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>"
}
]
}Customer (v2)
Bulk Upsert Customers
Creates or updates up to 100 customers in one call and waits for the write to finish. A customer is matched by id or reference_id; no match creates a new customer. A present contacts or addresses list is the full published set ([] archives all); omit the key to leave stored rows unchanged.
POST
/
v1
/
customers
/
bulk
Bulk Upsert Customers
curl --request POST \
--url https://api.wizcommerce.com/v1/customers/bulk \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"data": [
{
"id": "7b0d6c1e-3a52-4c8f-9f0e-1d2c3b4a5f60",
"reference_id": "CUST-1001",
"company_name": "Acme Home Retail",
"display_name": "Acme Home",
"display_id": "ACME-01",
"first_name": "Asha",
"last_name": "Rao",
"email": "asha@acmehome.com",
"phone": "+14155550101",
"status": "active",
"customer_type": "Retailer",
"assigned_sales_rep_ids": [
"5a6b7c8d-1e2f-4a3b-9c8d-7e6f5a4b3c2d"
],
"assigned_sales_rep_reference_ids": [
"REP-07"
],
"assigned_price_list_id": "9c8b7a6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
"assigned_price_list_reference_id": "WHOLESALE",
"payment_term": "Net 30",
"payment_mode": "Credit Card",
"shipping_method": "Ground",
"freight_term": "Prepaid",
"tax_rate": 8.25,
"sale_price_adjustment_percentage": 5,
"addresses": [
{
"type": "billing",
"id": "c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f",
"reference_id": "CUST-1001-BILL",
"first_name": "Asha",
"last_name": "Rao",
"phone": "+14155550101",
"email": "billing@acmehome.com",
"address_line_1": "100 Market St",
"address_line_2": "Suite 400",
"city": "San Francisco",
"state": "CA",
"country": "US",
"zip_code": "94105",
"is_default": true,
"attributes": [
{
"id": "3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21",
"name": "Region",
"value": "West"
}
]
}
],
"contacts": [
{
"first_name": "Asha",
"id": "d3e4f5a6-b7c8-4d9e-8f0a-1b2c3d4e5f6a",
"reference_id": "CUST-1001-C1",
"last_name": "Rao",
"email": "asha@acmehome.com",
"phone": "+14155550101",
"designation": "Owner",
"is_default": true,
"attributes": [
{
"id": "3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21",
"name": "Region",
"value": "West"
}
]
}
],
"attributes": [
{
"id": "3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21",
"name": "Region",
"value": "West"
}
]
}
]
}
'import requests
url = "https://api.wizcommerce.com/v1/customers/bulk"
payload = { "data": [
{
"id": "7b0d6c1e-3a52-4c8f-9f0e-1d2c3b4a5f60",
"reference_id": "CUST-1001",
"company_name": "Acme Home Retail",
"display_name": "Acme Home",
"display_id": "ACME-01",
"first_name": "Asha",
"last_name": "Rao",
"email": "asha@acmehome.com",
"phone": "+14155550101",
"status": "active",
"customer_type": "Retailer",
"assigned_sales_rep_ids": ["5a6b7c8d-1e2f-4a3b-9c8d-7e6f5a4b3c2d"],
"assigned_sales_rep_reference_ids": ["REP-07"],
"assigned_price_list_id": "9c8b7a6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
"assigned_price_list_reference_id": "WHOLESALE",
"payment_term": "Net 30",
"payment_mode": "Credit Card",
"shipping_method": "Ground",
"freight_term": "Prepaid",
"tax_rate": 8.25,
"sale_price_adjustment_percentage": 5,
"addresses": [
{
"type": "billing",
"id": "c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f",
"reference_id": "CUST-1001-BILL",
"first_name": "Asha",
"last_name": "Rao",
"phone": "+14155550101",
"email": "billing@acmehome.com",
"address_line_1": "100 Market St",
"address_line_2": "Suite 400",
"city": "San Francisco",
"state": "CA",
"country": "US",
"zip_code": "94105",
"is_default": True,
"attributes": [
{
"id": "3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21",
"name": "Region",
"value": "West"
}
]
}
],
"contacts": [
{
"first_name": "Asha",
"id": "d3e4f5a6-b7c8-4d9e-8f0a-1b2c3d4e5f6a",
"reference_id": "CUST-1001-C1",
"last_name": "Rao",
"email": "asha@acmehome.com",
"phone": "+14155550101",
"designation": "Owner",
"is_default": True,
"attributes": [
{
"id": "3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21",
"name": "Region",
"value": "West"
}
]
}
],
"attributes": [
{
"id": "3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21",
"name": "Region",
"value": "West"
}
]
}
] }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
data: [
{
id: '7b0d6c1e-3a52-4c8f-9f0e-1d2c3b4a5f60',
reference_id: 'CUST-1001',
company_name: 'Acme Home Retail',
display_name: 'Acme Home',
display_id: 'ACME-01',
first_name: 'Asha',
last_name: 'Rao',
email: 'asha@acmehome.com',
phone: '+14155550101',
status: 'active',
customer_type: 'Retailer',
assigned_sales_rep_ids: ['5a6b7c8d-1e2f-4a3b-9c8d-7e6f5a4b3c2d'],
assigned_sales_rep_reference_ids: ['REP-07'],
assigned_price_list_id: '9c8b7a6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d',
assigned_price_list_reference_id: 'WHOLESALE',
payment_term: 'Net 30',
payment_mode: 'Credit Card',
shipping_method: 'Ground',
freight_term: 'Prepaid',
tax_rate: 8.25,
sale_price_adjustment_percentage: 5,
addresses: [
{
type: 'billing',
id: 'c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f',
reference_id: 'CUST-1001-BILL',
first_name: 'Asha',
last_name: 'Rao',
phone: '+14155550101',
email: 'billing@acmehome.com',
address_line_1: '100 Market St',
address_line_2: 'Suite 400',
city: 'San Francisco',
state: 'CA',
country: 'US',
zip_code: '94105',
is_default: true,
attributes: [{id: '3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21', name: 'Region', value: 'West'}]
}
],
contacts: [
{
first_name: 'Asha',
id: 'd3e4f5a6-b7c8-4d9e-8f0a-1b2c3d4e5f6a',
reference_id: 'CUST-1001-C1',
last_name: 'Rao',
email: 'asha@acmehome.com',
phone: '+14155550101',
designation: 'Owner',
is_default: true,
attributes: [{id: '3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21', name: 'Region', value: 'West'}]
}
],
attributes: [{id: '3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21', name: 'Region', value: 'West'}]
}
]
})
};
fetch('https://api.wizcommerce.com/v1/customers/bulk', 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/bulk",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
[
'id' => '7b0d6c1e-3a52-4c8f-9f0e-1d2c3b4a5f60',
'reference_id' => 'CUST-1001',
'company_name' => 'Acme Home Retail',
'display_name' => 'Acme Home',
'display_id' => 'ACME-01',
'first_name' => 'Asha',
'last_name' => 'Rao',
'email' => 'asha@acmehome.com',
'phone' => '+14155550101',
'status' => 'active',
'customer_type' => 'Retailer',
'assigned_sales_rep_ids' => [
'5a6b7c8d-1e2f-4a3b-9c8d-7e6f5a4b3c2d'
],
'assigned_sales_rep_reference_ids' => [
'REP-07'
],
'assigned_price_list_id' => '9c8b7a6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d',
'assigned_price_list_reference_id' => 'WHOLESALE',
'payment_term' => 'Net 30',
'payment_mode' => 'Credit Card',
'shipping_method' => 'Ground',
'freight_term' => 'Prepaid',
'tax_rate' => 8.25,
'sale_price_adjustment_percentage' => 5,
'addresses' => [
[
'type' => 'billing',
'id' => 'c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f',
'reference_id' => 'CUST-1001-BILL',
'first_name' => 'Asha',
'last_name' => 'Rao',
'phone' => '+14155550101',
'email' => 'billing@acmehome.com',
'address_line_1' => '100 Market St',
'address_line_2' => 'Suite 400',
'city' => 'San Francisco',
'state' => 'CA',
'country' => 'US',
'zip_code' => '94105',
'is_default' => true,
'attributes' => [
[
'id' => '3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21',
'name' => 'Region',
'value' => 'West'
]
]
]
],
'contacts' => [
[
'first_name' => 'Asha',
'id' => 'd3e4f5a6-b7c8-4d9e-8f0a-1b2c3d4e5f6a',
'reference_id' => 'CUST-1001-C1',
'last_name' => 'Rao',
'email' => 'asha@acmehome.com',
'phone' => '+14155550101',
'designation' => 'Owner',
'is_default' => true,
'attributes' => [
[
'id' => '3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21',
'name' => 'Region',
'value' => 'West'
]
]
]
],
'attributes' => [
[
'id' => '3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21',
'name' => 'Region',
'value' => 'West'
]
]
]
]
]),
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/bulk"
payload := strings.NewReader("{\n \"data\": [\n {\n \"id\": \"7b0d6c1e-3a52-4c8f-9f0e-1d2c3b4a5f60\",\n \"reference_id\": \"CUST-1001\",\n \"company_name\": \"Acme Home Retail\",\n \"display_name\": \"Acme Home\",\n \"display_id\": \"ACME-01\",\n \"first_name\": \"Asha\",\n \"last_name\": \"Rao\",\n \"email\": \"asha@acmehome.com\",\n \"phone\": \"+14155550101\",\n \"status\": \"active\",\n \"customer_type\": \"Retailer\",\n \"assigned_sales_rep_ids\": [\n \"5a6b7c8d-1e2f-4a3b-9c8d-7e6f5a4b3c2d\"\n ],\n \"assigned_sales_rep_reference_ids\": [\n \"REP-07\"\n ],\n \"assigned_price_list_id\": \"9c8b7a6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d\",\n \"assigned_price_list_reference_id\": \"WHOLESALE\",\n \"payment_term\": \"Net 30\",\n \"payment_mode\": \"Credit Card\",\n \"shipping_method\": \"Ground\",\n \"freight_term\": \"Prepaid\",\n \"tax_rate\": 8.25,\n \"sale_price_adjustment_percentage\": 5,\n \"addresses\": [\n {\n \"type\": \"billing\",\n \"id\": \"c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f\",\n \"reference_id\": \"CUST-1001-BILL\",\n \"first_name\": \"Asha\",\n \"last_name\": \"Rao\",\n \"phone\": \"+14155550101\",\n \"email\": \"billing@acmehome.com\",\n \"address_line_1\": \"100 Market St\",\n \"address_line_2\": \"Suite 400\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"zip_code\": \"94105\",\n \"is_default\": true,\n \"attributes\": [\n {\n \"id\": \"3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21\",\n \"name\": \"Region\",\n \"value\": \"West\"\n }\n ]\n }\n ],\n \"contacts\": [\n {\n \"first_name\": \"Asha\",\n \"id\": \"d3e4f5a6-b7c8-4d9e-8f0a-1b2c3d4e5f6a\",\n \"reference_id\": \"CUST-1001-C1\",\n \"last_name\": \"Rao\",\n \"email\": \"asha@acmehome.com\",\n \"phone\": \"+14155550101\",\n \"designation\": \"Owner\",\n \"is_default\": true,\n \"attributes\": [\n {\n \"id\": \"3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21\",\n \"name\": \"Region\",\n \"value\": \"West\"\n }\n ]\n }\n ],\n \"attributes\": [\n {\n \"id\": \"3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21\",\n \"name\": \"Region\",\n \"value\": \"West\"\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.wizcommerce.com/v1/customers/bulk")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"data\": [\n {\n \"id\": \"7b0d6c1e-3a52-4c8f-9f0e-1d2c3b4a5f60\",\n \"reference_id\": \"CUST-1001\",\n \"company_name\": \"Acme Home Retail\",\n \"display_name\": \"Acme Home\",\n \"display_id\": \"ACME-01\",\n \"first_name\": \"Asha\",\n \"last_name\": \"Rao\",\n \"email\": \"asha@acmehome.com\",\n \"phone\": \"+14155550101\",\n \"status\": \"active\",\n \"customer_type\": \"Retailer\",\n \"assigned_sales_rep_ids\": [\n \"5a6b7c8d-1e2f-4a3b-9c8d-7e6f5a4b3c2d\"\n ],\n \"assigned_sales_rep_reference_ids\": [\n \"REP-07\"\n ],\n \"assigned_price_list_id\": \"9c8b7a6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d\",\n \"assigned_price_list_reference_id\": \"WHOLESALE\",\n \"payment_term\": \"Net 30\",\n \"payment_mode\": \"Credit Card\",\n \"shipping_method\": \"Ground\",\n \"freight_term\": \"Prepaid\",\n \"tax_rate\": 8.25,\n \"sale_price_adjustment_percentage\": 5,\n \"addresses\": [\n {\n \"type\": \"billing\",\n \"id\": \"c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f\",\n \"reference_id\": \"CUST-1001-BILL\",\n \"first_name\": \"Asha\",\n \"last_name\": \"Rao\",\n \"phone\": \"+14155550101\",\n \"email\": \"billing@acmehome.com\",\n \"address_line_1\": \"100 Market St\",\n \"address_line_2\": \"Suite 400\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"zip_code\": \"94105\",\n \"is_default\": true,\n \"attributes\": [\n {\n \"id\": \"3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21\",\n \"name\": \"Region\",\n \"value\": \"West\"\n }\n ]\n }\n ],\n \"contacts\": [\n {\n \"first_name\": \"Asha\",\n \"id\": \"d3e4f5a6-b7c8-4d9e-8f0a-1b2c3d4e5f6a\",\n \"reference_id\": \"CUST-1001-C1\",\n \"last_name\": \"Rao\",\n \"email\": \"asha@acmehome.com\",\n \"phone\": \"+14155550101\",\n \"designation\": \"Owner\",\n \"is_default\": true,\n \"attributes\": [\n {\n \"id\": \"3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21\",\n \"name\": \"Region\",\n \"value\": \"West\"\n }\n ]\n }\n ],\n \"attributes\": [\n {\n \"id\": \"3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21\",\n \"name\": \"Region\",\n \"value\": \"West\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wizcommerce.com/v1/customers/bulk")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": [\n {\n \"id\": \"7b0d6c1e-3a52-4c8f-9f0e-1d2c3b4a5f60\",\n \"reference_id\": \"CUST-1001\",\n \"company_name\": \"Acme Home Retail\",\n \"display_name\": \"Acme Home\",\n \"display_id\": \"ACME-01\",\n \"first_name\": \"Asha\",\n \"last_name\": \"Rao\",\n \"email\": \"asha@acmehome.com\",\n \"phone\": \"+14155550101\",\n \"status\": \"active\",\n \"customer_type\": \"Retailer\",\n \"assigned_sales_rep_ids\": [\n \"5a6b7c8d-1e2f-4a3b-9c8d-7e6f5a4b3c2d\"\n ],\n \"assigned_sales_rep_reference_ids\": [\n \"REP-07\"\n ],\n \"assigned_price_list_id\": \"9c8b7a6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d\",\n \"assigned_price_list_reference_id\": \"WHOLESALE\",\n \"payment_term\": \"Net 30\",\n \"payment_mode\": \"Credit Card\",\n \"shipping_method\": \"Ground\",\n \"freight_term\": \"Prepaid\",\n \"tax_rate\": 8.25,\n \"sale_price_adjustment_percentage\": 5,\n \"addresses\": [\n {\n \"type\": \"billing\",\n \"id\": \"c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f\",\n \"reference_id\": \"CUST-1001-BILL\",\n \"first_name\": \"Asha\",\n \"last_name\": \"Rao\",\n \"phone\": \"+14155550101\",\n \"email\": \"billing@acmehome.com\",\n \"address_line_1\": \"100 Market St\",\n \"address_line_2\": \"Suite 400\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"zip_code\": \"94105\",\n \"is_default\": true,\n \"attributes\": [\n {\n \"id\": \"3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21\",\n \"name\": \"Region\",\n \"value\": \"West\"\n }\n ]\n }\n ],\n \"contacts\": [\n {\n \"first_name\": \"Asha\",\n \"id\": \"d3e4f5a6-b7c8-4d9e-8f0a-1b2c3d4e5f6a\",\n \"reference_id\": \"CUST-1001-C1\",\n \"last_name\": \"Rao\",\n \"email\": \"asha@acmehome.com\",\n \"phone\": \"+14155550101\",\n \"designation\": \"Owner\",\n \"is_default\": true,\n \"attributes\": [\n {\n \"id\": \"3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21\",\n \"name\": \"Region\",\n \"value\": \"West\"\n }\n ]\n }\n ],\n \"attributes\": [\n {\n \"id\": \"3f1c2b9e-7a1d-4c55-9a0e-2f8d6b1c4e21\",\n \"name\": \"Region\",\n \"value\": \"West\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "7b0d6c1e-3a52-4c8f-9f0e-1d2c3b4a5f60",
"reference_id": "CUST-1001",
"display_id": "ACME-01",
"warnings": [
{
"field": "attributes[0].name",
"reason": "Attribute with name Region does not exist; skipped"
}
]
}
]
}{
"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>"
}
]
}{
"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>"
}
]
}Authorizations
API Key for authentication
Body
application/json
1-100 items; body must not exceed 10 MiB
1-100 customers. Body must not exceed 10 MiB.
Required array length:
1 - 100 elementsShow child attributes
Show child attributes
Response
OK
One entry per written customer, in request order.
Show child attributes
Show child attributes
Was this page helpful?