Get Voucher | Warely

Retrieves a single voucher definition for the authenticated SP Digital business.

Example curl:

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

Example success response shape:

1 {
2   "success": true,
3   "message": "OK",
4   "data": {
5     "voucher_id": 10,
6     "campaign_name": "Birthday Voucher",
7     "coupon_code": "BIRTHDAY10",
8     "coupon_value": 10,
9     "archived": false
10   },
11   "meta": {}
12 }

Example error response shape:

1 {
2   "success": false,
3   "message": "Voucher not found.",
4   "error": {
5     "code": "voucher_not_found",
6     "details": {}
7   }
8 }

Common platform errors:

sp_scope_not_granted
sp_token_scope_missing
sp_location_not_allowed
legacy_field_not_allowed
query_parameters_not_allowed
invalid_content_type

Retrieves a single voucher definition for the authenticated SP Digital business. Example curl: ```bash curl --request POST '{{base_url}}/sp/vouchers/get' \ --header 'Authorization: Bearer {{access_token}}' \ --header 'Content-Type: application/json' \ --data-raw '{ "voucher_id": {{voucher_id}} }' ``` Example success response shape: ```json { "success": true, "message": "OK", "data": { "voucher_id": 10, "campaign_name": "Birthday Voucher", "coupon_code": "BIRTHDAY10", "coupon_value": 10, "archived": false }, "meta": {} } ``` Example error response shape: ```json { "success": false, "message": "Voucher not found.", "error": { "code": "voucher_not_found", "details": {} } } ``` Common platform errors: - `sp_scope_not_granted` - `sp_token_scope_missing` - `sp_location_not_allowed` - `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