EXPORT BuyerContracts API Version 4
Updated on 2015-04-21
Current Version: Version 4
Deprecated Version:
Requests Allowed: GET&SOAP
Summary:
Returns an array of buyer contracts and its properties.
Resource/WSDL Page:
http://<your_domain_here>/api/4/export.asmx?op=BuyerContracts
Parameters
api_key | Must be a valid API key (existing and NOT expired). |
buyer_contract_status_id | If passing anything <= 0 the result will include all statuses. |
vertical_id | If passing anything <= 0 the result will include all verticals. |
buyer_contract_id | If passing anything <= 0 the result will include all buyer contracts.
|
buyer_id Required Type: INT Length (Max/Min): NA | If passing anything <= 0 the result will include all buyer contracts.
|
**Note all optional parameters still need to be passed through in the actual call. These parameters do not need a value (therefore you can use a null value).
Example Request
GET |
Sample XML Response:
<ArrayOfBuyerContract> <buyer_contracts> <buyer_contract> <buyer_contract_id>217</buyer_contract_id> <buyer_contract_name>TestContractAPI</buyer_contract_name> <buyer_contract_status> <buyer_contract_status_id xmlns="API:id_name_store">1</buyer_contract_status_id> <buyer_contract_status_name xmlns="API:id_name_store">Active</buyer_contract_status_name> </buyer_contract_status> <buyer> <buyer_id xmlns="API:id_name_store">171</buyer_id> <buyer_name xmlns="API:id_name_store">Test</buyer_name> </buyer> <vertical> <vertical_id xmlns="API:id_name_store">310</vertical_id> <vertical_name xmlns="API:id_name_store">Test Vertical</vertical_name> </vertical> <credit_type>Unlimited</credit_type> <credit_balance xsi:nil="true"/> <lead_cap> <limit xsi:nil="true"/> <interval> <cap_interval_id xmlns="API:id_name_store">0</cap_interval_id> <cap_interval_name xmlns="API:id_name_store">None</cap_interval_name> </interval> <start_date xsi:nil="true"/> </lead_cap> <buy_upsells>false</buy_upsells> <rank>0</rank> <posting_wait_seconds>0</posting_wait_seconds> <min_lead_age_minutes>0</min_lead_age_minutes> <max_lead_age_minutes>7200</max_lead_age_minutes> <max_post_errors>10</max_post_errors> <send_alert_only>false</send_alert_only> <max_return_days>30</max_return_days> <returns_owed>0</returns_owed> <replace_returns>false</replace_returns> <replacements_non_returnable>false</replacements_non_returnable> <vintage_leads>false</vintage_leads> <delivery_schedules/> <delivery_method> <url>http://www.google.com</url> <username/> <timeout xsi:nil="true"/> <delivery_emails/> <responses/> <xml_decode_response_tokens>false</xml_decode_response_tokens> <response_tokens/> <post_headers> <post_header> <header>Test</header> <value>Test</value> </post_header> </post_headers> </delivery_method> <ping_delivery_method> <url>http://www.google.com</url> <username/> <timeout xsi:nil="true"/> <responses/> <xml_decode_response_tokens>false</xml_decode_response_tokens> <response_tokens/> <ping_headers> <ping_header> <header>test</header> <value>test</value> </ping_header> </ping_headers> </ping_delivery_method> <filters/> <zip_code_filter_distance xsi:nil="true"/> <date_created>2015-04-23T17:55:21.387</date_created> </buyer_contract> </buyer_contracts> </buyer_contract_export_response> |
Example Error Messages:
Error Message | Likely Cause |
Invalid API Key | API Key does not exist or is expired. |