وب‌هوک
به محض تغییر در وضعیت هر کدام از مرسولات گنجه، به ازای هر مرسوله، یک وب‌هوک به url ای که از قبل تعیین شده است، ارسال می‌شود.
نمونه‌ی وب‌هوک:
{
"id": "61",
"uuid": "36d3a7c7-a767-4266-8d5f-dae9e717225f",
"process": "manual_lastmile",
"status": "occupied",
"shipment": {
"external_id": "Test1",
"parcels": [
{
"pk": 54,
"external_id": "Test1_1",
"size": null,
"dimention": {
"name": null,
"length": 0.1,
"width": 0.25,
"height": 0.15
},
"weight": null,
"value": null,
"content": null
}
]
},
"station": {
"pk": 21,
"address": "آدرس گنجدار",
"location": "35.70820037199022, 51.46982257116468",
"nickname": "گنجدار ۱",
"slug": "85943805",
"images": [],
"postal_code": null,
"uuid": "3560d436-6239-4948-9328-06bc653f37db",
"city_name": {
"english": "Tehran",
"persian": "تهران"
}
},
"external_id": "Test1",
"check_in": "2024-10-09 17:20:32",
"check_out": null,
"supplier": {
"name": "تامین کننده ۱",
"address": "",
"postal_code": "",
"phone_number": null
},
"sms_type": "Ganje_Received",
"sms_title": "occupied"
}
در ادامه توضیح برخی از فیلد‌ها آمده است:
uuid: شناسه یکتای مرسوله در گنجهprocess: سرویسی که مرسوله به آن مرتبط است که در اینجا manual_lastmile است.- status: آخرین وضعیت مرسوله که می‌تواند مقادیر زیر را داشته باشد:
reserved: مرسوله هنوز به گنجدار تحویل داده نشده‌است.pendingoccupied: مرسوله توسط پیک تحویل داده شده است؛ اما هنوز توسط گنجدار تایید نشده‌است.occupied: مرسوله در دست گنجدار است.unoccupied: مرسوله توسط کاربر نهایی از گنجدار تحویل گرفته شده است.expired: مهلت دریافت مرسوله تمام شده است؛ اما مرسوله هنوز در دست گنجدار است.pendingreturned: مرسوله جهت مرجوع شدن توسط گنجدار به پیک تحویل داده شده استreturned: مرجوع شده به پیک.
- shipment: اطلاعات مربوط به مرسوله در این فیلد می‌آید. این اطلاعات شامل موارد زیر است:
external_id: شناسه‌ی مرسوله در سرویس تامین‌کنندهparcels: آرایه‌ای از بسته‌ها (فقره‌ها) ی مربوط به این مرسوله. با توجه به اینکه هر کدا م از بسته‌ها می‌توانند شناسه‌ی متفاوتی در سرویس تامین‌کننده داشته باشند، برای هر کدام از بسته‌ها نیزexternal_idتعریف می‌شود.
- station: اطلاعات مربوط به گنجه در این فیلد می‌آید. این اطلاعات شامل موارد زیر است:
nickname: نام گنجهaddress: آدرس گنجهlocation: موقعیت جغرافیایی گنجهslug: شناسه‌ی یکتای گنجهpostal_code: کد پستی گنجه
check_in: تاریخ و زمان لحظه‌ی جایگذاری مرسوله در گنجهcheck_out: تاریخ و زمان لحظه‌ی خروج مرسوله از گنجه- supplier: اطلاعات مربوط به تامین‌کننده در این فیلد می‌آید. این اطلاعات شامل موارد زیر است:
name: نام تامین‌کنندهaddress: آدرس تامین‌کنندهpostal_code: کد پستی تامین‌کنندهphone_number: شماره تلفن تامین‌کننده