Occupancy Information

To get the latest status of an occupancy, you can call the following web service along with a valid token.

GET/v1.1/hub-management/occupancies/{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": "Station Name",
    "address": "Station 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
}

The explanation of each field in the response above is as follows:

uuid: The unique identifier of the parcel in Ganje.
process: The service associated with the occupancy.
shipment: Information related to the occupancy is included in this field. This information contains the following:
- external_id: The identifier of the occupancy in the supplier's system.
- parcels: An array of packages related to this occupancy. Since each package might have a different identifier in the supplier's system, each package also has an external_id.
station: Information related to the station is included in this field. This information contains the following:
- uuid: The unique identifier of the station.
- nickname: The name of the station.
- address: The address of the station.
- location: The geographical location of the station.
- postal_code: The postal code of the station (if defined).
status: The latest status of the occupancy, which can have the following values:
- reserved: The occupancy has not yet been placed in the locker.
- occupied: The occupancy has been placed in the locker.
- expired: The deadline for retrieving the occupancy has passed, but the occupancy has not yet been removed from the locker.
- unoccupied: The occupancy has been retrieved from the locker by the end user.
picker: Information about the picker is included in this field. This information contains the following:
- phone_number: The picker's phone number.
- full_name: The picker's full name (if provided in the reservation API).
expected_check_in: The start date and time of the reservation window.
expected_check_out: The end date and time of the reservation window (the user's pick up deadline).
check_in: The date and time the parcel was placed in the locker.
check_out: The date and time the parcel was picked up from the locker.

Response Body​

Response Body