Menu Close

Get Support From ShopWired Close

All Systems Are Operational

Subscribe To Updates
Prefer To Live Chat? Chat directly with ShopWired support Available 9.00am to 7.00pm Monday to Friday
11.00am to 5.00pm Saturday
Quickest response time

Send A Message
Response within 24 hours

Menu Close

Menu

Customer

The customer object has the following attributes:

customer.id

Returns the unique platform ID for the customer.


customer.company

Returns the company name of the customer (only applicable if the customer is a trade customer).


customer.first_name

Returns the first name of the customer.


customer.last_name

Returns the last name of the customer.


customer.email

Returns the email address of the customer.


customer.phone

Returns the phone number of the customer.


customer.address_line1

Returns the first line of the address of the customer.


customer.address_line2

Returns the second line of the address of the customer.


customer.address_line3

Returns the third line of the address of the customer.


customer.city

Returns the city within the address of the customer.


customer.zip

Returns the zip or postal code of the customer


customer.state_id

Returns the ID of the state of the customer (only available if the customer is in the USA).


customer.province

Returns the county/province/state of the customer (only available if the customer is outside the USA).


customer.country_id

Returns the ID of the country of the customer. Country IDs are available here.


customer.trade

Returns true if the customer is a trade customer.


customer.reward_points

Returns an integer of the number of reward points the customer currently has within their account.


customer.accepts_marketing

Returns true if the customer has indicated they are willing to accept marketing communications.


customer.is_credit

On applicable to trade customers, returns true if the customer has been marked as a credit customer.


Trade customers only

There are 5 additional data fields that can be entered for a trade customer.

customer.additional_data[0]

customer.additional_data[1]

customer.additional_data[2]

customer.additional_data[3]

customer.additional_data[4]


customer.mobile_number

Returns the mobile number of the customer.


customer.website

Returns the website address entered of the customer.


customer.vat_number

Returns the VAT number entered of the customer.


customer.discount

Returns the global percentage trade discount entered for the customer.


customer.trade_group_name

Returns the name of the trade pricing band the customer belongs to.