استرداد آیتم خریداری شده – Refund

• استرداد آیتم خریداری شده از طریق API
• سربرگ – Header
• مقادیر ارسالی – Request Data
• پاسخ صحیح – Response True
• پاسخ نادرست – Response False

استرداد آیتم خریداری شده از طریق API

عنوان	وضعیت	مقادیر	توضیحات
Method	اجباری	POST	متد ارسال درخواست
Domain	اجباری	نام دامنه ثبت شده در اتوماسیون
Api Url	اجباری	دامنه هسته مرکزی سرویس
Api version	اجباری	به نسخه فعلی سرویس API تلقی میشود که در قسمت پیش نیازهای اتوماسیون به ریز شرح داده شده است.
Authorization	اجباری	توکن JWT تولید شده	این توکن بصورت JWT تولید میشود.

در این روش شما باید درخواست خود را از طریق لینک زیر ارسال فرمائید.

سربرگ – Header

{{Api Url}}/refund

HEADER
POST /api/reservation/{{Api version}}/refund HTTP/1.1
Host: {{Your Host}}
Content-Type: application/json
Authorization: Bearer JWTToken
Domain: {{Your Domain}}

API Url از طریق پنل کاربری قابل مشاهده خواهد بود.

مقادیر ارسالی – Request Data

عنوان	نوع	وضعیت	مقادیر	توضیحات
reserve_id	String	اجباری	آیدی یا pnr اصلی
description	String	اختیاری	توضیحات مربوط به استرداد آیتم خریداری شده

{
    "reserve_id": "", // id or pnr
    "description":""
}

پاسخ صحیح – Response True

عنوان	نوع	مقادیر	توضیحات
payload
payload.refund_id	Integer	آیدی استرداد آیتم خریداری شده
meta
meta.timestamp	Timestamp	زمان تولید پاسخ	این زمان بر اساس timestamp می باشد – در صورت نیاز از این زمان استفاده شود.

دریافت این پاسخ با Status Code 200 دریافت خواهد شد.

{
    "payload": {
        "refund_id": 10008
    },
    "meta": {
        "timestamp": "Timestamp" // Timestamp
    }
}

 

پاسخ نادرست – Response False

عنوان	نوع	مقادیر	توضیحات
error
error.code	Integer	شماره خطا مربوطه	جهت استعلام خطا میتوانید از طریق این لینک اقدام کنید.
meta
meta.timestamp	Timestamp	زمان تولید پاسخ	این زمان بر اساس timestamp می باشد – در صورت نیاز از این زمان استفاده شود.

{
  "error": {
    "code":"Error Code"
  },
  "meta": {
    "timestamp": "Timestamp" // Timestamp
  }
}

در صورت مشاهده Status Code 404 URL درخواست خود را به اشتباه وارد نمود اید.