CAKE Help & Support

EXPORT BuyerContracts API Version 1 (DEPRECATED)

Modified on: Wed, 23 Sep, 2015 at 5:34 PM


EXPORT BuyerContracts V1

Updated on 2014-03-26
Current Version: Version 1
Deprecated Version: 
Requests Allowed: GET&SOAP

 

Summary:

Returns an array of buyer contracts and its properties. 

Resource/WSDL Page:

http://<your_domain_here>/api/1/export.asmx?op=BuyerContracts

Parameters

api_key
Required
Type: STRING
Length (Max/Min): 50

Must be a valid API key (existing and NOT expired).

status_id
Required
Type: INT
Length (Max/Min): NA 

 If passing anything <= 0 the result will include all statuses.

vertical_id
Required
Type: INT
Length (Max/Min): NA

If passing anything <= 0 the result will include all verticals.

buyer_contract_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

http://demo.cakemarketing.com/api/1/export.asmx/BuyerContracts?api_key=dNJFmId9rI&status_id=0&vertical_id=1&buyer_contract_id=315

 

Sample XML Response:

<ArrayOfBuyerContract>
  <BuyerContract>
    <buyer_contract_id>315</buyer_contract_id>
    <buyer_contract_name>Buyer Contract 315</buyer_contract_name>
    <buyer_id>485</buyer_id>
    <buyer_name>Buyer 485</buyer_name>
    <vertical_name>Fast Food</vertical_name>
    <offer_id xsi:nil="true"/>
    <status_name>Active</status_name>
    <credit_remaining xsi:nil="true"/>
    <buy_upsells>true</buy_upsells>
    <rank>0</rank>
    <posting_wait_seconds>360</posting_wait_seconds>
    <min_lead_age_minutes>0</min_lead_age_minutes>
    <max_lead_age_minutes>7500</max_lead_age_minutes>
    <max_post_errors>2</max_post_errors>
    <max_return_days>7</max_return_days>
    <returns_owed>0</returns_owed>
    <replace_returns>true</replace_returns>
    <filters>
      <Filter>
        <filter_type>Min Debt Amount</filter_type>
        <parameter xsi:type="xsd:decimal">15000.0000</parameter>
      </Filter>
      <Filter>
        <filter_type>Max Debt Amount</filter_type>
        <parameter xsi:type="xsd:decimal">999999.0000</parameter>
      </Filter>
      <Filter>
        <filter_type>Contains State</filter_type>
        <parameter xsi:type="xsd:string">AL|AK|AZ|AR|CA|DC|FL|IN|IA|MD|MA|MN|MO|MT|NE|NV|NM|NY|OK|OR|PA|TX|VA|</parameter>
      </Filter>
    </filters>
    <zip_code_filter_distance xsi:nil="true"/>
    <date_created>2011-12-07T11:21:32.497</date_created>
  </BuyerContract>
</ArrayOfBuyerContract>

 

Example Error Messages: 

Error Message

Likely Cause

Invalid API Key

API Key does not exist or is expired.

 

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.
Login
New support ticket Check ticket status