Difference between revisions of "Offerit API Edit Affiliate Sale"
From Offerit
OfferitJames (talk | contribs) (Created page with "{{Offerit Manual | show_api_admin_section = true }} This function allows you to edit an existing sale for a specfic affiliate. To use this function, you must make a SOAP call wit...") |
OfferitMegan (talk | contribs) |
||
(9 intermediate revisions by 3 users not shown) | |||
Line 2: | Line 2: | ||
| show_api_admin_section = true | | show_api_admin_section = true | ||
}} | }} | ||
− | This function allows you to edit | + | 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''' - ''(required)'' 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 | ||
== NuSOAP Example == | == NuSOAP Example == | ||
− | This example continues from the [[Offerit_API#Example|main article NuSOAP Example]] | + | This example continues from the [[Offerit_API#Example|main article NuSOAP Example]]: |
<pre> | <pre> | ||
− | $values = | + | $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' | |
− | + | ); | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | 'reason' => 'Mistakenly credited sale to the wrong offer' | ||
− | |||
− | $result = $client->call(' | + | $result = $client->call('set_aff_sales_edit', $values, 'offeritapiadmin_wsdl'); |
</pre> | </pre> | ||
− | == Sample Output == | + | === Sample Output === |
<pre> | <pre> | ||
− | + | On success: | |
− | + | array(3) { | |
+ | ["message"]=>string(12) "Edit Success" | ||
+ | ["customerid"]=>int(129) | ||
+ | ["orderid"]=>string(13) "AAAAAAAAAAAAA" | ||
+ | } | ||
− | + | On error: | |
error message | error message | ||
</pre> | </pre> | ||
− | |||
− |
Latest revision as of 13:52, 1 February 2013
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 - (required) 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
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_edit', $values, 'offeritapiadmin_wsdl');
Sample Output
On success: array(3) { ["message"]=>string(12) "Edit Success" ["customerid"]=>int(129) ["orderid"]=>string(13) "AAAAAAAAAAAAA" } On error: error message