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

ایجاد محدودیت مکانی (Post: Location Whitelist)

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

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

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

احراز هویت​

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

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

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

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

فیلدنوع دادهضروریتوضیحات
namestringبلهنام موقعیت مکانی (مثلاً "میدان آزادی")
typeintegerبلهنوع موقعیت مکانی (۱: مبدأ، ۲: مقصد)
latfloat64بلهعرض جغرافیایی (Latitude)
lngfloat64بلهطول جغرافیایی (Longitude)

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

curl --location --request POST 'https://corporate.snapp.site/api/v2/purchased-voucher/5113/location-whitelist' \
--header 'Authorization: <your_authorization_token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "میدان آزادی",
    "type": 1,
    "lat": 35.6997,
    "lng": 51.3370
}'

پاسخ موفق​

{
    "message": "Success",
    "data": {
        "id": 12345
    },
    "status": 200
}
فیلدنوع دادهتوضیحات
idintegerشناسه موقعیت مکانی اضافه‌شده

خطاها​

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

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

  • مقدار type مشخص می‌کند که موقعیت مکانی مربوط به مبدأ (۱) یا مقصد (۲) است.
  • پس از اضافه شدن موقعیت مکانی، یک id به آن اختصاص داده می‌شود که در پاسخ برمی‌گردد.