Get Quote - UniHop API Documentation

curl --request POST \ --url https://api.unihop.app/v1/quote \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "pickup_address_street": "<string>", "pickup_address_city": "<string>", "pickup_address_country": "<string>", "pickup_name": "<string>", "dropoff_name": "<string>", "email": "jsmith@example.com", "currency": "<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>", "dropoff_start_time": "2023-11-07T05:31:56Z", "pickup_start_time": "2023-11-07T05:31:56Z", "weight": 1, "dimensions": { "length": 1, "width": 1, "height": 1 }, "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": "jsmith@example.com", "package_minimum_vehicle_size": "SEDAN", "package_delivery_mode": "NOW", "package_description": "<string>", "package_requirements": [ "PHOTO_PROOF_OF_DELIVERY" ], "package_pickup_start_time": "<string>", "items": [ { "name": "<string>", "quantity": 123, "description": "<string>", "external_id": "<string>", "external_instance_id": "<string>", "price": 123, "barcode": "<string>" } ], "items_count": 123, "delivery_date": "2023-12-25", "delivery_start_time": "<string>", "delivery_end_time": "<string>", "package_value": 1, "tip": 1, "partner_reference": "<string>", "partner_payload": {} } '

{ "message": "Quote generated successfully", "uid": "quote_123456", "data": { "status": "quoted", "partner_reference": "partner_xyz_001" }, "price": { "value": 12.5, "currency": "USD" } }

Authorizations

Authorization

string

header

required

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

Body

application/json

Delivery details to quote

pickup_address_street

string

required

Street name of the pickup address.

pickup_address_city

string

required

City of the pickup address.

pickup_address_country

string

required

Country of the pickup address.

pickup_name

string

required

Name of the contact person at the pickup location.

dropoff_name

string

required

Name of the contact person at the dropoff location.

string<email>

required

Customer email address for notifications.

currency

string

required

The intended currency.

Maximum string length: 3

pickup_address_number

string

Street number of the pickup address.

pickup_address_secondary_number

string

Apartment or suite number for the pickup address.

pickup_address_county

string

County of the pickup address.

pickup_address_state

string

State of the pickup address.

pickup_address_postal_code

string

Postal or ZIP code of the pickup address.

pickup_address_latitude

number

Latitude coordinate of the pickup address.

pickup_address_longitude

number

Longitude coordinate of the pickup address.

pickup_phone_number

string

Phone number of the pickup contact person.

Maximum string length: 15

pickup_instructions

string

Additional instructions for the pickup.

Maximum string length: 512

dropoff_start_time

string<date-time>

Preferred start time for dropoff in ISO 8601 format (YYYY-MM-DDTHH:MM:SS±HH:MM).

pickup_start_time

string<date-time>

Preferred start time for pickup in ISO 8601 format (YYYY-MM-DDTHH:MM:SS±HH:MM).

weight

number

Weight of the package in lbs.

Required range: x >= 0

dimensions

object

Dimensions of the package.

Show child attributes

dropoff_address_street

string

Street name of the dropoff address.

dropoff_address_city

string

City of the dropoff address.

dropoff_address_country

string

Country of the dropoff address.

dropoff_address_number

string

Street number of the dropoff address.

dropoff_address_secondary_number

string

Apartment or suite number for the dropoff address.

dropoff_address_county

string

County of the dropoff address.

dropoff_address_state

string

State of the dropoff address.

dropoff_address_postal_code

string

Postal or ZIP code of the dropoff address.

dropoff_address_latitude

number

Latitude coordinate of the dropoff address.

dropoff_address_longitude

number

Longitude coordinate of the dropoff address.

dropoff_phone_number

string

Phone number of the dropoff contact person.

Maximum string length: 15

dropoff_instructions

string

Additional instructions for the dropoff.

Maximum string length: 512

dropoff_email

string<email>

Email address of the dropoff contact person.

package_minimum_vehicle_size

enum<string>

Minimum vehicle type required to transport the package.

Available options:

SEDAN,

CAR,

SUV,

PICKUP_TRUCK,

VAN,

TRUCK,

LARGE_VAN,

EXTRA_LARGE_VAN,

PICKUP

package_delivery_mode

enum<string>

Mode of delivery (NOW or SCHEDULED).

Available options:

NOW,

SCHEDULED

package_description

string

Description of the package contents.

Maximum string length: 512

package_requirements

enum<string>[]

Special delivery or pickup requirements.

Available options:

PHOTO_PROOF_OF_DELIVERY,

SIGNATURE_PROOF_OF_DELIVERY,

TWO_PERSON_TEAM

package_pickup_start_time

string<time>

Preferred pickup time for the package (HH:MM:SS).

items

object[]

List of items included in the delivery.

Show child attributes

items_count

integer

Total count of items.

delivery_date

string<date>

Preferred delivery date (YYYY-MM-DD).

delivery_start_time

string<time>

Start time of the delivery window (HH:MM:SS).

delivery_end_time

string<time>

End time of the delivery window (HH:MM:SS).

package_value

number

Monetary value of the package.

Required range: x >= 0

tip

number

Optional tip for the delivery.

Required range: x >= 0

partner_reference

string

Custom reference provided by the partner.

Maximum string length: 256

partner_payload

object

Optional custom payload for partner systems.

Response

Quote returned successfully

Successful response returned for a delivery quote. Contains the same fields as an order creation response plus a price estimate.

message

string

required

Example:

"Quote generated successfully"

uid

string

required

Unique identifier of the quote

Example:

"quote_123456"

data

object

required

Show child attributes

price

object

required

The estimated price for the delivery.

Show child attributes

Documentation

Endpoints

Authorizations

Body

Response