Skip to main content
GET
Get all point earning rules

Headers

X-API-Key
string
required

API key for authentication

Query Parameters

includeInactive
boolean
default:false

Include inactive rules in response (default: false)

Response

Successfully retrieved point earning rules

basePoints
number<double>
required
customerNotification
string
required
includeShippingPoints
boolean
required
includeSubtotal
boolean
required
includeTax
boolean
required
name
string
required
status
enum<string>
required
Available options:
ACTIVE,
INACTIVE
type
enum<string>
required
Available options:
PURCHASE,
VISIT_SHOP,
REFERRAL,
CREATE_ACCOUNT,
FACEBOOK_PAGE_LIKE,
FOLLOW_TWITTER,
FOLLOW_INSTAGRAM,
BIRTHDAY,
LEAVE_REVIEW,
SUBSCRIBE_NEWSLETTER,
BUY_PRODUCT,
BUY_PRODUCT_FROM_COLLECTION,
LEAVE_REVIEW_STAMPED_IO,
LEAVE_REVIEW_LOOX_IO,
LEAVE_REVIEW_JUDGE_ME,
LEAVE_REVIEW_PRODUCT_REVIEWS,
SUBSCRIPTION,
YOUTUBE,
TIKTOK,
OKENDO,
HELPFULL_PRODUCT_REVIEWS,
RIVYO_PRODUCT_REVIEWS,
REVIEWS_IO,
QUANTITY_BASED_POINTS,
SUBSCRIBE_SMS,
VISIT_PINTEREST,
AIR_REVIEWS,
STATIC_EARN_RULE,
SHARE_ON_FACEBOOK,
SHARE_ON_X,
FIXED_REWARD
activityType
enum<string>
Available options:
REGULAR,
REFERRAL,
VIP
addAdditionalPhotoPoints
boolean
addAdditionalPoints
boolean
addAdditionalVideoPoints
boolean
additionalPhotoPoints
number<double>
additionalPoints
number<double>
additionalVideoPoints
number<double>
allowedCustomerTags
string
allowedOrderTags
string
allowedProductTags
string
appliesOn
enum<string>
Available options:
ONE_TIME,
SUBSCRIPTION,
BOTH
applyOnImportedCustomer
boolean
autoApprovalDays
integer<int32>
collectionData
string
collectionId
integer<int64>
createAt
string<date-time>
customerFacingIconUrl
string
customerFacingLabel
string
disableForOnSellProduct
boolean
disablePointsForDiscountedProduct
boolean
earnLimit
integer<int32>
earnType
enum<string>
Available options:
STORE_CREDIT,
DISCOUNT_CODE,
POINTS
eligibleForFirstOrder
boolean
enableBirthdayPromo
boolean
enableInterval
boolean
excludeCollections
string
excludeOrderTags
string
excludeProducts
string
excludeVariantIds
string
givePointsToGuestCustomers
boolean
historicPurchaseDuration
enum<string>
Available options:
NONE,
ALL,
ONE_HOUR,
ONE_DAY,
ONE_MONTH,
THREE_MONTH,
ONE_YEAR
id
integer<int64>
manuallyApprovePoints
boolean
maximumPoints
integer<int32>
minimumOrderValue
number<double>
platformType
enum<string>
Available options:
POS_ONLY,
ONLINE_STORE,
BOTH
pointBasedOn
enum<string>
Available options:
QUANTITY,
AMOUNT_SPEND,
FLAT_PURCHASE
pointsProvided
number<double>
productData
string
productId
integer<int64>
promoPointsMultiplier
number<double>
refundNotificationLabel
string
restrictCustomerTags
string
restrictProductTags
string
rewardAssignType
enum<string>
Available options:
DYNAMIC,
FIXED
rewardInterval
enum<string>
Available options:
DAY,
WEEK,
MONTH,
YEAR,
LIFETIME
rollBackPointsOnUnsubscribe
boolean
ruleEndDate
string<date-time>
ruleStartDate
string<date-time>
serial
integer<int32>
shop
string
showReviewProductDetails
boolean
socialUrl
string
translations
string
triggeredCount
integer<int64>
updateAt
string<date-time>
variantId
integer<int64>
vipTierId
integer<int64>