v1

latestOpenAPI 3.0.22026-07-2645239950.4 KB

List Member's Eligible Activities API

get/eligible-activities

Query parameters

start_cursorinteger

Defaults to 0. This is a cursor for use in pagination. start_index is the index that defines your place in the list. For instance, if you make a list request and receive 1000 objects, your subsequent call can include start_index=1001 in order to fetch the next page of the list.

countinteger

Defaults to 100. This is a limit on the number of objects to be returned. Count can range between 1 and 1000, and the default is 100.

languagestring

One of the store languages, for example english/ italian/ german, etc.

sort_bystring

The response will contain the activities ordered by the rank configured in the Zinrelo admin console. You can sort the sequence using the following options: "rank", "-rank", "created_date", "-created_date", "last_modified_date" or "-last_modified_date". Additionally, you can combine sorting options, such as "-rank,created_date", "-rank,-created_date", "-rank,-last_modified_date", "-rank,last_modified_date", "rank,created_date", or "rank,-created_date", "rank,-last_modified_date", or "rank,last_modified_date". "-" signifies the latest activity first. Note: If no sorting option is specified, the response will default to the saved rank, which is "rank,-last_modified_date".In scenarios where the rank of activities is same, sorting will be based on a second parameter. For example, in "rank,last_modified_date," if the ranks are identical, the sorting will then be determined by the last modified date parameter.

Response

200

activity_idstring

The unique ID of the activity assigned by Zinrelo.

enduser_activity_description_htmlstring

"Points earning description HTML" configuration in Zinrelo admin console.

activity_card_background_image_urlstring

"Activity Tile Image" configuration in Zinrelo admin console.

is_qualified_for_tier_upgradeboolean

The activity qualifies for a tier upgrade.

last_modified_datestring

The most recent date on which a transaction was updated.

enduser_activity_short_descriptionstring

"Description" configuration in Zinrelo admin console.

created_datestring

The date and time on which the transaction was created.

activity_namestring

The activity name stored with Zinrelo.

is_points_expiry_reset_activityboolean

The activity which resets expiry. To check and configure it, navigate to Program Settings>> Points Expiration.

idstring

The internal ID generated by Zinrelo.

activity_benefit_typestring

Activity benefit type is based on activity_type”

For 'fixed' activity types, the benefit type is 'points.'
For 'fixed and coupon-based' activity types, the benefit type is 'points_and_coupon_code.'
When the activity type is 'bonus_multiplier,' the benefit type is 'points.'
For 'bonus and coupon-based' activity types, the benefit type is 'points_and_coupon_code.'
For 'coupon-based' activity types, the benefit type is 'coupon_based.'"

Please Note: For coupon_based activity, the points_config will be empty.

Example response

{
  "points_config": {
    "points_computation_type": "multiplier_based",
    "attribute_to_multiply": "order_subtotal",
    "multiplier": 1
  },
  "extra_config": {
    "share_current_page_url": false,
    "pin_post_image": "",
    "pin_post_description": "Awesome products at great prices. You should really check them out.",
    "business_instagram_username": "pallavi"
  }
}