> ## Documentation Index > Fetch the complete documentation index at: https://docs.unihop.app/llms.txt > Use this file to discover all available pages before exploring further. # Get a Delivery > Current status, courier details, and proof of delivery ## OpenAPI ````yaml platforms/api-reference/openapi.json GET /deliveries/{uid} openapi: 3.1.0 info: title: UniHop Platform API description: >- Book and track UniHop last-mile deliveries on behalf of the merchants on your platform. Your platform identifier lives in the URL; the merchant's own API key authenticates the request. version: 1.0.0 servers: - url: https://backend.unihop.app/api/v1/{platform} description: Production variables: platform: default: your_platform description: The platform identifier UniHop issued you at onboarding. security: - apiKeyAuth: [] paths: /deliveries/{uid}: get: summary: Get a delivery description: >- Returns the current state of one of your deliveries, including courier details once assigned. parameters: - name: uid in: path description: The delivery `uid` returned when it was created. required: true schema: type: string format: uuid responses: '200': description: The delivery. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/Delivery' '401': description: The API key is missing, invalid, or not valid for this platform. content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: No delivery with that uid belongs to your platform. content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: Delivery: type: object properties: uid: type: string description: The unique identifier for the order. example: job_123abc456def status: type: string description: The current status of the order. example: DROPOFF_COMPLETE price: type: object properties: value: type: number format: float description: The cost of the order. currency: type: string description: The currency of the price. example: USD distance: type: object properties: value: type: number format: float unit: type: string pickup_name: type: string description: The full name of the contact person at the pickup location. dropoff_name: type: string description: The full name of the contact person at the dropoff location. delivery_date: type: string description: >- The scheduled delivery date, as a full ISO 8601 UTC datetime (`YYYY-MM-DDTHH:MM:SS+00:00`). driver_id: type: - number - 'null' description: Reserved. Always null. Identify a courier by `driver_name`. driver_name: type: string description: The full name of the assigned courier. driver_location: type: object description: The last known GPS coordinates of the driver. properties: lat: type: number description: The latitude of the driver's location. lng: type: number description: The longitude of the driver's location. driver_dropoff_phone_number: type: string description: The driver's phone number for dropoff-related communication. driver_pickup_phone_number: type: string description: The driver's phone number for pickup-related communication. driver_vehicle_make: type: string description: The make of the driver's vehicle (e.g., `Tesla`). driver_vehicle_model: type: string description: The model of the driver's vehicle (e.g., `Model Z`). driver_vehicle_year: type: number description: The manufacturing year of the driver's vehicle. dropoff_time_estimated: type: string description: >- The estimated time of arrival at the dropoff location, in a standard datetime format. pickup_address_street: type: string description: Street name of the pickup address. pickup_address_city: type: string description: City of the pickup address. pickup_address_country: type: string description: Country of the pickup address. pickup_address_number: type: string description: Street number of the pickup address. pickup_address_secondary_number: type: string description: Secondary treet number of the pickup address. pickup_address_county: type: string description: County of the pickup address. pickup_address_state: type: string description: State of the pickup address. pickup_address_postal_code: type: string description: Postal or ZIP code of the pickup address. pickup_address_latitude: type: number description: Latitude coordinate of the pickup address. pickup_address_longitude: type: number description: Longitude coordinate of the pickup address. pickup_phone_number: type: string description: The contact phone number for the pickup location. pickup_instructions: type: string description: Special instructions for the courier at the pickup location. email: type: string description: The email address of the contact person at the pickup location. dropoff_address_street: type: string description: Street name of the dropoff address. dropoff_address_city: type: string description: City of the dropoff address. dropoff_address_country: type: string description: Country of the dropoff address. dropoff_address_number: type: string description: Street number of the dropoff address. dropoff_address_secondary_number: type: string description: Apartment or suite number for the dropoff address. dropoff_address_county: type: string description: County of the dropoff address. dropoff_address_state: type: string description: State of the dropoff address. dropoff_address_postal_code: type: string description: Postal or ZIP code of the dropoff address. dropoff_address_latitude: type: number description: Latitude coordinate of the dropoff address. dropoff_address_longitude: type: number description: Longitude coordinate of the dropoff address. dropoff_phone_number: type: string description: The contact phone number for the dropoff location. dropoff_instructions: type: string description: Special instructions for the courier at the dropoff location. dropoff_email: type: string description: The email of the entity to contact. package_description: type: string description: A description of the contents of the package being delivered. package_minimum_vehicle_size: type: string description: >- The minimum vehicle size required for this delivery (e.g., `CAR`, `BIKE`). package_delivery_mode: type: string description: >- The delivery mode, indicating if it's on-demand (`NOW`) or scheduled. package_requirements: type: array description: >- A list of special requirements for the delivery (e.g., `photo_proof_of_delivery`). items: type: string items_count: type: number description: The number of items in the package. items: type: array description: >- A list of objects, each detailing an item in the package. Can be null. items: type: object weight: type: number description: The weight of the package. package_value: type: number format: float description: The declared value of the package, converted from cents. pickup_start_time: type: string description: >- The start of the pickup window, as an ISO 8601 UTC datetime (`YYYY-MM-DDTHH:MM:SS+00:00`). dropoff_start_time: type: string description: >- The start of the dropoff window, as an ISO 8601 UTC datetime (`YYYY-MM-DDTHH:MM:SS+00:00`). delivery_end_time: type: string description: >- The end of the dropoff window, as an ISO 8601 UTC datetime (`YYYY-MM-DDTHH:MM:SS+00:00`). dropoff_verification_image_url: type: string description: >- URL to a photo taken as proof of delivery. Available on relevant events. dropoff_signature_image_url: type: string description: >- URL to a signature captured as proof of delivery. Available on relevant events. cancellation_reason: type: string description: >- The reason for a delivery cancellation. Available on cancellation events. tip: type: number format: float description: The tip amount for the driver, converted from cents. delivery_style: type: string nullable: true enum: - Standard - Special Handling description: >- The delivery style. Can be Standard or Special Handling. Please contact us to unlock more delivery styles and associated features. platform_payload: type: object description: >- An arbitrary object of your own: order IDs, store IDs, anything you need to match this delivery back to your system. Stored untouched and returned on every read and webhook. example: store_id: corner-bakery-cambridge order_id: '10482' dimensions: type: object description: The dimentions of the package. properties: height: type: number description: The height of the package. length: type: number description: The length of the package. width: type: number description: The width of the package. tracking_link: type: string format: uri description: A URL to track the delivery in real time. example: https://app.unihop.app/tracking/9f8e7d6c-1b2a-4c3d-8e9f-0a1b2c3d4e5f expected_cancellation_fee: type: object description: The expected cancellation fee for the order. properties: amount: type: string description: The cancellation fee amount. example: '0.00' currency: type: string description: The currency of the cancellation fee. description: A delivery as returned by the GET endpoints. Error: type: object properties: code: type: string description: >- Machine-readable error code, e.g. `not_found`, `not_cancelable`, `invalid_api_key`. message: type: string description: A human-readable description of what went wrong. required: - code - message securitySchemes: apiKeyAuth: type: http scheme: bearer description: >- The merchant's UniHop API key, sent as `Authorization: Bearer `. It identifies the merchant and is what their deliveries are billed against. ````