EXPORT Buyers API 

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

 

Summary:

Returns and array of buyers and its properties. 


Resource/WSDL Page:

http://yourdomainhere/api/1/export.asmx?op=Buyers


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. 

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

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

 **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/Buyers?api_key=dNJFmId9rI&status_id=0&buyer_id=485

 

Sample XML Response:

<ArrayOfBuyer>
  <Buyer>
    <buyer_id>485</buyer_id>
    <buyer_name>Buyer 485</buyer_name>
    <status_name>Active</status_name>
    <website>www.cakemarketing.com</website>
    <billing_cycle>Weekly</billing_cycle>
    <credit_limit>0.0000</credit_limit>
    <credit_balance>783.6700</credit_balance>
    <tags/>
    <date_created>2011-07-21T12:31:51.397</date_created>
  </Buyer>
</ArrayOfBuyer>

 

Example Error Messages: 

Error Message

Likely Cause

Invalid API key

API key does not exist or is expired