Shared Service: External Dealer

Gain insight into ways to provide efficient and effective support to external dealers through Shared Service.

Overview

This API is used to send a dealer that has been created or updated in one of Rollick systems (Rollick Salesforce and OEM Aimbase instances) to the shared service to be matched to an existing CommonDealerId or create a new CommonDealer Id. This will be used by Salesforce, but can be used by other internal systems to send dealers.

Related APIs:

To filter, sort and retrieve lead records across an Aimbase instance, use the Lead API Search endpoint.
To send activities (email, call, appointment, quote) performed on a lead, or a lead status change (working, sold, abandoned) use the Lead Disposition API.
Use the Lead Odata endpoint to update a lead record.

Possible Response Codes

201 (Created).This response indicates that the lead data was successfully parsed. The body of the response will contain the success or failure status for each lead that was submitted in the request. NOTE: The response record details for each lead will be returned in the order that they were submitted.
400 (Bad Request). Along with the 400 response, the body of the response will contain an error message describing why the request was a bad request.
500 (Internal Server Error). An unknown error occurred during the import

Authentication

This API uses a bearer token. Please see the Authentication - Bearer Token for more details.

Post Information

HTTP Endpoint

QA: https://sharedqa.aimbase.com/api/ExternalDealer

Production: https://shared.aimbase.com/api/ExternalDealer

Data SchemaData Schema

Shared Service	Required	Format	Notes
ExternalId	X	String	?
ExternalDealerSourceCode	X	String	System the dealer came from i.e. Salesforce or an OEM Aimbase
Name	X	String	Dealership name.
StreetAddress1		String	Dealer's primary address.
StreetAddress2		String	Dealer's secondary address.
City	X	String	Dealer's city.
State	X	String	Dealer's state.
PostalCode	X	String	Dealer's postal code.
CountryCode	X	String	Dealer's country code.
Phone		String	Dealer's phone number.
Contact		String	Dealer's primary contact.
Email		String	Dealer's email.
WebsiteUrl			Dealer's website URL.
IsActive	X		Dealer is active or not.

Example:

{
   "ExternalId": "123456789",
   "ExternalDealerSourceCode": "SalesForce",
   "CommonDealer": {
       "Uid": "801B7AFB-9ADD-487D-9C97-8F0D1FAD6D1F"
   },
   "Name": "Rocky Mountain RV Inc.",
   "Address": {
       "StreetAddress1": "5001 Harrison St",
       "StreetAddress2": "",
       "City": "Butte",
       "State": "MT",
       "PostalCode": "59701",
       "CountryCode": "US"
   },
   "StandardizedAddress": {
       "StreetAddress1": "5001 HARRISON AVE",
       "StreetAddress2": "",
       "City": "Butte",
       "State": "MT",
       "PostalCode": "59701",
       "CountryCode": "US"
   },
   "Phone": "406-494-2555",
   "Contact": "John Doe",
   "Email": "sales@rockymtnrv.com",
   "WebsiteUrl": "www.rockymtnrv.com",
   "Latitude": 45.947804,
   "Longitude": -112.509009,
   "IsActive": true
}

Response:

{
   "ExternalId": "123456789",
   "ExternalDealerSourceCode": "SalesForce",
   "CommonDealer": {
       "Uid": "801B7AFB-9ADD-487D-9C97-8F0D1FAD6D1F"
   },
   "Name": "Rocky Mountain RV Inc.",
   "Address": {
       "StreetAddress1": "5001 Harrison St",
       "StreetAddress2": "",
       "City": "Butte",
       "State": "MT",
       "PostalCode": "59701",
       "CountryCode": "US"
   },
   "StandardizedAddress": {
       "StreetAddress1": "5001 HARRISON AVE",
       "StreetAddress2": "",
       "City": "Butte",
       "State": "MT",
       "PostalCode": "59701",
       "CountryCode": "US"
   },
   "Phone": "406-494-2555",
   "Contact": "John Doe",
   "Email": "sales@rockymtnrv.com",
   "WebsiteUrl": "www.rockymtnrv.com",
   "Latitude": 45.947804,
   "Longitude": -112.509009,
   "IsActive": true
}

Rollick Knowledge