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

وب‌هوک تغییر وضعیت بسته

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

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

{
"results": [
{
"id": 60,
"uuid": "cd8db4f4-3456-4ea3-923d-35eb58e78689",
"status": "pendingoccupied",
"manual_station": {
"uuid": "b83c2f51-2d2b-4195-868c-a45c712df74e"
},
"picker": {
"first_name": "علی",
"last_name": "محمدی",
"full_name": "علی محمدی"
},
"dates": {
"time_scope": {
"expected_check_in": "2024-12-01 14:48:43",
"expected_duration": "2 00:00:00"
},
"order_date": "2024-12-01 11:18:43",
"check_in": null,
"check_out": null,
"cancel_date": null,
"extend_date": null
},
"shipment": {
"supplier": 11,
"external_id": "40800666"
},
"parcels": [],
"unix_timestamp": 1734439969.4353259
}
]
}

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

  • uuid: شناسه یکتای مرسوله در گنجه
  • status: آخرین وضعیت مرسوله که می‌تواند مقادیر زیر را داشته باشد:
    • reserved: مرسوله هنوز به گنجدار تحویل داده نشده‌است.
    • pendingoccupied: مرسوله توسط پیک تحویل داده شده است؛ اما هنوز توسط گنجدار تایید نشده‌است.
    • occupied: مرسوله در دست گنجدار است.
    • unoccupied: مرسوله توسط کاربر نهایی از گنجدار تحویل گرفته شده است.
    • expired: مهلت دریافت مرسوله تمام شده است؛ اما مرسوله هنوز در دست گنجدار است.
    • pendingreturned: مرسوله جهت مرجوع شدن توسط گنجدار به پیک تحویل داده شده است
    • returned: مرجوع شده به پیک.
  • manual_station: اطلاعات مربوط به گنجدار در این فیلد می‌آید. این اطلاعات شامل موارد زیر است:
    • uuid: شناسه‌ی یکتای گنجه
  • picker: اطلاعات مربوط به کاربر نهایی در این فیلد می‌آید. این اطلاعات شامل موارد زیر است:
    • first_name: نام
    • last_name: نام خانوادگی
    • full_name: نام و نام خانوادگی
  • dates: تاریخ‌های مهم مربوط به این مرسوله در این فیلد می‌آید. این اطلاعات شامل موارد زیر است:
    • time_scope: تاریخ و زمان بازه‌ی دریافت مرسوله
    • order_date: تاریخ و زمان ثبت مرسوله
    • check_in: تاریخ و زمان لحظه‌ی تحویل مرسوله به گنجدار
    • check_out: تاریخ و زمان لحظه‌ی خروج مرسوله از گنجدار
    • cancel_date: تاریخ و زمان لحظه‌ی لغو مرسوله
    • extend_date: تاریخ و زمان لحظه‌ی تمدید مهلت دریافت مرسوله
  • shipment: اطلاعات مربوط به مرسوله در این فیلد می‌آید. این اطلاعات شامل موارد زیر است:
    • supplier: شناسه‌ی تامین‌کننده‌ی مرسوله
    • external_id: شناسه‌ی مرسوله در سرویس تامین‌کننده
  • parcels: آرایه‌ای از بسته‌ها (فقره‌ها) ی مربوط به این مرسوله. با توجه به اینکه هر کدام از بسته‌ها می‌توانند شناسه‌ی متفاوتی در سرویس تامین‌کننده داشته باشند، برای هر کدام از بسته‌ها نیز external_id تعریف می‌شود.
  • unix_timestamp: زمان ارسال وب‌هوک