List redemption campaigns

GET 
/openapi/2026-01/loyalty/redemption-campaigns

Return campaigns where members can redeem points for discount codes

Request

Query Parameters

member_id string

Optional member ID. When present, only campaigns redeemable by this member are returned

status string

Campaign status: active or inactive. Empty returns all

cursor string

Pagination cursor

limit int32

Page size. Default 50, max 200

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

active_pointsint64

Member active points. Returned when the request contains a member ID

items object[]

Campaign list

Array [

campaign_idstring

Campaign ID

namestring

Campaign name

event_typestring

Event type, for example redeem_discount_code

activity_typestring

Activity type: order_discount, product_discount, free_shipping, or buy_x_get_y

activeboolean

Whether the campaign is active

redeem_pointsint64

Points required per redemption

limit_redeem_countint32

Per-member max redemption count. Zero means unlimited

member_used_timesint64

Times this member has redeemed. Returned only with member context

execution_schedule object

Execution schedule rule (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)

member_condition object

Applicable member range

typestring

Type: scope or expression

scopeobject

Scope payload when type is scope

expressionobject

Expression payload when type is expression

campaign_reward object

Campaign reward config

discount_code_activity object

Discount-code activity config; present when event_type=redeem_discount_code

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

]

next_cursorstring

Next-page cursor

has_moreboolean

Whether more pages exist

limitint32

Returned page size

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "active_points": 0,
    "items": [
      {
        "campaign_id": "string",
        "name": "string",
        "event_type": "string",
        "activity_type": "string",
        "active": true,
        "redeem_points": 0,
        "limit_redeem_count": 0,
        "member_used_times": 0,
        "execution_schedule": {
          "type": "string",
          "effective_started_at": "string",
          "effective_ended_at": "string",
          "months": [
            "string"
          ],
          "days": [
            "string"
          ],
          "date": "string"
        },
        "member_condition": {
          "type": "string",
          "scope": {},
          "expression": {}
        },
        "campaign_reward": {
          "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"
          }
        }
      }
    ],
    "next_cursor": "string",
    "has_more": true,
    "limit": 0
  }
}