curl --request POST \
--url https://api.wizcommerce.com/v1/customers \
--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>",
"reference_id": "CUS123",
"assigned_sales_rep_ids": [
"<string>"
],
"assigned_price_list_id": "<string>",
"first_name": "John",
"last_name": "Doe",
"phone": "+14155552671",
"email": "john.doe@example.com",
"addresses": [
{
"reference_id": "ADDR123",
"first_name": "John",
"last_name": "Doe",
"phone": "+14155552671",
"email": "john.doe@example.com",
"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": [
{
"reference_id": "CUS123",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"phone": "+14155552671",
"designation": "Sales Manager",
"is_default": true,
"attributes": [
{
"name": "1234567890",
"value": "red"
}
]
}
],
"attributes": [
{
"name": "1234567890",
"value": "red"
}
]
}'
{
"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": "+14155552671",
"email": "john.doe@example.com",
"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": "john.doe@example.com",
"first_name": "John",
"last_name": "Doe",
"phone": "+14155552671",
"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": "+14155552671",
"email": "john.doe@example.com",
"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": "john.doe@example.com",
"phone": "+14155552671",
"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"
}
}
Create Customer
curl --request POST \
--url https://api.wizcommerce.com/v1/customers \
--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>",
"reference_id": "CUS123",
"assigned_sales_rep_ids": [
"<string>"
],
"assigned_price_list_id": "<string>",
"first_name": "John",
"last_name": "Doe",
"phone": "+14155552671",
"email": "john.doe@example.com",
"addresses": [
{
"reference_id": "ADDR123",
"first_name": "John",
"last_name": "Doe",
"phone": "+14155552671",
"email": "john.doe@example.com",
"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": [
{
"reference_id": "CUS123",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"phone": "+14155552671",
"designation": "Sales Manager",
"is_default": true,
"attributes": [
{
"name": "1234567890",
"value": "red"
}
]
}
],
"attributes": [
{
"name": "1234567890",
"value": "red"
}
]
}'
{
"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": "+14155552671",
"email": "john.doe@example.com",
"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": "john.doe@example.com",
"first_name": "John",
"last_name": "Doe",
"phone": "+14155552671",
"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": "+14155552671",
"email": "john.doe@example.com",
"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": "john.doe@example.com",
"phone": "+14155552671",
"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"
}
}
API Key for authentication
request
The body is of type object
.
Created
The response is of type object
.
Was this page helpful?