Query for customers

GET 
/api/v3/customer

Notes:

• The superuser_id field is the primary contact (user) for this customer

Available query parameter values for filtering:

• customer_id
• parent_customer_id
• bill_state
• ship_state
• bill_country
• ship_country
• external_key
• token
• company
• superuser_id
• superuser_email
• custom_1
• custom_2
• custom_3
• custom_4
• custom_5
• write_datetime - date/time created
• mod_datetime - date/time last modified

Valid values for customer_status_state:

• a (for active customers)
• i (for customers who have manually been marked "inactive" or who have had no recent activity)

Valid values for customer_status_str:

• active-current
• active-overdue
• inactive-manual
• inactive-activity

Request

Query Parameters

where string

bill_country:EQUALS:Canada

order string

customer_id:ASC

limit string

2

offset string

8

Responses

200

Object was fetched successfully

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response object

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": {}
}

Example 1

{
  "code": 200,
  "status": "OK",
  "message": "",
  "response": [
    {
      "superuser_id": 357,
      "external_key": null,
      "company": "CA Test Customer 1",
      "email": "asgdadg@asdgaggd.com",
      "phone": "",
      "bill_addr1": null,
      "bill_addr2": null,
      "bill_addr3": null,
      "bill_city": null,
      "bill_state": null,
      "bill_postcode": null,
      "bill_country": "Canada",
      "bill_email": null,
      "bill_notes": null,
      "ship_addr1": null,
      "ship_addr2": null,
      "ship_addr3": null,
      "ship_city": null,
      "ship_state": null,
      "ship_postcode": null,
      "ship_country": null,
      "ship_email": null,
      "ship_notes": null,
      "write_datetime": "2013-08-22 08:57:09",
      "write_ipaddr": "172.16.16.102",
      "mod_datetime": "2013-08-22 08:57:09",
      "mod_ipaddr": "172.16.16.102",
      "display_as": "CA Test Customer 1",
      "ship_block": "",
      "bill_block": "Canada",
      "customer_id": 7
    }
  ]
}

400

Bad request

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 400,
  "status": "Error",
  "message": "Missing or invalid parameter.",
  "details": {},
  "response": false
}

401

Authentication error

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 401,
  "status": "Error",
  "message": "Invalid or incorrect authorization [Missing (basic) authorization header.]",
  "details": {},
  "response": false
}

Loading...