List Reward Programs | Warely

Lists reward program definitions available to the authenticated SP Digital business.

Example curl:

curl --request POST '{{base_url}}/sp/reward-programs/list' \
  --header 'Authorization: Bearer {{access_token}}' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "search": "Silver",
    "per_page": 25,
    "page": 1
  }'

Example success response shape:

{
  "success": true,
  "message": "OK",
  "data": [
    {
      "program_id": 1,
      "membership_name": "Silver Rewards",
      "amount_for_unit_rp": 1,
      "minimum_order_total_to_earn_points": 10
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "per_page": 25,
      "current_page": 1,
      "last_page": 1,
      "from": 1,
      "to": 1
    }
  }
}

Example error response shape:

{
  "success": false,
  "message": "Unauthorized.",
  "error": {
    "code": "unauthorized",
    "details": {}
  }
}

Common platform errors:

sp_scope_not_granted
sp_token_scope_missing
legacy_field_not_allowed
query_parameters_not_allowed
invalid_content_type

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

200 OK Example

successbooleanOptional

messagestringOptional

datalist of objectsOptional

metaobjectOptional

Authentication

Headers

Response