FUfullpath
shoppers

Get a single shopper

Retrieves a shopper by id.

Additional fields can be included in the response using the embed parameter. This endpoint supports all embed options available for the list endpoint, plus additional options only available for single shopper requests.

Embed options available for both list and single shopper:

  • primary_contact - Primary contact information (extended version with more fields in single shopper response)
  • latest_lead_date - Date of the latest lead (YYYY-MM-DD)
  • latest_sale_date - Date of the latest sale (YYYY-MM-DD)
  • latest_sale - Latest sale information
  • latest_lead - Latest lead information including vehicle details
  • adf_leads - Array of ADF leads
  • latest_marketing_touchpoint_date - Date of the latest marketing touchpoint (YYYY-MM-DD)
  • marketing_engagement_score - Marketing engagement score
  • loyalty_score - Loyalty score

Additional embed options available only for single shopper:

  • contacts - Array of all contacts associated with the shopper
  • location - Location information (city, state, zipcode, etc.)
  • score - Shopper score
  • public_link - Public link for the shopper
  • customer_lifetime_value - Customer lifetime value information (sales, services, total)
  • latest_sale_estimated_equity - Estimated equity from latest sale
  • household_flag - Whether this is a household shopper
  • customer_tags - Array of customer tags
  • is_enriched - Whether the shopper data has been enriched
  • salesperson - Assigned salesperson
  • group_shopper_id - Group shopper identifier
  • financial_durability_index - Financial durability index
  • aim_propensity_score - AIM propensity score

Multiple embed options can be specified as a comma-separated list, e.g., embed=primary_contact,contacts,location,customer_lifetime_value.

get/dealerships/{dealershipId}/shoppers/{id}

Request

Path parameters

dealershipIdinteger required

Dealership identifier (integer)

idinteger required

Shopper identifier (integer)

Query parameters

embedstring

Comma-separated list of fields to embed in the response.

Available for both list and single: primary_contact, latest_lead_date, latest_sale_date, latest_sale, latest_lead, adf_leads, latest_marketing_touchpoint_date, marketing_engagement_score, loyalty_score

Available only for single shopper: contacts, location, score, public_link, customer_lifetime_value, latest_sale_estimated_equity, household_flag, customer_tags, is_enriched, salesperson, group_shopper_id, financial_durability_index, aim_propensity_score

Response

Shopper found

idinteger required

Unique shopper identifier

latest_lead_datestring date nullable

Date of the latest lead (YYYY-MM-DD)

latest_sale_datestring date nullable

Date of the latest sale (YYYY-MM-DD)

latest_marketing_touchpoint_datestring date nullable

Date of the latest marketing touchpoint (YYYY-MM-DD)

latest_saleLatestSale nullable

Latest sale information for a shopper. Structure similar to LatestLead.

adf_leadsADFLead[]

Array of ADF leads

marketing_engagement_scorestring nullable

Marketing engagement score

loyalty_scorestring nullable

Loyalty score

scoreinteger nullable

Shopper score (single shopper only)

public_linkstring uri nullable

Public link for the shopper (single shopper only)

latest_sale_estimated_equitynumber nullable

Estimated equity from latest sale (single shopper only)

household_flagboolean nullable

Whether this is a household shopper (single shopper only)

customer_tagsstring[]

Array of customer tags (single shopper only)

is_enrichedboolean nullable

Whether the shopper data has been enriched (single shopper only)

salespersonstring nullable

Assigned salesperson (single shopper only)

group_shopper_idstring nullable

Group shopper identifier (single shopper only)

financial_durability_indexnumber nullable

Financial durability index (single shopper only)

aim_propensity_scorenumber nullable

AIM propensity score (single shopper only)

Example response

{
  "id": 16395039,
  "primary_contact": {
    "source": "customer",
    "first_name": "John",
    "last_name": "Doe",
    "full_name": "John Doe",
    "main_email_addresses": "john.doe@example.com",
    "cell_phone": "+15555551234",
    "home_phone": "+15555551235",
    "city": "Anytown",
    "state": "NY",
    "zipcode": "12345",
    "timestamp": "2024-01-15T10:30:00Z",
    "email": "john.doe@example.com",
    "full_address": "Anytown, NY, 12345"
  },
  "latest_lead_date": "2024-01-15",
  "latest_marketing_touchpoint_date": "2024-01-15",
  "latest_lead": {
    "id": "1234567890",
    "salesperson": "Jane Smith",
    "date": "2024-01-15",
    "up_type": "Internet",
    "source": "Website - Contact Form",
    "status": "Bad",
    "sub_status": "Duplicate lead",
    "vehicle": {
      "vin": "1HGBH41JXMN109186",
      "condition": "new",
      "year": "2024",
      "make": "Toyota",
      "model": "Camry",
      "trim": "LE"
    }
  },
  "adf_leads": [],
  "marketing_engagement_score": "10",
  "loyalty_score": "0",
  "contacts": [
    {
      "source": "crm_customer",
      "first_name": "John",
      "last_name": "Doe",
      "full_name": "John Doe",
      "main_email_addresses": "john.doe@example.com",
      "cell_phone": "+15555551234",
      "home_phone": "+15555551235",
      "city": "Anytown",
      "state": "NY",
      "zipcode": "12345",
      "timestamp": "2024-01-15T10:30:00Z",
      "status": "Active",
      "crm_link": "https://example.com/crm/customer/123456",
      "creation_date": "2024-01-15",
      "external_customer_id": "EXT123456"
    }
  ],
  "location": {
    "title": "Anytown, NY, 12345",
    "city": "Anytown",
    "state": "NY",
    "zipcode": "12345",
    "source": "customer"
  },
  "score": 10,
  "public_link": "https://example.com/s/abc123xyz",
  "customer_tags": [],
  "is_enriched": true,
  "salesperson": "Jane Smith",
  "group_shopper_id": "GRP123456789",
  "financial_durability_index": 8.46,
  "aim_propensity_score": 2.54
}

Changes

No recorded changes to this operation across all 2 revisions of this API.