Adworkz Posting Specifications New Car Ping & Post

Transcription

1 Adworkz Posting Specifications New Car Ping & Post Version 3.2 (October 14th, 2014) This document assumes knowledge within the XML and Post environments. This document is current with the date posted above and will instruct how to post information to the Adworkz server and the responses to expect. Posting method Adworkz offers two options while posting New Car leads into our system. Ping & Post: "Single Sell Post" Adworkz will attempt to place your lead with the highest bidder with information sent in the ping. If the ping is accepted, you will have 1 minute and 45 seconds to post your valid lead information along with the transaction ID sent to you in the XML. If the lead "POST" is accepted, XML will be sent back to your system with commission included. If the potential buyer denies the post, we will discontinue all processing of the lead and send an XML back to your system with a denial reason. Post Multi: Sell Above Minimum Price This method allows publishers to maximize revenue by not depending on just the highest bidder for a lead sale. Adworkz will process your lead exactly as in our "Single Sell Post" with one exception. If your highest bidder denies your post, instead of stopping your lead, we will continue our sales attempts with the next highest bidder until we are able to place your lead or exhaust all possibilities that meet your minimum sale price specifications. Posting URL's: For Ping & Post: Ping: Post: For Post Multi: Testing Leads You will need the following information for testing: 1. Username: Testaff 2. Password: password 3. Use zip code for approvals and for denial responses. 4. Put your company name in the LEADID field.

2 5. Include all fields, even if the information in the field is not required. Please contact Adworkz (contact info below) prior to testing. We will reply to your letting you know we are ready to receive test leads from you. After you receive an accepted response, please copy and paste the XML ping and post you sent to us and the response you received from us into an to the "Technical Contact." If Adworkz can verify the test, the "Sales Contact" will issue live credentials to you. If you need support while trying to get an accepted response, please contact the "Technical Contact." Any questions not pertaining to testing lead delivery should be directed to our "Sales Contact." Ping Instructions Content Type: text/xml Ping URL: All fields are required although the information in the field may not be required. (i.e. <TRIMY></TRIM> must be inserted into your XML however, you do not have to provide the actual "TRIM" info between the > and <.) See example ping below. Ping Field Definitions: Field Required Description USERID YES Assigned User ID PASSWORD YES Assigned Password AFFILIATE_SUB_ID YES Your Affiliate's Identifier (Sub ID) MINIMUM_SALE_PRICE NO Minimum Price allowed for lead sale (If not specified all prices are valid) LEADID NO Pass through field (see restrictions for testing) CUSTZIP YES Home address zip code, No dashes or spaces YEAR YES Vehicle Model Year, in the form yyyy MAKE YES Vehicle Make MODEL YES Vehicle Model TRIM NO Vehicle Trim Example Ping XML:

3 <?xml version="1.0" encoding="utf-8"?> <NEW_CAR_PROCESSING> <AFFILIATE_INFO> <USERID>Testaff</USERID> <PASSWORD>password</PASSWORD> <AFFILIATE_SUB_ID>1</AFFILIATE_SUB_ID> <MINIMUM_SALE_PRICE>1.00</MINIMUM_SALE_PRICE> <LEADID>Adworkz</LEADID> </AFFILIATE_INFO> <LEAD_DATA> <CUSTZIP>99999</CUSTZIP> <YEAR>2000</YEAR> <MAKE>Ford</MAKE> <MODEL>Ranger</MODEL> <TRIM>XL</TRIM> </LEAD_DATA> </NEW_CAR_PROCESSING> Example Accepted Response: <APPLICATIONID>8</APPLICATIONID> *you will need this number to resend Post <TRANSACTIONDATE>6/11/2012 3:00:04 PM</TRANSACTIONDATE> <LOANSTATUS>G</LOANSTATUS> <APPSTATUS>A</APPSTATUS> <APPLICATIONURL></APPLICATIONURL> <COMMISSION>7.28</COMMISSION> *this is the offer Price Example Reject Response: <LEADSTATUS>I</LEADSTATUS> <APPSTATUS>D</APPSTATUS> <REASONID></REASONID> <REASONDESC></REASONDESC> <SUCCESS>0</SUCCESS> <MESSAGENUMBER></MESSAGENUMBER> <MESSAGEDESC></MESSAGEDESC> Example Error Response: <LEADSTATUS>I</LEADSTATUS> <APPSTATUS>D</APPSTATUS> <REASONID></REASONID> <REASONDESC></REASONDESC> <SUCCESS>0</SUCCESS> <MESSAGENUMBER></MESSAGENUMBER> <MESSAGEDESC>Er.MSG.</MESSAGEDESC> Post Instructions Post is used to follow up the accepted ping response with the full content of the lead, or to provide the full content of the lead for multi-post (which bypasses the ping entirely). If the Ping-Post method is being used, the APPLICATIONID field is required and must contain the ID returned by the Ping request.

