| success |
Type: Boolean |
Title: Status Response |
Boolean value indicating if the api request was successful |
| total_count |
Type: Number |
Title: Total Count |
the number of coupons returned |
| start_offset |
Type: Number |
Title: Start Offset |
the offset starting point for pagination of return data |
| id |
Type: Number |
Title: ID |
customer coupon id |
| account_id |
Type: Number |
Title: Account ID |
account id associated with the customer coupon |
| login |
Type: String |
Title: Login |
The login name of the customer |
| pw_email |
Type: String |
Title: Password Email |
The email for the customer password |
| ship_id |
Type: Number |
Title: Ship_ID |
Shipping id associated with the customer |
| ship_res |
Type: Boolean |
Title: Ship Residential |
Boolean value indicating if the shipping address is residential |
| ship_fname |
Type: String |
Title: Shipping First Name |
The first name of the customer |
| ship_lname |
Type: String |
Title: Shipping Last Name |
The last name of the customer |
| ship_email |
Type: String |
Title: Shipping Email |
The shipping email address for the customer |
| ship_comp |
Type: String |
Title: Shipping Company Name |
The company name of the customer |
| ship_phone |
Type: String |
Title: Shipping Phone Number |
The shipping phone number of the customer |
| ship_fax |
Type: String |
Title: Shipping Fax Number |
The shipping fax number of the customer |
| ship_addr1 |
Type: String |
Title: Shipping Address Field 1 |
The first shipping address field |
| ship_addr2 |
Type: String |
Title: Shipping Address Field 2 |
The second shipping address field |
| ship_city |
Type: String |
Title: Shipping City |
The city of the shipping address |
| ship_state |
Type: String |
Title: Shipping State |
The state of the shipping address |
| ship_zip |
Type: String |
Title: Shipping Zip Code |
The zip code of the shipping address |
| ship_cntry |
Type: String |
Title: Shipping COuntry |
The country of the shipping address |
| bill_id |
Type: Number |
Title: Billing ID |
billing id of the customer |
| bill_fname |
Type: String |
Title: Billing First Name |
The first name of the customer |
| bill_lname |
Type: String |
Title: Billing Last Name |
The last name of the customer |
| bill_email |
Type: String |
Title: Billing Email |
The shipping email address for the customer |
| bill_comp |
Type: String |
Title: Billing Company Name |
The company name of the customer |
| bill_phone |
Type: String |
Title: Billing Phone Number |
The billing phone number of the customer |
| bill_fax |
Type: String |
Title: Billing Fax Number |
The billing fax number of the customer |
| bill_addr1 |
Type: String |
Title: Billing Address Field 1 |
The first billing address field |
| bill_addr2 |
Type: String |
Title: Billing Address Field 2 |
The second billing address field |
| bill_city |
Type: String |
Title: Billing City |
The city of the billing address |
| bill_state |
Type: String |
Title: Billing State |
The state of the billing address |
| bill_zip |
Type: String |
Title: Billing Zip Code |
The zip code of the billing address |
| bill_cntry |
Type: String |
Title: Billing COuntry |
The country of the billing address |
| tax_exempt |
Type: Boolean |
Title: Status Tax Exempt Customer |
Boolean value indicating if the customer is tax exempt |
| order_cnt |
Type: Number |
Title: Customer Order Count |
The number of orders the customer has placed |
| order_avg |
Type: Number |
Title: Customer Order Average |
Average order total for the customer |
| formatted_order_avg |
Type: String |
Title: Currency Formatted Order Average |
Currency formatted average order total for the customer |
| order_tot |
Type: Number |
Title: Order Total |
Total amount of all orders for the customer |
| formatted_order_tot |
Type: String |
Title: Currency Formatted Order Total |
Currency formatted total amount of all orders |
| note_count |
Type: Number |
Title: Note Count |
Total number of notes for the customer |
| dt_created |
Type: Number |
Title: Customer creation date |
Unix timestamp for the customer creation date |
| dt_login |
Type: Number |
Title: Login Date |
Unix timestamp for the customer's most recent login date |
| dt_pwchg |
Type: Number |
Title: Password Change Date |
Unix timestamp for the date the customer changed their password |
| credit |
Type: Number |
Title: Customer Credit |
Amount of any customer credit on file |
| formatted_credit |
Type: String |
Title: Currency Formatted Customer Credit |
Currency formatted amount of any customer credit on file |
| business_title |
Type: String |
Title: Customer Business Title |
The customer's business title |
| assigned |
Type: Boolean |
Title: assigned |
Boolean value indicating if the customer is currently assigned to the coupon |