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

ساخت کد تخفیف (Post)

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


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

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

احراز هویت

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

پارامترهای درخواست

فیلدنوع دادهضروریتوضیحات
titlestringبلهعنوان کد تخفیف (حداقل ۳ کاراکتر)
typeintegerبلهنوع کد تخفیف (۱: درصدی، ۲: مبلغ ثابت)
modeintegerبلهحالت کد تخفیف (۱=SingleCode یا ۲=Bulk)
bulk_countintegerخیرتعداد کد تخفیف در حالت گروهی (حداکثر ۱۰۰,۰۰۰)
start_datestringبلهتاریخ شروع کد تخفیف (ISO 8601)
end_datestringبلهتاریخ پایان کد تخفیف (ISO 8601)
percent_valueintegerشرطیمقدار درصد تخفیف (در صورت انتخاب type=1)
static_valueintegerشرطیمقدار ثابت تخفیف (در صورت انتخاب type=2)
value_capintegerشرطیحداکثر مقدار تخفیف برای کد تخفیفهای درصدی
user_max_use_timesintegerخیرحداکثر تعداد استفاده برای هر کاربر
total_max_use_timesintegerبلهحداکثر تعداد استفاده کلی

📌 شرایط خاص:

  • 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_idintegerشناسه کد تخفیف ایجاد شده
voucher_codestringکد کد تخفیف ایجاد شده

خطاها

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

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

  • کد تخفیفهای درصدی و مبلغی بسته به مقدار type دارای ورودی‌های متفاوتی هستند.
  • در صورت نیاز به ایجاد کد تخفیفهای گروهی، مقدار bulk_count را مشخص کنید.