GuidesAPI Reference
Log In
API Reference

Create Customer

Use to create a new customer.

Body Params
string

The address of the new customer. Must be geolocated in Google Maps. The maximum length is 255 characters.

string

The address second line of the new customer, if needed. For example, "First floor" or "Apartment 1".

boolean

Indicates whether the new customer can login. The values are: false or 0 - customer cannot login, true or 1 - customer can login.

boolean

Indicates whether the new customer allows email sharing. The values are: false or 0 - customer does not allow email sharing, true or 1 - customer allows email sharing. Default is "true".

boolean

Indicates whether the new customer allows SMS sharing.The values are: false or 0 - customer does not allow SMS sharing, true or 1 - customer allows SMS sharing. Default is "true".

string

The new customer's borough. This can also be used for any neighborhood or zone.

string

The new customer's city.

string

The confirmation code sent to the new customer's phone for login verification.

string

The new customer's district.

string

The email address of the new customer. The default value is an empty string.

string

The new customer's external ID (in your own system).

boolean

Indicates whether there is a loading/unloading zone at the destination.

int32

The house number of this customer.

string

The URL of an image associated with the new customer.

int32

Indicates the waypoint type. Possible values:
0 - Customer
1 - Warehouse
2 - Store
3 - Locker
4 - Fulfillment center

string

The language setting from the new 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.

float

The latitude of the new customer's address.

float

The longitude of the new customer's address.

string

The name of the new customer. The maximum length is 255 letters.

string

The phone number of the new customer.

int32

Gives priority between customers when using Route Optimization or AutoDispatch. null is the lowest rank, 1 is the highest rank (for example rank null < rank 3 < rank 2 < rank 1). 0 in not accepted.

string

The new customer's state.

string

The new customer's street.

string

An array of the team id's for the teams responsible for delivery to this customer.

string

The new customer's ZIP Code. The default value is null.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
LoadingLoading…
Response
Choose an example:
application/json