Promotions (promotion)

Function: promotion

Result: the list of elements

Promotions

Access level: admin

• id — Id

• name — Name

• fromdate — Start date

• todate — Expiry date

• status — Status

• project_name — Provider

Name

Function: promotion.archived

Result: the list of elements

Archive of promotion actions

Access level: admin

• id — Id

• name — Name

• fromdate — Start date

• todate — Expiry date

• status — Status

• project_name — Provider

Name

Function: promotion.discount

Result: the list of elements

Discounts

Access level: admin

• id — Id

• name — Name

• actiontype — Discount type

Delete

Function: promotion.discount.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 promotion.discount function.

Result: successful operation or error message

Edit the selected discount

Function: promotion.discount.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 promotion.archived function).
  • elid — unique identifier (id element of promotion.discount 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 promotion.archived 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 promotion.archived function).
  • elid — unique identifier (id element of promotion.discount function)
  • additional query parameters ...
• Result: successfull operation or error message

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

• type — Discount type. Select a discount type

• percentage — Discount. Discount in % on product/service

• actiontype — Type. Select a discount type. Please note, that discount given on renewal cannot be given on tariff plans with daily charges

• period — Order periods. This discount will be given on selected periods

• validity — Validity period. Select a discount validity period

• validitylength — Validity period, months. Select a discount validity period

Name

Function: promotion.condition

Result: the list of elements

Conditions

Access level: admin

• id — Id

• condition — Condition

• cgroup — Group of conditions

Delete

Function: promotion.condition.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 promotion.condition function.

Result: successful operation or error message

Promotion conditions

Function: promotion.condition.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 promotion.archived function).
  • elid — unique identifier (id element of promotion.condition 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 promotion.archived 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 promotion.archived function).
  • elid — unique identifier (id element of promotion.condition function)
  • additional query parameters ...
• Result: successfull operation or error message

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

• ctype — Condition. Promotion will be active, if the selected condition is met

• comparison — Comparison . Comparison condition

• period — Period. Order period

• periodtype — Period type. Period type

• periodlength — Period length. Period length

• amount — Number. Number of services of the selected type or tariff plan

• currency — Currency. Select currency

• summa — Amount. Amount in the selected currency

• affiliate — Affiliate program. Clients who were referred by the referral link will be able to participate in promotion

• account_group — Client group. This promotion will be available to members of this group

• group — Group of conditions. You can group conditions. The conditions will be grouped by the OR operator. The groups can be associated with each other by the AND operator. E.g. A, B, and C conditions are included into one group, and D and E conditions are included into another group. The result is (A OR B OR C) AND (D OR E)

• groupname — Group name. Enter the name of the conditions group

Name

Function: promotion.promocode

Result: the list of elements

Promo codes

Access level: admin

• id — Id

• code — Promo code

• uselimit — Usage limit

• use_count — Usage

Delete

Function: promotion.promocode.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 promotion.promocode function.

Result: successful operation or error message

Name

Function: promocode.usage

Result: the list of elements

Promo code usage

Access level: admin

• id — Service Id

• account — Client

• status — Status

• expense — Expenses

Edit properties of the selected promo code

Function: promotion.promocode.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 promotion.archived function).
  • elid — unique identifier (id element of promotion.promocode 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 promotion.archived 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 promotion.archived function).
  • elid — unique identifier (id element of promotion.promocode function)
  • additional query parameters ...
• Result: successfull operation or error message

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

• code — Promo code. Promo code template. The "?" signs will be changed into random values while generating a new promo code

• count — Number of promo codes. Enter the number of promo codes you want to generate

• uselimit — Usage limit. How many times this promo code can be used

• account_uselimit — Usage limit per client . How many times a client can use this promo code

• onlydigit — . (Optional parameter. To enable the option click "on".) Only digits will be used to generate a random number

• active_time_type — Period when the promo code can be activated. Period when the promo code can be activated

• fromdate — Start date. Enter the promo code start date

• todate — End date. Promo code expiration date

• expiretype — Promo code discount period . The promo code's discount can be used during the specified period

• periodtype — Period type. Period type

• periodlength — Period length. Period length

Name

Function: promotion.promocode.usage

Result: the list of elements

Promo code usage

Access level: admin

• promocode — Promo code

• id — Service Id

• account — Client

• status — Status

• expense — Expenses

Name has been changed from "_old_value " into " new_value_"

Function: promotion.history

Result: the list of elements

Promo change history

Access level: admin

• changedate — Change date

• desc — Description

• user — User

• ip — IP address

• action — Function

Delete

Function: promotion.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 promotion function.

Result: successful operation or error message

Add a new promotion

Function: promotion.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 promotion 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 promotion function)
  • additional query parameters ...
• Result: successful operation or error message

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

• name — Name. Enter a name for this payment method

• project — Provider. Select a service provider

• fromdate — Start date . Select a start date for this promo

• todate — End date. Select an end date for this promo (chosen date is included)

Move the selected promo to archive

Function: promotion.archive

Move the selected promo to archive

Access level: admin

Parameters:

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

Result: successful operation or error message

Set filter.

promotion.filter