Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Field

Description

String address1

Mailing address line 1

String address2

Mailing address line 2

String affiliateGroup

Name of the affiliate group they belong to. This must be a valid group name from the commissions tab under Affiliate Management

integer affiliateOid

Record identifier of the affiliate.

boolean allowGoogleAdwordsTracking

Whether or not the affiliate is allowed to use their Google Adwords tracking on your receipt page. If this is set to true you need to populate the googleConversionId for it to actually work.

boolean allowYahooSearchMarketingTracking

Whether or not the affiliate is allowed to use their Yahoo Search Marketing tracking on your receipt page. If this is set to true you need to populate the ysmAccountId for it to actually work.

String autoApplyCoupon

Coupon code to automatically to the customers account if they are referred by this affiliate.

boolean autoApproveCommissions

True if the commissions for sales by this affiliate should automatically be approved

String checkPayableTo

Name to make checks payable to.

String city

Mailling address city

String companyName

Name of the affiliate company for corporations

String country

Mailing address country

Calendar dob

Date of birth of the affiliate

String email

Email address of the affiliate

integer emailPreference

NONE = 0
DAILY = 1
WEEKLY = 2
MONTHLY = 3
PER_ORDER = 4

String fax

Fax number

String firstName

First name

String googleConversionId

The google adwords conversion id

boolean htmlPermitted

Set to true if you will allow the affiliate to utilize arbitrary conversion HTML on your receipt. This should only be allowed for the most trusted affiliates.

String lastName

Last name

String marketingStrategy

Description of their marketing strategy.

String password

Password

BigDecimal paymentAdjustment

(deprecated)

String paypalEmail

Email address to send their PayPal payments to

boolean payViaPayPal

True if the affiliate wants to receive payment via PayPal. You have to have PayPal Express checkout configured with MassPay to utilize this feature.

String phone

Phone number

String postalCode

Mailing address postal code (zip)

String state

Mailing address state

integer status

DISABLED = 0
ACTIVE = 1
PENDING = 2
DENIED = 3

String taxId

The social security number of FEIN of the affiliate.

boolean usingAdNetwork

True if they are using an ad network

boolean usingAdware

True if they are using adware

boolean usingBlog

True if they are using their blog

boolean usingOther

True if they are using an other form of advertising

boolean usingPerAcquistion

True if they are using a pay per acquisition system

boolean usingPpc

True if they are using a pay per click advertising system

boolean usingSeo

True if they are utilizing a website with only SEO techniques.

boolean usingWebsite

True if they are using their website

String websiteName

The name of their website if applicable

String websiteUrl

The URL of their website if applicable.

String ysmAccountId

Yahoo Search Marketing account ID.

AffiliateTierRelationship[] relationships

The relationship to other affiliates if this affiliate was recruited

...