# Get all point earning rules

Retrieves all configured point earning rules for the shop. These rules define how customers can earn points (purchases, sign-ups, referrals, etc.). Optionally includes inactive rules when includeInactive=true.

Endpoint: GET /api/external/point-earn-rules

## Header parameters:

  - `X-API-Key` (string, required)
    API key for authentication

## Query parameters:

  - `includeInactive` (boolean)
    Include inactive rules in response (default: false)

## Response 200 fields (application/json):

  - `id` (integer)

  - `shop` (string)

  - `type` (string, required)
    Enum: "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"

  - `status` (string, required)
    Enum: "ACTIVE", "INACTIVE"

  - `historicPurchaseDuration` (string)
    Enum: "NONE", "ALL", "ONE_HOUR", "ONE_DAY", "ONE_MONTH", "THREE_MONTH", "ONE_YEAR"

  - `basePoints` (number, required)

  - `includeSubtotal` (boolean, required)

  - `includeTax` (boolean, required)

  - `excludeCollections` (string)

  - `name` (string, required)

  - `customerNotification` (string, required)

  - `createAt` (string)

  - `updateAt` (string)

  - `rewardInterval` (string)
    Enum: "DAY", "WEEK", "MONTH", "YEAR", "LIFETIME"

  - `productId` (integer)

  - `collectionId` (integer)

  - `variantId` (integer)

  - `productData` (string)

  - `triggeredCount` (integer)

  - `pointsProvided` (number)

  - `collectionData` (string)

  - `customerFacingLabel` (string)

  - `socialUrl` (string)

  - `disableForOnSellProduct` (boolean)

  - `autoApprovalDays` (integer)

  - `enableInterval` (boolean)

  - `earnLimit` (integer)

  - `activityType` (string)
    Enum: "REGULAR", "REFERRAL", "VIP"

  - `allowedCustomerTags` (string)

  - `includeShippingPoints` (boolean, required)

  - `eligibleForFirstOrder` (boolean)

  - `maximumPoints` (integer)

  - `restrictCustomerTags` (string)

  - `customerFacingIconUrl` (string)

  - `serial` (integer)

  - `excludeOrderTags` (string)

  - `pointBasedOn` (string)
    Enum: "QUANTITY", "AMOUNT_SPEND", "FLAT_PURCHASE"

  - `excludeProducts` (string)

  - `givePointsToGuestCustomers` (boolean)

  - `allowedProductTags` (string)

  - `restrictProductTags` (string)

  - `rollBackPointsOnUnsubscribe` (boolean)

  - `addAdditionalPoints` (boolean)

  - `additionalPoints` (number)

  - `refundNotificationLabel` (string)

  - `disablePointsForDiscountedProduct` (boolean)

  - `platformType` (string)
    Enum: "POS_ONLY", "ONLINE_STORE", "BOTH"

  - `vipTierId` (integer)

  - `earnType` (string)
    Enum: "STORE_CREDIT", "DISCOUNT_CODE", "POINTS"

  - `minimumOrderValue` (number)

  - `allowedOrderTags` (string)

  - `excludeVariantIds` (string)

  - `rewardAssignType` (string)
    Enum: "DYNAMIC", "FIXED"

  - `applyOnImportedCustomer` (boolean)

  - `enableBirthdayPromo` (boolean)

  - `promoPointsMultiplier` (number)

  - `ruleStartDate` (string)

  - `ruleEndDate` (string)

  - `translations` (string)


## Response 401 fields