Get Reward Settings | Warely

Retrieves business-level reward settings for the authenticated SP Digital business.

Example curl:

$ curl --request POST '{{base_url}}/sp/reward-settings/get' \
>   --header 'Authorization: Bearer {{access_token}}' \
>   --header 'Content-Type: application/json' \
>   --data-raw '{}'

Example success response shape:

1 {
2   "success": true,
3   "message": "OK",
4   "data": {
5     "enable_rp": true,
6     "rp_name": "Reward Points",
7     "rp_sales_calculation_period": 12,
8     "rp_sales_calculation_period_type": "month",
9     "rp_expiry_period": 12,
10     "rp_expiry_type": "month"
11   },
12   "meta": {}
13 }

Example error response shape:

1 {
2   "success": false,
3   "message": "Unauthorized.",
4   "error": {
5     "code": "unauthorized",
6     "details": {}
7   }
8 }

Common platform errors:

sp_scope_not_granted
sp_token_scope_missing
legacy_field_not_allowed
query_parameters_not_allowed
invalid_content_type

Retrieves business-level reward settings for the authenticated SP Digital business. Example curl: ```bash curl --request POST '{{base_url}}/sp/reward-settings/get' \ --header 'Authorization: Bearer {{access_token}}' \ --header 'Content-Type: application/json' \ --data-raw '{}' ``` Example success response shape: ```json { "success": true, "message": "OK", "data": { "enable_rp": true, "rp_name": "Reward Points", "rp_sales_calculation_period": 12, "rp_sales_calculation_period_type": "month", "rp_expiry_period": 12, "rp_expiry_type": "month" }, "meta": {} } ``` Example error response shape: ```json { "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

successboolean

messagestring

dataobject

metaobject