Equotix One API
  1. Customer
Equotix One API
  • Getting Started
    • Introduction
    • Authentication
    • API Example
    • Rate Limits
    • API Terms of Use
  • Extension
    • Dashboard
      • Announcement
        • extension/dashboard/announcement/get
    • Module
      • Invoice Copy
        • extension/module/invoice/get
    • Report
      • Channel Payout
        • extension/report/channel_payout/get
    • Total
      • Promotion
        • extension/total/promotion/get
        • extension/total/promotion/getCategory
        • extension/total/promotion/getHistory
      • Tax
        • extension/module/tax/get
  • Integration
    • Channel
      • integration/channel/get
    • Extension
      • integration/extension/get
    • Profile
      • integration/profile/get
  • Inventory
    • Addition
      • inventory/addition/add
      • inventory/addition/edit
      • inventory/addition/delete
      • inventory/addition/get
    • Brand
      • inventory/brand/add
      • inventory/brand/edit
      • inventory/brand/delete
      • inventory/brand/get
    • Category
      • inventory/category/add
      • inventory/category/edit
      • inventory/category/delete
      • inventory/category/get
    • Deduction
      • inventory/deduction/add
      • inventory/deduction/edit
      • inventory/deduction/delete
      • inventory/deduction/get
    • Flow
      • inventory/flow/get
    • Item
      • inventory/item/add
      • inventory/item/edit
      • inventory/item/delete
      • inventory/item/get
      • inventory/item/editStock
    • Location
      • inventory/location/add
      • inventory/location/edit
      • inventory/location/delete
      • inventory/location/get
    • Purchase Order
      • inventory/purchase_order/add
      • inventory/purchase_order/edit
      • inventory/purchase_order/delete
      • inventory/purchase_order/get
    • Reservation
      • inventory/reservation/add
      • inventory/reservation/edit
      • inventory/reservation/delete
      • inventory/reservation/get
    • Stock Take Job
      • inventory/stock_take_job/get
    • Supplier
      • inventory/supplier/add
      • inventory/supplier/edit
      • inventory/supplier/delete
      • inventory/supplier/get
    • Transfer Job
      • inventory/transfer_job/get
    • Transfer
      • inventory/transfer/add
      • inventory/transfer/edit
      • inventory/transfer/delete
      • inventory/transfer/get
  • Sale
    • Credit Note
      • sale/credit_note/add
      • sale/credit_note/edit
      • sale/credit_note/delete
      • sale/credit_note/get
      • sale/credit_note/getHistory
      • sale/credit_note/addHistory
    • Customer Group
      • sale/customer_group/add
      • sale/customer_group/edit
      • sale/customer_group/delete
      • sale/customer_group/get
    • Customer
      • sale/customer/add
        POST
      • sale/customer/edit
        POST
      • sale/customer/delete
        POST
      • sale/customer/get
        POST
      • sale/customer/addReward
        POST
      • sale/customer/getReward
        POST
    • Order
      • sale/order/add
      • sale/order/edit
      • sale/order/delete
      • sale/order/get
      • sale/order/getHistory
      • sale/order/addHistory
  • Setting
    • Channel Group
      • setting/channel_group/add
      • setting/channel_group/edit
      • setting/channel_group/delete
      • setting/channel_group/get
    • Company
      • setting/company/get
    • Credit Note Status
      • setting/credit_note_status/add
      • setting/credit_note_status/edit
      • setting/credit_note_status/delete
      • setting/credit_note_status/get
    • Currency
      • setting/currency/get
    • Language
      • setting/language/get
    • Order Status
      • setting/order_status/add
      • setting/order_status/edit
      • setting/order_status/delete
      • setting/order_status/get
    • Payment Method
      • setting/payment_method/add
      • setting/payment_method/edit
      • setting/payment_method/delete
      • setting/payment_method/get
    • User Group
      • setting/user_group/get
    • User
      • setting/user/get
  1. Customer

sale/customer/get

POST
/sale/customer/get
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.
search
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.
email
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
    }
  ]
}
Previous
sale/customer/delete
Next
sale/customer/addReward
Built with