THE GUIDE OBJECT

The guide object is a structure that the vast majority of The Hound Express API services receive as parameter and return in response, therefore it is necessary to understand its operation.

One of the points to consider when consuming the Web Services of our API is that for each of them the required fields of the Guide object structure are not the same for all, so we suggest you review the specific documentation of the service you want to use. There you will find the specifications of the fields required for the correct consumption of that service.

For example, in the case of consult the tracking of a guide a required field is the guideNumber, but it is not necessary that on the object sent on request information about the address of the shipment receiver is included.

That information about the address of the recipient of the shipment be included in the object sent in request.

However for the case of the creation of the order it is evident that this information will be required.

🗒️

Note: Apart from this parameter, the security implemented in The HoundExpress API requires the sending of parameters within the request header

When you make a request for an API it is spected to receive an object on JSON format, after that, the response contains the same object but it will added more information in its body with the result of the specific web service that you consume.

For example, if you consume the quote API you will find that the return object places information in the quotes fields, which is an array of objects type BaseObject where the information of the available rates and services was added.

But if you perform the tracking API consumption, on this occasion the fields where the information is placed are in the array trackingDetails of BaseObject [] type, which in turn are an attribute of the array of Package objects and is where it will find the detail of events that have had their order with respect to each of the pieces that make it up.

📘

THE ATTRIBUTES OF THE GUIDE OBJECT

The structure of the guide service consists of attributes that may be primitive types but in many cases they are objects. Each of them represents an information cell of the order.

You can send an array of objects instead of a single object, in which case you should also get an array of objects in the response, corresponding to each one of the guideNumbers sent.

GUIDE

Field name	Type	Comments
sender	Address	It is the sender of the shipment
receiver	Address	It is the consignee of the shipment
packagePieces	Package (Array)	List of packages that make up the order, minimum one object is required within the array
firstStatus	GuideStatus	This field is required however at the time of creating the order the system automatically assigns the initial status so it is not necessary for you to include it in the request.
currentStatus	GuideStatus	This field is required however at the time of creating the order the system automatically assigns the initial status so it is not necessary for you to include it in the request
currency	String	It's a constant value: NMP
clientReference	ClientReference	Use this field to assign your own reference
deliveryOption	DeliveryOption	Use this field to assign your choose for the delivery option
packageType	PackageType	Use this field to assign your choose for the package type
serviceType	ServiceType	Use this field to assign your choose for the service type
insuredValue	InsuredValue	We need to know the value of the shipment and the currency of this value
flag	Integer	Within this field you can specify extended response characteristics.