ساخت کد تخفیف (Post)
برای ایجاد یک کد تخفیف جدید استفاده میشود.
اطلاعات عمومی
- آدرس:
/api/v2/purchased-voucher
- متد:
POST
- نوع محتوا:
application/json
- احراز هویت: نیازمند token
احراز هویت
- این درخواست نیاز به یک Authorization token دارد که باید در هدر ارسال شود.
پارامترهای درخواست
فیلد | نوع داده | ضروری | توضیحات |
---|---|---|---|
title | string | بله | عنوان کد تخفیف (حداقل ۳ کاراکتر) |
type | integer | بله | نوع کد تخفیف (۱: درصدی، ۲: مبلغ ثابت) |
mode | integer | بله | حالت کد تخفیف (۱=SingleCode یا ۲=Bulk) |
bulk_count | integer | خیر | تعداد کد تخفیف در حالت گروهی (حداکثر ۱۰۰,۰۰۰) |
start_date | string | بله | تاریخ شروع کد تخفیف (ISO 8601) |
end_date | string | بله | تاریخ پایان کد تخفیف (ISO 8601) |
percent_value | integer | شرطی | مقدار درصد تخفیف (در صورت انتخاب type=1) |
static_value | integer | شرطی | مقدار ثابت تخفیف (در صورت انتخاب type=2) |
value_cap | integer | شرطی | حداکثر مقدار تخفیف برای کد تخفیفهای درصدی |
user_max_use_times | integer | خیر | حداکثر تعداد استفاده برای هر کاربر |
total_max_use_times | integer | بله | حداکثر تعداد استفاده کلی |
📌 شرایط خاص:
percent_value
فقط برای کد تخفیفهای درصدی (type=1
) قابل استفاده است و مقدار آن باید بین10
تا100
باشد.static_value
فقط برای کد تخفیفهای مبلغی (type=2
) قابل استفاده است و مقدار آن باید بین10,000
تا5,000,000
باشد.value_cap
نیز فقط برای کد تخفیفهای درصدی (type=1
) مورد نیاز است.
نمونه درخواست
curl --location --request POST 'https://corporate.snapp.site/api/v2/purchased-voucher' \
--header 'Authorization: <your_authorization_token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"title": "Discount Voucher",
"type": 1,
"mode": 2,
"bulk_count": 500,
"start_date": "2025-03-01T00:00:00Z",
"end_date": "2025-06-01T23:59:59Z",
"percent_value": 20,
"value_cap": 500000,
"user_max_use_times": 3,
"total_max_use_times": 1000
}'
پاسخ موفق
{
"data": {
"voucher_id": 987654321,
"voucher_code": "SNAPP2025DISC"
}
}
فیلد | نوع داده | توضیحات |
---|---|---|
voucher_id | integer | شناسه کد تخفیف ایجاد شده |
voucher_code | string | کد کد تخفیف ایجاد شده |
خطاها
کد وضعیت | توضیحات |
---|---|
400 | درخواست نامعتبر (ورودیهای اشتباه) |
401 | نیاز به احراز هویت |
403 | دسترسی غیرمجاز |
500 | خطای داخلی سرور |
توضیحات تکمیلی
- کد تخفیفهای درصدی و مبلغی بسته به مقدار
type
دارای ورودیهای متفاوتی هستند. - در صورت نیاز به ایجاد کد تخفیفهای گروهی، مقدار
bulk_count
را مشخص کنید.