Home

GetRates

getRates

🚧

Do you have questions about our APIs?
If you need help, don’t forget to use our artificial intelligence — it will help you generate examples that fit your specific needs, variations, and the required parameters for using each Hound Express API.

Our api provides you with a tool that allows you to check the availability of coverage, the rates and types of service that we have available to carry out your shipment. This in order that by means of this consultation you can choose the possibility that best suits your needs among those that we offer you.

The quote / coverage service allows you to evaluate if there is coverage from a zip code that will be the origin of the order to a destination zip code. The result of the consumption is an array with the fees, where if it is an empty array it will mean that there is no coverage for the origin-destination that you have consulted. Otherwise, the fee array may contain one or more options depending on the services assigned in your account settings.

📘

### Request

To make the quote, it is necessary to send a json object of type guide that requires the filling of the following fields:

Guide

Field name

Type

MaxLength

Required

Comments

sender

Address

Required

It is an address type object, it will be used to determine the origin of the shipment, the data is optional because according to the characteristics and configuration of your account, the coverage verification and rates may depend on the relationship of the origin and destination of the shipment.

It is possible to omit this data in cases where the collections are going to be in a predetermined direction that can be configured in the initial parameters of your organization.

In case this parameter is included in the request, the system will check if there are collection possibilities in this origin.

receiver

Address

Required

It is an address type object, it is used to check if there are delivery options

packagePieces

Package (Array)

Package (Array)

Required

List of packages to be quoted, at least one object is required within the array to quote, this data is necessary because in many cases there are restrictions on the weight and size of the shipment

flag

9

Optional

It can be sent to specify different consumption options, although by default this value can be omitted

Child objects

The guide object contains sub-objects of which the filling of the following values is require

sender (Address)

Field Name

Type

Maxlength

Required

Comments

zip

(zip code)

Integer

10

Required

ZIP code of the sender, in case of omitting it or being an importer, this value is taken from the default address in the account configuration and is fixed.

receiver(Address)

Field Name

Type

Maxlength

Required

Comments

zip

(zip code)

Integer

10

Required

ZIP code of the consignee, is the data used to determine if there is the possibility of making the delivery to this destination.

packagePieces

Field Name

Type

Maxlength

Required

Comments

height

Integer

9

Required

In centimeters.

It must be an integer number.

length

Integer

9

Required

In centimeters.

It must be an integer number.

width

Integer

9

Required

In centimeters.

It must be an integer number.

weight

Float

10,2

Required

In kilograms.

It may be a number with decimal point, and there must be a maximum of two figures after it. If the value contains more than two, the following figures will be ignored.

Example: if the user inputs 6.2375, the system will record 6.23

Response

Upon consumption, the API will return an object with the following characteristics

👍

### Successful response

Guide

Field name

Type

MaxLength

Comments

sender

Address

This field contains the data as originally received at the request.

receiver

Address

This field contains the data as originally received at the request.

packagePieces

Package (Array)

This field contains the data as originally received at the request.

flag

Integer

9

This field contains the data as originally received at the request.

The quotes object contains the results of its consumption

Quotes

Field Name

Type

MaxLength

Comments

Id

Integer

10

Service id (can be used later as a parameter for documentation)

In the event that after the consumption of this service (quote / coverage) and its process continue with the creation of the order, this data can be used to fill in the id of the serviceType in the JSON object of the request and by this way specify that you would like to use this specific service.

(this option is available depending on the configuration of your account and according to your contract).

Code

String

20

Service Code

Value

String

20

Quote fee In order for you to receive the correct rate within the result, it is necessary that your account is configured correctly for these purposes. That is to say: "THIS SERVICE WILL NOT ALWAYS RETURN YOUR RATE", it depends on the configuration of your account that allows it.

The above is due to the fact that not in all implementations the client that consumes this service must have a visualization of the negotiated rates.

type

Integer

10

Delivery provider key

description

String

100

Description of the service

date

String

20

Delivery commitment date

aux

BaseObject (Array)

Additional information in if there is a breakdown of the fee

dropOffLocations

Address (Array)

In case the client prefers to take the order to an office to be sent instead of requesting a collection, this is the list that our system detects of the offices that are closest to the origin zip code.

❗️

### Failed Response

wsErrors elements

Field NameTypeComments
idIntegerError id
codeStringError code
typeIntegerSeverity of the error
descriptionStringDescription with more details of the detected error
Language
Click Try It! to start a request and see the response here!