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

مدیریت سفیرها

برای اینکه سفیر بتواند تحویل و دریافت مرسولات را انجام دهد، لازم است تامین‌کننده یا شرکت توزیع‌کننده، سفیر را ثبت‌نام کرده باشد. همچنین در صورت پایان همکاری با سفیر، جهت جلوگیری از دسترسی سفیر به مرسولات، لازم است سفیر را حذف کنید.

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

اضافه کردن سفیر​

برای اضافه کردن سفیر، می‌توانید از وب‌سرویس زیر استفاده کنید.

POST/v1.1/account/courier/
نیاز به احراز هویت

Request Body​

{
  "phone_number": "+989123456789",
  "first_name": "علی",
  "last_name": "محمدی"
}

Response Body​

{
  "uuid": "2f0ee759-337e-4edb-b053-dbf06d4d3d55",
  "personal_info": {
    "phone_number": "+989123456789",
    "first_name": "علی",
    "last_name": "محمدی",
    "full_name": "علی محمدی",
    "email": null
  }
}

Response Codes​

Status Code Description
201courier created successfully
400courier already exists

در ادامه توضیح فیلد‌ها آمده است:

  • phone_number(*): شماره تلفن همراه سفیر که با آن می‌خواهد از اپلیکیشن گنجه استفاده کند
  • first_name: نام سفیر
  • last_name: نام خانوادگی سفیر

لیست سفیرها​

برای دریافت لیست سفیرها می‌توانید از وب‌سرویس زیر استفاده کنید.

GET/v1.1/account/courier/
نیاز به احراز هویت

Response Body​

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "uuid": "2f0ee759-337e-4edb-b053-dbf06d4d3d55",
      "personal_info": {
        "phone_number": "+989123456789",
        "first_name": "علی",
        "last_name": "محمدی",
        "full_name": "علی محمدی",
        "email": null
      }
    }
  ]
}

در ادامه توضیح فیلد‌ها آمده است:

  • uuid: شناسه‌ی یکتای سفیر در گنجه
  • personal_info: اطلاعات شخصی سفیر که شامل موارد زیر است
    • phone_number: شماره تلفن همراه
    • first_name: نام
    • last_name: نام خانوادگی
    • ‍full_name: نام و نام خانوادگی
    • ‍email: ایمیل

حذف سفیر​

برای حذف سفیر می‌توانید از وب‌سرویس زیر استفاده کنید.

DELETE/v1.1/account/courier/{uuid}
نیاز به احراز هویت