Welcome‎ > ‎Version 3‎ > ‎Publisher Api‎ > ‎Data Structures‎ > ‎

Consumer

Will contain information about a consumer in the group commerce system.

Fields:
Field Data Type Nulls Description
consumerTypestring

The type of consumer record.  One of { Unknown, Visitor, Account }.
credits
CurrencyYThe amount of credits is the consumer's preferred currency.
email
string
Y Contains the consumer's email that will be the target for transactional emails. If the consumer does not have an email, this field will be null. 
firstName string

Contains the consumer's first name. Will contain {autocreated} if not yet defined.
lastName string

Contains the consumer's last name.  Will contain {autocreated} if not yet defined.
preferredIsoCurrencyCode
string

The consumer's preferred iso currency code such as USD or EUR.
userKeystring
 The consumer's userKey for this record.
 

Sample JSON Response:
{
    "credits": {
        "amount": 12.5,
        "isoCode": "USD",
        "symbol": "$"
    },
    "email": "smartin@email.com",
    "firstName": "Sylvester",
    "lastName": "Martin",
    "preferredIsoCurrencyCode": "USD"
}



Sample XML Response:
<consumer>
    <credits>
        <amount>12.50</amount>
        <isoCode>USD</isoCode>
        <symbol>$</symbol>
    </credits>
    <email>smartin@email.com</email>
    <firstName>Sylvester</firstName>
    <lastName>Martin</lastName>
    <preferredIsoCurrencyCode>USD</preferredIsoCurrencyCode>
</consumer>

Comments