اطلاعات سفارش

برای مطلع شدن از آخرین وضعیت سفارش می‌توانید وب سرویس زیر را همراه با توکن معتبر فراخوانی کنید.

GET/v1.1/hub-management/occupancies/by-external-id/{external_id}/

نیاز به احراز هویت

Response Body

{
 "uuid": "2d682c7b-ef09-4b7c-badd-1f8063bf31c8",
 "process": "lastmile",
 "verbose_id": null,
 "shipment": {
   "external_id": "TestReferrer1000",
   "parcels": [
     {
       "external_id": "TestReferrer1000_1"
     }
   ]
 },
 "station": {
   "uuid": "d7ac9174-2022-41c2-a27b-74ce3457312c",
   "nickname": "گنجه تست",
   "address": "آدرس گنجه",
   "location": "35.7527, 51.3745",
   "postal_code": null
 },
 "status": "reserved",
 "picker": {
   "phone_number": "+989395713507",
   "full_name": null
 },
 "extra_information": {
   "test": true
 },
 "expected_check_in": "2024-11-09 18:49:00",
 "expected_check_out": "2024-11-10 18:49:00",
 "check_in": null,
 "check_out": null
}

توضیح هر کدام از فیلدها در پاسخ فوق، به صورت زیر است:

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