PullCustomerKeys

Pulls API CustomerKeys matching a search.

Request Information

Parameters

Name	Description	Type	Additional information
ActivityStoreIds		Collection of integer
PartialName		string
Phone		string
DriverLicenseNumber		string
CustomerNumber		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

<CustomerSearchCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.BaseApi">
  <ChangedPeriodEnd>2025-04-28T13:25:51.9272392Z</ChangedPeriodEnd>
  <ChangedPeriodStart>2025-04-28T13:25:51.9272392Z</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>
  <CustomerNumber>sample string 4</CustomerNumber>
  <DriverLicenseNumber>sample string 3</DriverLicenseNumber>
  <MaximumUpdateStamp>2025-04-28T13:25:51.9272392Z</MaximumUpdateStamp>
  <MinimumUpdateStamp>2025-04-28T13:25:51.9272392Z</MinimumUpdateStamp>
  <PartialName>sample string 1</PartialName>
  <Phone>sample string 2</Phone>
</CustomerSearchCriteria>

Response Information

Resource Description

Collection of CustomerSummary

Name	Description	Type	Additional information
CustomerKey		string
ModifiedStamp		date
Placement		SourcePlacement

Sample Response

<ArrayOfCustomerSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.BaseApi">
  <CustomerSummary>
    <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 1</CustomerKey>
    <ModifiedStamp>2025-04-28T13:25:51.9272392Z</ModifiedStamp>
  </CustomerSummary>
  <CustomerSummary>
    <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 1</CustomerKey>
    <ModifiedStamp>2025-04-28T13:25:51.9272392Z</ModifiedStamp>
  </CustomerSummary>
</ArrayOfCustomerSummary>