Use to create a new customer.
NOTE: Use a customer object for the body parameter, see JSON examples below.
Coming Soon: New Defaults for the Customer
kind
ParameterStarting May 15, 2024, the default logic for the
kind
parameter will be as follows:
- For orders with a single waypoint, the waypoint
kind
will defined as Customer.- For orders with two waypoints, the first waypoint (pickup)
kind
will be defined as Warehouse, and the second waypoint (drop off) will be defined as "Customer".To define a waypoint as an alternate kind, include an integer value with the
kind
parameter:
0
- Customer1
- Warehouse2
- Store3
- Locker4
- Fulfillment center
OUTPUT PARAMS
success boolean |
Indicates whether the service completed successfully.
|
rc Int32 |
If an error occurred, the return code. |
message string |
If an error occurred, a message indicating the error. |
id Int32 |
The unique Id of this customer. |
address string |
This customer's address. The maximum length is 255 characters. |
address_second_line text |
This customer's address second line, if needed. |
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. |
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. |
customer_notes Array of Note Objects |
An arry of note objects. |
string |
The email address of this customer. The default value is an empty string. |
external_id string |
The customer's external Id. |
extras Object |
Internal Use. |
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. |
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_type Int32 |
The type of mobile. The values are:
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. |
phone string |
The phone number of this customer. |
state string |
This customer's state. |
street string |
This customer's street. |
zipcode string |
This customer's ZIP Code. The default value is null. |