...
Method Signature Affiliate createAffiliate(Credentials c, Affiliate affiliate);
Description
This method will create a new affiliate within the UltraCart account. If the affiliate already exists (email is how we identify affiliates) than an exception will be thrown.
Parameters Credentials c - – The credentials of the API user that is making the call.Affiliate affiliate - – The affiliate record to create within the UltraCart account
Result Affiliate - – The returned affiliate object will contain a populated affiliateOid value. You may want to consider databasing this value within your internal system.
...
Method Signature Affiliate getAffiliate(Credentials c, int affiliateOid);
Description
Fetches a specific affiliate using the affiliateOid returned from a call to createAffiliate.
Parameters Credentials c - – The credentials of the API user that is making the call. int affiliateOid - – the affiliate identifier returned from a call to createAffiliate
Result Affiliate - – If the affiliate is found then their record will be returned. If there is no affiliate with the affiliate identifier then a null value will be returned.
...
Method Signature Affiliate getAffiliateByEmail(Credentials c, String email);
Description
Fetches an affiliate record using their email address.
Parameters Credentials c - – The credentials of the API user that is making the call. String email - – emai address of the affiliate.
Result Affiliate - – if the affiliate is found then their record will be returned. If there is no affiliate with a matching email address then a null value will be returned.
...
Method Signature Affiliate[] getAffiliates(Credentials c);
Description
Fetches a copy of all the affiliates within the UltraCart account.
Parameters Credentials c - – The credentials of the API user that is making the call.
Result Affiliate[] - – an array of all the affiliates within the UltraCart account.
...
Method Signature AffiliateLedger[] getLedgersForAffiliateOrder(Credentials c, int affiliateOid, String orderId);
Description Fetches all the ledger records for an order associated with a given affiliate.
Parameters Credentials c - – The credentials of the API user that is making the call. int affiliateOid - – the affiliate identifier. String orderId - the order ID to return records for.
Result AffiliateLedger[] - an array of the ledger records associated with the order and affiliate.
...
Method Signature void updateAffiliate(Credentials c, Affiliate affiliate);
Description
This method will update an affiliate record within the UltraCart system. If the affiliate does not exist an exception will be thrown.
Parameters Credentials c - – The credentials of the API user that is making the call.Affiliate affiliate - – the affiliate record to update.
Result None