Skip to content

Latest commit

 

History

History
56 lines (47 loc) · 1.12 KB

customers.md

File metadata and controls

56 lines (47 loc) · 1.12 KB

customers

GET /api/v1/customers

Required scope: read_people, people

Sample Model

{
	"id": 1,
	"customer_number": "",
	"last_name": "Allen",
	"first_name": "Chris",
	"email": "test@not-my-real-address.zzz",
	"phone_number": "555-555-5555",
	"registered_at": "2004-10-08T00:00:00-05:00",
	"last_visit_at": "2005-09-08T13:48:55-05:00",
	"adcode": "",
	"adcode_id": 0,
	"affiliate_id": 0,
	"customer_type_id": 1,
	"is_no_tax_customer": false,
	"comments": "",
	"store_id": 1,
	"source": "",
	"search_string": "",
	"no_account": false,
	"sales_person": "",
	"alternate_phone_number": "",
	"is_affiliate_customer": false,
	"updated_at": "2005-09-08T13:48:55-05:00",
	"created_at": "2004-10-08T00:00:00-05:00",
	"username": "chris",
	"is_contact_information_only": false,
	"tax_exemption_number": "",
	"company": "AmeriCommerce",
	"source_group": "",
    "store_payment_methods_enabled": ["Purchase Orders","Checks"]
}

Nested Resources

Accessible via the ?expand= parameter or /api/v1/customers/{id}/{nested_resource}.

addresses

custom_fields

reward_points