4 Post Field Definitions Field Required Description USERID YES Assigned User ID PASSWORD YES Assigned Password APPLICATIONID YES Application Id returned by PING IPADDRESS YES IP address of applicant SOURCE_URL YES Web site URL where form was completed CUST_FNAME YES First Name CUST_LNAME YES Last Name HOME_PHONE YES 10 digits only, no dashes or spaces CELL_PHONE YES 10 digits only, no dashes or spaces May use home phone if not collected WORK_PHONE YES 10 digits only, no dashes or spaces YES Address CONTACT_METHOD YES How does the consumer want to be contacted? P = Phone, E = CONTACT_TIME YES Preferred time of day for contact? (Morning,Afternoon,Evening,Any) TIME_FRAME YES When does the consumer intend to purchase the vehicle? 1 = Now 2 = One week 3 = Two weeks 4 = One Month 5 = More than a month CUSTADDR YES Home Address CUSTCITY YES Home Address City CUSTSTATE YES Two character state abbreviation CUSTZIP YES Digits only, no dashes or spaces YEAR YES Vehicle Model Year, in the form yyyy MAKE YES Vehicle Make

5 MODEL YES Vehicle Model TRIM NO Vehicle Trim FINANCING YES Financing Method: 1 = Loan 2 = Lease 3 = Cash 4 = Credit Union 5 = Other TRADE_IN_YEAR NO Trade in vehicle model year TRADE_IN_MAKE NO Trade in vehicle make TRADE_IN_MODEL NO Trade in vehicle model TRADE_IN_MILEAGE NO Trade in vehicle current mileage, digits only Example Post XML

6 <?xml version="1.0" encoding="utf-8"?> <NEW_CAR_PROCESSING> <AFFILIATE_INFO> <USERID>Testaff</USERID> <PASSWORD>password</PASSWORD> <APPLICATIONID>8</APPLICATIONID> </AFFILIATE_INFO> <CUSTOMER_TRACKING> <IPADDRESS> </IPADDRESS> <SOURCE_URL> </CUSTOMER_TRACKING> <LEAD_DATA> <CUSTOMER_CONTACT> <CUST_FNAME>TEST</CUST_FNAME> <CUST_LNAME>TEST</CUST_LNAME> <HOME_PHONE> </HOME_PHONE> <CELL_PHONE> </CELL_PHONE> <WORK_PHONE> </WORK_PHONE> <CONTACT_METHOD>P</CONTACT_METHOD> <CONTACT_TIME>MORNING</CONTACT_TIME> <TIME_FRAME>2</TIME_FRAME> </CUSTOMER_CONTACT> <CUSTOMER_HOME> <CUSTADDR>PO BOX 710</CUSTADDR> <CUSTCITY>SPOKANE</CUSTCITY> <CUSTSTATE>WA</CUSTSTATE> <CUSTZIP>99999</CUSTZIP> </CUSTOMER_HOME> <VEHICLE_INFO> <YEAR>2003</YEAR> <MAKE>Ford</MAKE> <MODEL>Ranger</MODEL> <TRIM>XL</TRIM> <FINANCING>1</FINANCING> </VEHICLE_INFO> <TRADE_IN_INFO> <TRADE_IN_YEAR></TRADE_IN_YEAR> <TRADE_IN_MAKE></TRADE_IN_MAKE> <TRADE_IN_MODEL></TRADE_IN_MODEL> <TRADE_IN_MILEAGE></TRADE_IN_MILEAGE> </TRADE_IN_INFO> </LEAD_DATA> </NEW_CAR_PROCESSING> Example Accepted Response: <TRANSACTIONID> </TRANSACTIONID> <APPLICATIONID></APPLICATIONID> <LOANSTATUS>G</LOANSTATUS> <APPSTATUS>A</APPSTATUS> <APPLICATIONURL></APPLICATIONURL> <COMMISSION>Commission</COMMISSION> *Final Commission Price Example Reject Response:

7 <LEADSTATUS>I</LEADSTATUS> <APPSTATUS>D</APPSTATUS> <REASONID></REASONID> <REASONDESC></REASONDESC> <SUCCESS>0</SUCCESS> <MESSAGENUMBER></MESSAGENUMBER> <MESSAGEDESC></MESSAGEDESC> Example Error Response: <LEADSTATUS>I</LEADSTATUS> <APPSTATUS>D</APPSTATUS> <REASONID></REASONID> <REASONDESC></REASONDESC> <SUCCESS>0</SUCCESS> <MESSAGENUMBER></MESSAGENUMBER> <MESSAGEDESC>Er.MSG.</MESSAGEDESC> Sending Live Leads After confirming that an approved test lead was received, live credentials will be issued by our "Sales Contact." We require the process of sending live leads to begin on weekdays before noon, Pacific Standard Time (PST), so that we have time to monitor before the close of business that day. Please be sure to confirm with the "Technical Contact" before you begin sending live leads. Returning Leads We ask our Auto and New Car partners to submit and retrieve their returns through our extranet. You should receive your login credentials from Adworkz, but if you have not received them after going live, please ask for them. We will have our return files ready for you to retrieve shortly after 3:30 pm PST/6:30 pm EST on the 15th of each month or the following business day if the 15th falls on a weekend or holiday. Contact Information Mailing Address: Adworkz, Inc PO Box 710 Spokane, WA Street Address: Adworkz, Inc 10 N. Post Street, Suite 422 Spokane, WA Phone: 877-ADWORKZ (tel: ) ( ) Fax: (fax: ) Sales Contact Jason Coffman Phone: x200 (tel: ) jasonc@adworkz.com Technical Contact Jason Coffman Phone: x200 (tel: ) jasonc@adworkz.com

8