Skip to main content
GET
/
orders
/
{uid}
cURL
curl --request GET \
  --url https://api.unihop.app/v1/orders/{uid} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "uid": "job_123abc456def",
    "status": "DROPOFF_COMPLETE",
    "partner_reference": "partner_ref_78910",
    "price": {
      "value": 123,
      "currency": "USD"
    },
    "distance": {
      "value": 123,
      "unit": "<string>"
    },
    "quote": true,
    "partner_payload": {
      "custom_field": "custom_value"
    },
    "pickup_name": "<string>",
    "dropoff_name": "<string>",
    "delivery_date": "<string>",
    "delivery_start_time": "<string>",
    "driver_id": 123,
    "driver_name": "<string>",
    "driver_location": {
      "lat": 123,
      "lng": 123
    },
    "driver_dropoff_phone_number": "<string>",
    "driver_pickup_phone_number": "<string>",
    "driver_vehicle_make": "<string>",
    "driver_vehicle_model": "<string>",
    "driver_vehicle_year": 123,
    "dropoff_time_estimated": "<string>",
    "pickup_address_street": "<string>",
    "pickup_address_city": "<string>",
    "pickup_address_country": "<string>",
    "pickup_address_number": "<string>",
    "pickup_address_secondary_number": "<string>",
    "pickup_address_county": "<string>",
    "pickup_address_state": "<string>",
    "pickup_address_postal_code": "<string>",
    "pickup_address_latitude": 123,
    "pickup_address_longitude": 123,
    "pickup_phone_number": "<string>",
    "pickup_instructions": "<string>",
    "email": "<string>",
    "dropoff_address_street": "<string>",
    "dropoff_address_city": "<string>",
    "dropoff_address_country": "<string>",
    "dropoff_address_number": "<string>",
    "dropoff_address_secondary_number": "<string>",
    "dropoff_address_county": "<string>",
    "dropoff_address_state": "<string>",
    "dropoff_address_postal_code": "<string>",
    "dropoff_address_latitude": 123,
    "dropoff_address_longitude": 123,
    "dropoff_phone_number": "<string>",
    "dropoff_instructions": "<string>",
    "dropoff_email": "<string>",
    "package_description": "<string>",
    "package_minimum_vehicle_size": "<string>",
    "package_delivery_mode": "<string>",
    "package_requirements": [
      "<string>"
    ],
    "items_count": 123,
    "items": [
      {}
    ],
    "weight": 123,
    "dimentions": {
      "height": 123,
      "length": 123,
      "width": 123
    },
    "package_value": 123,
    "pickup_start_time": "<string>",
    "dropoff_start_time": "<string>",
    "delivery_end_time": "<string>",
    "dropoff_verification_image_url": "<string>",
    "dropoff_signature_image_url": "<string>",
    "cancellation_reason": "<string>",
    "tip": 123
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

uid
string
required

Unique identifier (UID) of the order to retrieve.

Response

The requested order details.

data
object