Response (Output) Params

Parameter

Description

success

boolean

Indicates whether the service completed successfully.

false - the service failed.
true - the service succeeded.

rc

Int32

If an error occurred, the return code.
{ success: true, rc: 0, customer: the customer details }
{ success: false, rc: 1, message: "customer not found" }
{ success: false, rc: 2, message: an array of validation error messages, like '[ "Name cannot be empty"]' or '[ "No updates were made because the data in the payload matched the existing data in the database."] }
{ success: false, rc: 0, message: a general error message } - this is what is returned for any unhandled exception

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:

false or 0 - customer cannot login
true or 1 - customer can login

The default value is false.

allow_sending_email

boolean

Indicates whether this customer allows email sharing. The values are:

false or 0 - customer does not allow email sharing
true or 1 - customer allows email sharing

The default value is true.

allow_sending_sms

boolean

Indicates whether this customer allows SMS sharing.The values are:

false or 0 - customer does not allow SMS sharing
true or 1 - customer allows SMS sharing

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.

email

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 Bringg ID of the merchant to which this customer belongs.

mobile_type

Int32

The type of mobile. The values are:

0 - unknown
1 - android
2 - ios
3 - windows

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.