Error Codes
HopDrive uses HTTP response status codes to indicate the success or failure of your API requests. If your request fails, HopDrive returns an error using the appropriate status code.
In general, there are three status code ranges you can expect:
2xxsuccess status codes confirm that your request worked as expected4xxerror status codes indicate an error because of the information provided (e.g., a required parameter was omitted)5xxerror status codes are rare and indicate an error with HopDrive's servers
Some 4xx errors that could be handled programmatically (e.g., an invalid pickup address) include an error code—a short string with a brief explanation—as a value for code. Below is a list of possible error codes that can be returned, along with additional information about how to resolve them. For your convenience, these types of errors also include the doc_url attribute with a direct link to the specific error code it corresponds to.
access_denied
Provided credentials are unauthorized.
address_invalid
The address provided for a location is not valid and cannot be used.
outside_region
Both the pickup and delivery locations are outside Hopdrive service regions.
field_invalid
A field/property in the request is invalid.
field_missing
A field/property in the request is missing. This field is required and has no default fallback value.
google_place_id_invalid
The Google Place ID provided instead of an address is not valid in the Google API.
internal_server_error
HopDrive is experiencing an outage or is currently unable to reach a dependent subsystem.
missing_scope
A scope required to perform the operation is not present in the provided authentication token.
move_invalid
The Move ID provided was invalid.
move_duplication
The move provided is a duplicate of one that is already in-progress (based on "duplicate_check" request parameter).
pickup_location_required
A pickup location object is required but was not found in the request.
request_invalid
The request structure is invalid and cannot be used.