List Customers

curl --request GET \
  --url https://api.wizcommerce.com/v1/customers \
  --header 'X-API-Key: <api-key>'

{
  "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": "[email protected]",
      "status": "active",
      "freight_term": "Cust. Pickup",
      "shipping_method": "DHL",
      "payment_mode": "AMEX",
      "payment_term": "NET30",
      "created_at": "2025-01-01T15:04:05Z",
      "updated_at": "2025-01-01T15:04:05Z"
    }
  ],
  "pagination": {
    "total_records": 100,
    "total_pages": 10,
    "current_page": 1,
    "next_page": 2,
    "prev_page": 0,
    "page_size": 10
  }
}

GET

customers

List Customers

curl --request GET \
  --url https://api.wizcommerce.com/v1/customers \
  --header 'X-API-Key: <api-key>'

{
  "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": "[email protected]",
      "status": "active",
      "freight_term": "Cust. Pickup",
      "shipping_method": "DHL",
      "payment_mode": "AMEX",
      "payment_term": "NET30",
      "created_at": "2025-01-01T15:04:05Z",
      "updated_at": "2025-01-01T15:04:05Z"
    }
  ],
  "pagination": {
    "total_records": 100,
    "total_pages": 10,
    "current_page": 1,
    "next_page": 2,
    "prev_page": 0,
    "page_size": 10
  }
}

Authorizations

X-API-Key

string

header

required

API Key for authentication

Query Parameters

page

integer

Required range: x >= 1

created_after

string

format: 2006-01-02T15:04:05Z (ISO 8601) UTC

page_size

integer

Required range: 1 <= x <= 100

created_before

string

format: 2006-01-02T15:04:05Z (ISO 8601) UTC

updated_after

string

format: 2006-01-02T15:04:05Z (ISO 8601) UTC

updated_before

string

format: 2006-01-02T15:04:05Z (ISO 8601) UTC

reference_ids

string[]

List of customer reference ids separated by comma

sort

enum<string>

default:desc

Available options:

asc,

desc

sort_by

enum<string>

default:updated_at

Available options:

created_at,

updated_at,

company_name,

display_name

status

enum<string>

default:active

Available options:

active,

inactive

Response

data

object[]

Show child attributes

data.id

string

UUID

Example:

"01f5d171-d3e3-4b2b-bd57-0727194b5bed"

data.reference_id

string

Example:

"1234567890"

data.display_id

string

Example:

"WC_1234567890"

data.name

string

Example:

"Customer Name"

data.display_name

string

Example:

"Customer Display Name"

data.first_name

string

Example:

"John"

data.last_name

string

Example:

"Doe"

data.phone

string

Example:

"+14155552671"

data.email

string

Example:

"[email protected]"

data.status

string

Example:

"active"

data.freight_term

string

Example:

"Cust. Pickup"

data.shipping_method

string

Example:

"DHL"

data.payment_mode

string

Example:

"AMEX"

data.payment_term

string

Example:

"NET30"

data.created_at

string

Example:

"2025-01-01T15:04:05Z"

data.updated_at

string

Example:

"2025-01-01T15:04:05Z"

pagination

object

Show child attributes

pagination.total_records

integer

Example:

100

pagination.total_pages

integer

Example:

10

pagination.current_page

integer

Example:

1

pagination.next_page

integer

Example:

2

pagination.prev_page

integer

Example:

0

pagination.page_size

integer

Example:

10

Delete Attribute Create Customer

⌘I

Auth

Core APIs

Authorizations

Query Parameters

Response