وب‌هوک

به محض تغییر در وضعیت هر کدام از مرسولات گنجه، به ازای هر مرسوله، یک وب‌هوک به url ای که از قبل تعیین شده است، ارسال می‌شود.

نمونه‌ی وب‌هوک:

{
  "id": "69",
  "uuid": "86bccab4-0f7f-4333-9bbe-3a688a3bbb60",
  "process": "firstmile",
  "status": "unoccupied",
  "shipment": {
    "external_id": "Test2",
    "parcels": [
      {
        "pk": 61,
        "external_id": "Test2_1",
        "size": null,
        "weight": 1000,
        "value": 2000000.0,
        "content": null
      },
      {
        "pk": 62,
        "external_id": "Test2_2",
        "size": null,
        "weight": 1000,
        "value": 2000000.0,
        "content": null
      }
    ]
  },
  "station": {
    "pk": 21,
    "address": "آدرس گنجه",
    "location": "35.70820037199022, 51.46982257116468",
    "nickname": "گنجه ۱",
    "slug": "85943805",
    "images": []
  },
  "check_in": "2024-10-09 15:12:51",
  "check_out": "2024-10-09 17:20:32"
}

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

• uuid: شناسه یکتای مرسوله در گنجه
• process: سرویسی که مرسوله به آن مرتبط است که در اینجا firstmile است.
• status: آخرین وضعیت مرسوله که می‌تواند مقادیر زیر را داشته باشد:
  • reserved: مرسوله هنوز در گنجه جایگذاری نشده‌است.
  • occupied: مرسوله در گنجه جایگذاری شده است.
  • unoccupied: مرسوله توسط کاربر نهایی از گنجه خارج شده است.
  • expired: مهلت برداشت مرسوله گذشته است؛ اما مرسوله هنوز از گنجه خارج نشده است.
  • returned: مهلت برداشت مرسوله گذشته است و توسط سفیر از گنجه خارج شده است.
• shipment: اطلاعات مربوط به مرسوله در این فیلد می‌آید. این اطلاعات شامل موارد زیر است:
  • external_id: شناسه‌ی مرسوله در سرویس تامین‌کننده
  • parcels: آرایه‌ای از بسته‌ها (فقره‌ها) ی مربوط به این مرسوله. با توجه به اینکه هر کدام از بسته‌ها می‌توانند شناسه‌ی متفاوتی در سرویس تامین‌کننده داشته باشند، برای هر کدام از بسته‌ها نیز external_id تعریف می‌شود.
• station: اطلاعات مربوط به گنجه در این فیلد می‌آید. این اطلاعات شامل موارد زیر است:
  • nickname: نام گنجه
  • address: آدرس گنجه
  • location: موقعیت جغرافیایی گنجه
  • slug: شناسه‌ی یکتای گنجه
• check_in: تاریخ و زمان لحظه‌ی جایگذاری مرسوله در گنجه
• check_out: تاریخ و زمان لحظه‌ی خروج مرسوله از گنجه