Customer Model
The Customer model a customer defined by your shop. Customers allow you to quickly define the recipient information for a given order. Customers are typically defined for customers who order more than a single time.
RESTful Calls
Get All Customers
GET/customers
Get all Customers associated with your account.
Request Parameters
This request has no parameters.
Response
Name
Type
Example
Description
customers
customer[]
The customers associated with your account.
customer
Object
A customer object.
id
integer
342
The database key.
code
string
CU0034
The code assigned to the customer by the shop.
name
string
คุณ พวริด
The name of the customer.
phone_number
string
0899969094
The phone number of the customer.
email
string
customer@domain.com
The email address of the customer.
social_id
string
MyLineId
This is a social media id for the customer (e.g. Facebook ID or Line ID
address
string
32/1 สุขุมวิท 62, กรุงเทพฯ
The physical address of the customer.
postcode
string
10260
The postcode of the customer.
note
string
This is a special order.
A text note provided for this customer.
Get Customer
GET/customers/{id}
Get the customer specified by the id paramter.
Request Parameters
This request has no parameters.
Response
Name
Type
Example
Description
customer
Object
A customer object.
id
integer
342
The database key.
code
string
CU0034
The code assigned to the customer by the shop.
name
string
คุณ พวริด
The name of the customer.
phone_number
string
0899969094
The phone number of the customer.
email
string
customer@domain.com
The email address of the customer.
social_id
string
MyLineId
This is a social media id for the customer (e.g. Facebook ID or Line ID
address
string
32/1 สุขุมวิท 62, กรุงเทพฯ
The physical address of the customer.
postcode
string
10260
The postcode of the customer.
note
string
This is a special order.
A text note provided for this customer.
MODELS
customer
Object: customer
Name
Type
Example
Description
customer
Object
A customer object.
id
integer
342
The database key.
code
string
CU0034
The code assigned to the customer by the shop.
name
string
คุณ พวริด
The name of the customer.
phone_number
string
0899969094
The phone number of the customer.
email
string
customer@domain.com
The email address of the customer.
social_id
string
MyLineId
This is a social media id for the customer (e.g. Facebook ID or Line ID
address
string
32/1 สุขุมวิท 62, กรุงเทพฯ
The physical address of the customer.
postcode
string
10260
The postcode of the customer.
note
string
This is a special order.
A text note provided for this customer.