Customers
Object Example
"customer": {
"id": 5014158,
"name": "John Smith",
"address": "1405 Lexington Ave, New York",
"address_second_line": null,
"zipcode": null,
"lat": 40.7833404,
"lng": -73.9527782,
"phone": "+9725555555555",
"image": "/images/avatar.png",
"email": "[email protected]",
"merchant_id": 11271,
"external_id": "EXT123",
"confirmation_code": "4895",
"client_version": null,
"client_name": null,
"mobile_type": 0,
"allow_login": false,
"extras": null,
"city": null,
"borough": null,
"state": null,
"street": null,
"business_code": null,
"language": null,
"customer_notes": []
}
Object Attributes
id Int32 |
The unique Id of this customer. |
access_token string |
This customer's access token for login. |
address string |
This customer's address. The maximum length is 255 characters. |
address_second_line string |
This customer's address second line, if needed. The maximum length is 255 characters. |
allow_login boolean |
Indicates whether this customer can login. The values are:
The default value is false. |
allow_sending_email boolean |
Indicates whether this customer allows email sharing. The values are:
The default value is true. |
allow_sending_sms boolean |
Indicates whether this customer allows SMS sharing.The values are:
The default value is true. |
approved boolean |
Indicates whether this customer was approved. Default value is false. |
blocked_email boolean |
Indicates whether this customer's email is blocked. The values are:
The default value is false. |
borough string |
This customer's borough. This can also be used for any neighborhood or zone. |
business_code string |
This customer's business code. |
city string |
This customer's city. |
client_name string |
The client name. |
client_version string |
The client version. |
confirmation_code string |
The confirmation code sent to this customer's phone for login verification. |
consecutive_checkins_out_of_geofence integer |
The number of times the user (driver) checked in outside of the geofence. |
created_at datetime |
The date and time this customer was created. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z". |
delete_at datetime |
The date and time this customer was deleted. The default is null. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z". |
dev boolean |
Indicates whether this customer belongs to a development account. |
district string |
This customer's district. |
string |
The email address of this customer. The default value is an empty string. |
encrypted_password string |
This customer's encrypted password. The default is null. |
external_id string |
The customer's external Id. |
extras object |
Internal Use. |
facebook_id string |
This customer's Id on Facebook. The maximum length is 255 characters. |
house_number Int32 |
The house number of this customer. |
image string |
The URL of an image associated with this customer. |
language string |
The language setting from this customer's app. This is a 2-letter code, for example "en" for English or "fr" for French. Note: This may be different than the company's default language. |
last_open_at datetime |
If this customer used the app, this is the date and time this customer last ordered using the app. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z". The default value is null. |
last_order_at datetime |
If this customer used the app, this is the date and time this customer last opened the app. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z". The default value is null. |
lat double |
The latitude of this customer's address. |
lng double |
The longitude of this customer's address. |
merchant_id Int32 |
The Id of the company. The merchant_id may be null, if the developer works with only one company. |
mobile_maker string |
The maker of the mobile. The default value is null. |
mobile_type Int32 |
The type of mobile. The default value is 0. |
mobile_version string |
The mobile version of the app. The default value is null. |
name string |
The name of this customer. The maximum length is 255 letters. |
original_lat double |
The original latitude of this customer's address when this customer was created. The default is null. |
original_lat_lng_changed datetime |
The date and time this customer's address latitude and/or longitude changed. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z". |
original_lng double |
The original longitude of this customer's address when this customer was created. The default is null. |
original_phone_number string |
This customer's original phone number, if the phone number changed. The default is the same phone number as phone. |
phone string |
The phone number of this customer. |
push_token string |
This customer's push token. |
reset_password_sent_at datetime |
The date and time the password was reset. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z". |
reset_password_token string |
The new password token after a reset. The maximum length is 255 characters. |
salt string |
Internal Use |
state string |
This customer's state. |
street string |
This customer's street. |
stripe_id Int32 |
This customer's Id in stripe for an application integration. This only applies to stripe integrations. The default value is null. |
updated_at datetime |
The date and time of the last update for this customer. The default value is the same as created_at. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z". |
uploaded_profile_image string |
The URL of a profile image associated with this customer. The default value is null. |
uuid uuid |
The universal unique Id of this customer. |
zipcode string |
This customer's ZIP Code. The default value is null. |
Updated almost 5 years ago