sale/customer/get - Equotix One API

This returns the list of customers available in the Equotix One account.

Request

Body Params application/json

domain

string

required

The domain you are assigned to authenticate your Equotix One account.

api_key

string

required

The email address assigned to the user account in your Equotix One.

auth_timestamp

integer

required

The unix timestamp used to sign this API request.

auth_signature

string

required

The calculated signature for this API request.

customer_id

integer

optional

The customer ID to search for specifically.

string

optional

Filter the list of customers by name OR email OR telephone.

filter_name

string

optional

Filter the list of customers by name.

filter_customer_group_id

integer

optional

Filter the list of customers by customer group ID.

filter_email

string

optional

Filter the list of customers by email.

filter_telephone

string

optional

Filter the list of customers by telephone.

filter_card_number

string

optional

Filter the list of customers by the card number.

filter_date_modified

string

optional

Filter the list of customers modified after the specified date.

filter_deleted

boolean

optional

Filter the list of customers to include deleted records.

page

integer

optional

Page number of the results.

sort

string

optional

The key for the ordering of the results. Accepts "name", "customer_group_id", "email", "telephone", "reward", "date_added", "date_modified", "date_ordered", "annual_spend", "annual_spend_2"

order

string

optional

The direction for the ordering of the results. Accepts "ASC", "DESC"

limit

integer

optional

The number of results per page. Accepts 1 to 100.

Example

{
    "domain": "string",
    "api_key": "string",
    "auth_timestamp": 0,
    "auth_signature": "string",
    "customer_id": 0,
    "search": "string",
    "filter_name": "string",
    "filter_customer_group_id": 0,
    "filter_email": "string",
    "filter_telephone": "string",
    "filter_card_number": "string",
    "filter_date_modified": "string",
    "filter_deleted": true,
    "page": 0,
    "sort": "string",
    "order": "string",
    "limit": 0
}

Responses

🟢200Success

application/json

Body

error

array[string]

required

Returns only if there is an error.

total

integer

required

The total number of results available.

customers

array [object {17}]

required

The list of customers.

customer_id

integer

required

The customer ID.

firstname

string

required

The customer first name.

lastname

string

required

The customer last name.

name

string

required

The customer first name and last name.

company

string

required

The customer company.

customer_group

string

required

The customer group name.

customer_group_id

integer

required

The customer group ID.

string

required

The customer email.

telephone

string

required

The customer telephone.

card_number

string

required

The customer member card number.

reward

integer

required

The customer available reward points.

date_added

string

required

The date time the customer was created.

date_modified

string

required

The date time the customer was last modified.

date_ordered

string

required

The date time the customer last purchased.

annual_spend

number

required

The customer annual spending this year.

annual_spend_2

number

required

The customer annual spending last year.

deleted

boolean

optional

Indicates if the customer has been deleted. Only returned if filter_deleted is "1".

Example

{
    "error": [
        "string"
    ],
    "total": 0,
    "customers": [
        {
            "customer_id": 0,
            "firstname": "string",
            "lastname": "string",
            "name": "string",
            "company": "string",
            "customer_group": "string",
            "customer_group_id": 0,
            "email": "string",
            "telephone": "string",
            "card_number": "string",
            "reward": 0,
            "date_added": "string",
            "date_modified": "string",
            "date_ordered": "string",
            "annual_spend": 0,
            "annual_spend_2": 0,
            "deleted": true
        }
    ]
}