Affiliate programs (affiliate)

Function: affiliate

Result: the list of elements

Affiliate programs

Access level: admin

• id — Id

• locale_name — Name

• reward — Reward, %

• period — Referral period, month

• locale_url — Site URL

• project_name — Provider

Delete

Function: affiliate.delete

Delete

Access level: admin

Parameters:

• elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of affiliate function.

Result: successful operation or error message

Edit properties of the selected affiliate program

Function: affiliate.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid — unique identifier (id element of affiliate function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok — the parameter must not be empty, generally "ok".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok — the parameter must not be empty, generally "ok".
  • elid — unique identifier (id element of affiliate function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• project — Provider. Select a provider who offers this affiliate program

• name — Name. Enter the name for the affiliate program that will be displayed to your client

• promocode — Promo code template. Enter a promo code template. Use where you want to insert the affiliate's Id. If a referral enters the promo code corresponding to this template, the system will consider the affiliate to refer the client

• reward — Reward. Enter the percentage of the referral expenses, which you wish to pay to an affiliate as referral bonus at the beginning of the next month

• period — Referral period . Period in months during which a client will receive percentage of all referral's expenses

• url — Web-site URL. URL to the provider's site. Each affiliate will have a unique link. A client's id will be added to the end of the URL

• account_group — Client group. Select a client group that will join the affiliate program

• account_group_restrict — Forbid for group members. Clients of the selected group won't be rewarded

Name

Function: affiliate.reward

Result: the list of elements

Affiliate program expenses

Access level: admin

• cdate — Date

• amount — Amount

Client

Function: affiliate.reward.partner

Result: the list of elements

Affiliate program expenses

Access level: admin

• id — Id

• name — Client

• amount — Amount

Drill down to User panel

Function: affiliate.reward.partner.su

Drill down to User panel

Access level: admin

Name

Function: affiliate.itemtype

Result: the list of elements

Special rules for affiliate rewards

Access level: admin

• id — Id

• locale_name — Product type

• pricelist_locale_name — Tariff

• reward — Reward, %

Edit the selected rule

Function: affiliate.itemtype.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • plid — parent list unique identifier (id element of affiliate function).
  • elid — unique identifier (id element of affiliate.itemtype function)
• Result: object parameters list

Create an object:

Parameters:

• sok — the parameter must not be empty, generally "ok".
  • plid — parent list unique identifier (id element of affiliate function).
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok — the parameter must not be empty, generally "ok".
  • plid — parent list unique identifier (id element of affiliate function).
  • elid — unique identifier (id element of affiliate.itemtype function)
  • additional query parameters ...
• Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

• reward — Reward. Percentage of referral expenses for the services of the selected type

Delete

Function: affiliate.itemtype.delete

Delete

Access level: admin

Parameters:

• elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of affiliate.itemtype function.

Result: successful operation or error message