List member benefits

GET 
/openapi/2026-01/loyalty/members/:member_id/benefits

Return the benefits available for a member's current tier

Request

Path Parameters

member_id stringrequired

Member ID from path

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object
member_idstring
Member ID
current_tier_namestring
Current tier name
benefits object[]
Benefit list
Array [
benefit_idstring
Benefit ID
namestring
Benefit name
descriptionstring
Benefit description
iconstring
Icon URL
benefit_typestring
Benefit type: point, coupon, discount_code, free_shipping, or custom
trigger_typestring
Trigger type: join_tier, birthday, or periodic
execution_schedule object
Execution schedule (corresponds to vo.ExecutionScheduleRule); strongly typed
typestring
Schedule type: time_range / weekly / monthly / cycle
effective_started_atstring
Effective start time, RFC3339 (empty means open-start)
effective_ended_atstring
Effective end time, RFC3339 (empty means open-end)
monthsstring[]
Months (effective when type=monthly), 1-12 as string
daysstring[]
Days. weekly: 0-6 (Sun-Sat); monthly: 1-31; otherwise unused
datestring
Specific date string (e.g. yyyy-MM-dd)
reward_config object[]
Reward config list
Array [
reward_typestring
Reward type: point / discount_code / custom
point_valueuint64
Points value when reward_type=point; 0 otherwise
discount_code_activity object
Discount code campaign payload when reward_type=discount_code; null otherwise
namestring
Campaign name
discount_typestring
Discount type: percentage / fixed_amount / free_shipping / bxgy
discount_valuestring
Discount value; percentage carries a numeric string (e.g. "10"); fixed_amount carries an amount string (e.g. "10.00"); free_shipping / bxgy leave it empty
prerequisite_typestring
Prerequisite condition type: none / subtotal / quantity
prerequisite_valuestring
Prerequisite condition value; amount string when subtotal, quantity when quantity
max_free_shippingstring
Max free-shipping amount (free-shipping only); -1 means unlimited. String preserves decimals
applicable_rule object
Applicable resource rule
applicable_typestring
Applicable type: all / include_products / include_collections
applicable_product_idsstring[]
Product IDs when applicable_type=include_products
applicable_variant_idsstring[]
Variant IDs when applicable_type=include_products
applicable_collection_idsstring[]
Collection IDs when applicable_type=include_collections
obtain_products object
Obtain products rule (BXGY only)
applicable_rule object
Applicable rule for obtainable products
applicable_typestring
Applicable type: all / include_products / include_collections
applicable_product_idsstring[]
Product IDs when applicable_type=include_products
applicable_variant_idsstring[]
Variant IDs when applicable_type=include_products
applicable_collection_idsstring[]
Collection IDs when applicable_type=include_collections
product_countuint32
Obtain product count
obtain_typestring
Obtain discount type: free / percentage / fixed_amount
obtain_valuestring
Obtain discount value; decimal string
use_with_otherboolean
Allow stacking with other discounts
limit_user_discountint32
Per-member campaign usage cap; -1 means unlimited
limit_code_user_discountint32
Per-member per-code usage cap; -1 means unlimited
limit_order_discountint32
Per-order usage cap; -1 means unlimited
limit_code_max_discountint32
Per-code total usage cap; -1 means unlimited
started_atstring
Campaign start time; ISO 8601 UTC
ended_atstring
Campaign end time; ISO 8601 UTC. Empty string means open-ended
custom_rewardobject
Custom reward payload when reward_type=custom; null otherwise (structure reserved)
]
point_expire_configobject
Point expire config. Only present when benefit_type is point
]

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "member_id": "string",
    "current_tier_name": "string",
    "benefits": [
      {
        "benefit_id": "string",
        "name": "string",
        "description": "string",
        "icon": "string",
        "benefit_type": "string",
        "trigger_type": "string",
        "execution_schedule": {
          "type": "string",
          "effective_started_at": "string",
          "effective_ended_at": "string",
          "months": [
            "string"
          ],
          "days": [
            "string"
          ],
          "date": "string"
        },
        "reward_config": [
          {
            "reward_type": "string",
            "point_value": 0,
            "discount_code_activity": {
              "name": "string",
              "discount_type": "string",
              "discount_value": "string",
              "prerequisite_type": "string",
              "prerequisite_value": "string",
              "max_free_shipping": "string",
              "applicable_rule": {
                "applicable_type": "string",
                "applicable_product_ids": [
                  "string"
                ],
                "applicable_variant_ids": [
                  "string"
                ],
                "applicable_collection_ids": [
                  "string"
                ]
              },
              "obtain_products": {
                "applicable_rule": {
                  "applicable_type": "string",
                  "applicable_product_ids": [
                    "string"
                  ],
                  "applicable_variant_ids": [
                    "string"
                  ],
                  "applicable_collection_ids": [
                    "string"
                  ]
                },
                "product_count": 0,
                "obtain_type": "string",
                "obtain_value": "string"
              },
              "use_with_other": true,
              "limit_user_discount": 0,
              "limit_code_user_discount": 0,
              "limit_order_discount": 0,
              "limit_code_max_discount": 0,
              "started_at": "string",
              "ended_at": "string"
            },
            "custom_reward": {}
          }
        ],
        "point_expire_config": {}
      }
    ]
  }
}