Skip to main content

Get filtered dealers with live/provisioning status and address​

Returns all valid, non-test dealers with their addresses and live status. Optional filter criteria can be provided to filter results by status, DMS type, brand, dealer group, and/or products. When no filter criteria is provided, all valid non-test dealers are returned.
ApiScope: manage.dealer.read.internal
API Scope Level: ServiceSubscriberScope

Request Body

Optional filter criteria. If null or empty, returns all valid dealers.

    dealerLiveStatusCodes string[]

    Filter by dealer live status codes (OR logic). Dealer matches if they have ANY of these statuses. Valid values: LIVE, IN_PROVISIONING, CANCELED, CANCELED_READ_ONLY, TEST

    dmsTypeIds int64[]

    Filter by DMS type IDs (OR logic). Dealer matches if they have ANY of these DMS types.

    brandUuids string[]

    Filter by brand UUIDs (OR logic). Dealer matches if they belong to ANY of these brands.

    dealerGroupUuids string[]

    Filter by dealer group UUIDs (OR logic). Dealer matches if they belong to ANY of these dealer groups.

    productFilter object

    Product filter criteria with AND/OR/NOT logic for dealer filtering. All conditions are combined with AND logic. Empty/null fields are ignored.

    mustHaveAllProducts string[]

    Product keys that the dealer MUST have ALL of (AND logic). Dealer must have Product A AND Product B AND Product C.

    mustHaveAnyProductGroups array[]

    List of OR groups where the dealer MUST satisfy ALL groups (AND between groups). Each group requires the dealer to have AT LEAST ONE product from that group (OR within group). Example: [["service-cart", "servicecart-premium"], ["appt-scheduler", "appt-scheduler-plus"]] means (ServiceCart Regular OR Premium) AND (Scheduler OR Scheduler Plus).

    mustNotHaveProducts string[]

    Product keys that the dealer MUST NOT have (exclusion). Dealer must NOT have Product M AND NOT have Product N.

Responses

OK

Schema
    errors object[]
  • Array [
    • errorCode int32
    errorTitle string
    errorMessage string
  • ]
    • warnings object[]
  • Array [
    • warningCode int32
    warningTitle string
    warningMessage string
  • ]
    • apiRequestId string
    dealers object
    property name* DealerWithAddressDTO
    dealerUuid string
    dealerName string
    dealerId int64
    isValid boolean
    dealerLiveStatus string
    address object
    line1 string
    line2 string
    city string
    zip string
    zipExt string
    phone string
    stateCode string
    stateDescription string
    countryCode string
    country string
    latitude double
    longitude double
    altitude float
Loading...