Sign in

v1

latestOpenAPI 3.0.12026-07-21161785.3 KB
Points & Earn Rules

Get all point earning rules

get/api/external/point-earn-rules

Query parameters

includeInactiveboolean

Include inactive rules in response (default: false)

Headers

X-API-Keystring required

API key for authentication

Response

Successfully retrieved point earning rules

activityType'REGULAR' | 'REFERRAL' | 'VIP'
addAdditionalPointsboolean
additionalPointsnumber double
allowedCustomerTagsstring
allowedOrderTagsstring
allowedProductTagsstring
appliesOn'ONE_TIME' | 'SUBSCRIPTION' | 'BOTH'
applyOnImportedCustomerboolean
autoApprovalDaysinteger
basePointsnumber double required
collectionDatastring
collectionIdinteger
createAtstring date-time
customerFacingIconUrlstring
customerFacingLabelstring
customerNotificationstring required
disableForOnSellProductboolean
disablePointsForDiscountedProductboolean
earnLimitinteger
earnType'STORE_CREDIT' | 'DISCOUNT_CODE' | 'POINTS'
eligibleForFirstOrderboolean
enableBirthdayPromoboolean
enableIntervalboolean
excludeCollectionsstring
excludeOrderTagsstring
excludeProductsstring
excludeVariantIdsstring
givePointsToGuestCustomersboolean
historicPurchaseDuration'NONE' | 'ALL' | 'ONE_HOUR' | 'ONE_DAY' | 'ONE_MONTH' | 'THREE_MONTH' | 'ONE_YEAR'
idinteger
includeShippingPointsboolean required
includeSubtotalboolean required
includeTaxboolean required
manuallyApprovePointsboolean
maximumPointsinteger
minimumOrderValuenumber double
namestring required
platformType'POS_ONLY' | 'ONLINE_STORE' | 'BOTH'
pointBasedOn'QUANTITY' | 'AMOUNT_SPEND' | 'FLAT_PURCHASE'
pointsProvidednumber double
productDatastring
productIdinteger
promoPointsMultipliernumber double
refundNotificationLabelstring
restrictCustomerTagsstring
restrictProductTagsstring
rewardAssignType'DYNAMIC' | 'FIXED'
rewardInterval'DAY' | 'WEEK' | 'MONTH' | 'YEAR' | 'LIFETIME'
rollBackPointsOnUnsubscribeboolean
ruleEndDatestring date-time
ruleStartDatestring date-time
serialinteger
shopstring
showReviewProductDetailsboolean
socialUrlstring
status'ACTIVE' | 'INACTIVE' required
translationsstring
triggeredCountinteger
type'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' required
updateAtstring date-time
variantIdinteger
vipTierIdinteger