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

بروزرسانی محدودیت مکانی (Patch: Update Location Whitelist)

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

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

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

احراز هویت​

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

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

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

پارامترهای بدنه درخواست (Request Body)​

فیلدنوع دادهضروریتوضیحات
location_typeintegerبلهنوع جدید موقعیت مکانی (۱: مبدأ، ۲: مقصد)

نمونه Request Body:

{
  "location_type": 2
}

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

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

پاسخ موفق​

{
  "data": "Updated",
  "message": "OK",
  "status": 0
}

توضیحات فیلدهای پاسخ​

فیلدنوع دادهتوضیحات
datastringپیام موفقیت‌آمیز (مثلاً "Updated")
messagestringپیام کلی پاسخ (مثلاً "OK")
statusintegerکد وضعیت پاسخ (0 برای موفقیت)

خطاها​

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