پرش به مطلب اصلی

فعال کردن کد تخفیف (Enable Voucher)

برای فعال‌سازی یک کد تخفیف استفاده می‌شود.


اطلاعات عمومی

  • آدرس: /api/v2/purchased-voucher/{id}/enabled
  • متد: PATCH
  • نوع محتوا: application/json
  • احراز هویت: نیازمند token

احراز هویت

  • این درخواست نیاز به یک Authorization token دارد که باید در هدر ارسال شود.

پارامترهای مسیر

پارامترنوع دادهضروریتوضیحات
idintegerبلهشناسه کد تخفیف خریداری‌شده

بدنه درخواست

فیلدنوع دادهضروریتوضیحات
enabledbooleanبلهوضعیت فعال (true) یا غیرفعال (false)

نمونه درخواست

curl --location --request PATCH 'https://corporate.snapp.site/api/v2/purchased-voucher/5113/enabled' \
--header 'Authorization: <your_authorization_token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"enabled": false
}'

پاسخ موفق

{
"message": "Success",
"data": {
"id": 5113,
"title": "تست حذف کاربر از لیست",
"voucher_code": "UVJNFHUSJN-0005",
"type": 1,
"mode": 1,
"bulk_count": 0,
"percent_value": 10,
"static_value": 0,
"value_cap": 10000,
"user_max_use_times": 10,
"total_max_use_times": 50,
"start_date": "1403/11/06 00:00:00",
"end_date": "1403/12/11 23:59:59",
"enabled": false,
"is_claimed": false,
"user_id": 1443,
"created_at": "2025-01-25T13:10:54+03:30",
"updated_at": "2025-02-25T13:10:54+03:30"
},
"status": 200
}
فیلدنوع دادهتوضیحات
idintegerشناسه کد تخفیف خریداری‌شده
titlestringعنوان کد تخفیف
voucher_codestringکد کد تخفیف
typeintegerنوع کد تخفیف (۱: درصدی، ۲: مبلغ ثابت)
modeintegerحالت کد تخفیف
bulk_countintegerتعداد کد تخفیف در حالت گروهی
percent_valueintegerمقدار درصدی تخفیف
static_valueintegerمقدار ثابت تخفیف
value_capintegerحداکثر سقف تخفیف برای کد تخفیفهای درصدی
user_max_use_timesintegerحداکثر تعداد استفاده برای هر کاربر
total_max_use_timesintegerحداکثر تعداد استفاده کلی
start_datestringتاریخ شروع کد تخفیف (هجری شمسی)
end_datestringتاریخ پایان کد تخفیف (هجری شمسی)
enabledbooleanآیا کد تخفیف فعال است؟ (true یا false)
is_claimedbooleanآیا کد تخفیف استفاده شده است؟
user_idintegerشناسه کاربری که کد تخفیف را دریافت کرده
created_atstringتاریخ ایجاد کد تخفیف
updated_atstringتاریخ آخرین به‌روزرسانی کد تخفیف

خطاها

کد وضعیتتوضیحات
400درخواست نامعتبر (ورودی‌های اشتباه)
401نیاز به احراز هویت
403دسترسی غیرمجاز
404کد تخفیف موردنظر یافت نشد
500خطای داخلی سرور

توضیحات تکمیلی

  • مقدار enabled پس از آپدیت، مقدار جدید را نشان می‌دهد.
  • مقدار updated_at نشان‌دهنده زمان آخرین به‌روزرسانی کد تخفیف است.