PullCustomerVehicleKeys

Pulls API VehicleKeys matching a search.

Request Information

Parameters

Name	Description	Type	Additional information
ActivityStoreIds		Collection of integer
PartialVin		string
MaximumUpdateStamp		date
MinimumUpdateStamp		date
SourceIds		Collection of integer	Required
MaxElapsedSinceUpdate	Filter records that have been created or modified between the difference of now and this PullRepairOrders Notice: The length of time allowed is limited to 32 days.	time interval
ChangedPeriodStart	Filter records that have been created or modified starting with this Note: ChangedPeriodStart is not used by PullRepairOrders	date
ChangedPeriodEnd	Filter records that have been created or modified ending with this Note: ChangedPeriodEnd is not used by PullRepairOrders	date
SuppressErrors	If an error occurs in a multi-dealer pull, continue pulling from other dealers instead of failing the whole request.	boolean

Sample Request

<CustomerVehicleSearchCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.BaseApi">
  <ChangedPeriodEnd>2025-04-28T13:28:41.1705906Z</ChangedPeriodEnd>
  <ChangedPeriodStart>2025-04-28T13:28:41.1705906Z</ChangedPeriodStart>
  <MaxElapsedSinceUpdate>PT0.1234567S</MaxElapsedSinceUpdate>
  <SuppressErrors>true</SuppressErrors>
  <SourceIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </SourceIds>
  <ActivityStoreIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </ActivityStoreIds>
  <MaximumUpdateStamp>2025-04-28T13:28:41.1705906Z</MaximumUpdateStamp>
  <MinimumUpdateStamp>2025-04-28T13:28:41.1705906Z</MinimumUpdateStamp>
  <PartialVin>sample string 1</PartialVin>
</CustomerVehicleSearchCriteria>

Response Information

Resource Description

Collection of CustomerVehicleSummary

Name	Description	Type	Additional information
VehicleKey		string
CustomerKey		string
ModifiedStamp		date
Placement		SourcePlacement

Sample Response

<ArrayOfCustomerVehicleSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.BaseApi">
  <CustomerVehicleSummary>
    <Placement>
      <GroupId>4</GroupId>
      <GroupName>sample string 5</GroupName>
      <EnvironmentId>3</EnvironmentId>
      <EnvironmentType>Undefined</EnvironmentType>
      <DealerId>2</DealerId>
      <SourceId>1</SourceId>
    </Placement>
    <CustomerKey>sample string 2</CustomerKey>
    <ModifiedStamp>2025-04-28T13:28:41.1705906Z</ModifiedStamp>
    <VehicleKey>sample string 1</VehicleKey>
  </CustomerVehicleSummary>
  <CustomerVehicleSummary>
    <Placement>
      <GroupId>4</GroupId>
      <GroupName>sample string 5</GroupName>
      <EnvironmentId>3</EnvironmentId>
      <EnvironmentType>Undefined</EnvironmentType>
      <DealerId>2</DealerId>
      <SourceId>1</SourceId>
    </Placement>
    <CustomerKey>sample string 2</CustomerKey>
    <ModifiedStamp>2025-04-28T13:28:41.1705906Z</ModifiedStamp>
    <VehicleKey>sample string 1</VehicleKey>
  </CustomerVehicleSummary>
</ArrayOfCustomerVehicleSummary>