Difference between revisions of "Offerit API Edit Affiliate Sale"

Revision as of 13:45, 26 October 2011

This function allows you to edit a sale for a specific affiliate. To use this function, you must make a SOAP call with the following parameters:

• orderid - Your unique orderid that will be associated with the OfferIt customer record
• customerid - The OfferIt Customer id
• amount - The amount of the sale
• offeritcode - This can be either the encoded, un-encoded, or shortname version of the OfferIt Code
• customer - OPTIONAL: The name of the array used to pass in customer data with the following elements:
  • username - The customer's User Name
  • password - The customer's Password
  • firstname - The customer's First name
  • lastname - The customer's Last name
  • address1 - The customer's Address
  • address2 - The customer's Address 2
  • zip - The customer's Zip Code
  • city - The customer's City
  • country - The customer's Country
  • state - The customer's State
  • shipping_firstname - The customer's Shipping First name
  • shipping_lastname - The customer's Shipping Last name
  • shipping_address1 - The customer's Shipping Address
  • shipping_address2 - The customer's Shipping Address 2
  • shipping_zip - The customer's Shipping Zip Code
  • shipping_city - The customer's Shipping City
  • shipping_country - The customer's Shipping Country
  • shipping_state - The customer's Shipping State
  • phone - The customer's Phone Number
  • email - The customer's Email Address
  • mailok - Can OfferIt send the customer an Email?
  • custom1 - Store custom data about the customer
  • custom2 - Store custom data about the customer
  • custom3 - Store custom data about the customer
  • custom4 - Store custom data about the customer
  • custom5 - Store custom data about the customer
• currency - OPTIONAL: The three-letter abbreviation of the currency type
• time - OPTIONAL: The time the sale occurred as a unix timestamp or mysql date format

<?xml version="1.0" encoding="ISO-8859-1"?>
<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" 
	xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" 
	xmlns:tns="urn:offeritapiadmin_wsdl">
	<SOAP-ENV:Body><tns:set_aff_sales_edit xmlns:tns="urn:offeritapiadmin_wsdl">
		<orderid xsi:type="xsd:string">AAAAAAAAAAAAA</orderid><customerid xsi:type="xsd:int">129</customerid>
		<amount xsi:type="xsd:string">10</amount><offeritcode xsi:type="xsd:string">2.1.1.1.0.0.0.0.0.0.0</offeritcode>
		<customer xsi:type="tns:Member"><firstname xsi:type="xsd:string">Ben</firstname><lastname xsi:type="xsd:string">Warren</lastname>
		<address1 xsi:type="xsd:string">1114 W. Campus Drive</address1><zip xsi:type="xsd:string">07751</zip><city xsi:type="xsd:string">Morganville</city>
		<country xsi:type="xsd:string">US</country><state xsi:type="xsd:string">NJ</state></customer>
		<reason xsi:type="xsd:string">Mistakenly credited sale to the wrong offer</reason><currency xsi:nil="true" xsi:type="xsd:string"/>
		<time xsi:nil="true" xsi:type="xsd:string"/></tns:set_aff_sales_edit>
	</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

</pre>

You will get a response similar to the following:

<?xml version="1.0" encoding="ISO-8859-1"?>
<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" 
	xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
	<SOAP-ENV:Body><ns1:set_aff_sales_editResponse xmlns:ns1="urn:offeritapiadmin_wsdl">
		<message xsi:type="xsd:string">Edit Success</message><customerid xsi:type="xsd:int">129</customerid><orderid xsi:type="xsd:string">AAAAAAAAAAAAA</orderid>
		</ns1:set_aff_sales_editResponse>
	</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

NuSOAP Example

This example continues from the main article NuSOAP Example):

$values = array(
    'orderid' => 'AAAAAAAAAAAAA',
    'customerid' =>129,
    'amount'=>10,
    'offeritcode'=>'2.1.1.1.0.0.0.0.0.0.0',
    'customer'=>Array(
        'firstname' => 'Ben',
        'lastname' => 'Warren',
        'address1' => '1114 W. Campus Drive',
        'zip' => '07751',
        'city' => 'Morganville',
        'country' => 'US',
        'state' => 'NJ'
    ),
    'reason'=>'Mistakenly credited sale to the wrong offer'
);
   
$result = $client->call('set_aff_sales_add', Array(), 'offeritapiadmin_wsdl');

Sample Output

On success:
  array(3) {
  ["message"]=>string(12) "Edit Success"
  ["customerid"]=>int(129)
  ["orderid"]=>string(13) "AAAAAAAAAAAAA"
}
   
On error:
      error message