It is the API that allows alerting the arrival of a MAWB within the Hound Express System.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
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.
Introducction:
It is important that you know the difference between the Master Air Waybill (MAWB) and the House Air Waybill (HAWB), since you will be entering information for both concepts.
The “AWB” (Air Waybill), air waybill or Aerial Knowledge, is the main document in the contract of carriage by air.
This document, unlike the bill of lading, does not give right over the merchandise but it does give the right to claim it. It is generally nominative, therefore not endorsable and non-negotiable. The document itself indicates it with the mention Not negotiable Air Waybill. It bears the signature of the carrier or its agent and an issue date. If the AWB is issued by a freight forwarder instead of a regular airline, then the AWB is called House Air Waybill (HAWB)
So that:
The Master Air Waybill (MAWB) is issued by the airline and delivered to the consolidator or consolidator. Aerial Knowledge covers a consolidated expedition, indicating the freight agent and/or the consolidator as shipper and the deconsolidator as consignee. However, the Master Air Waybill is the document that certifies each individual shipment of consolidated merchandise. It is issued by the consolidator and/or transitory and contains instructions for the deconsolidation agent.
Name Description Service name receiveMAWBEsp EndPoint https://ws_pods.hound-express.com/Sabueso/ws/deliveryServices/receiveMAWBEsp Headers https://apis-hound-express.readme.io/docs/the-headers-request Method POST Parameters JsonObject see: The guide object
RequestTo carry out the consumption of the service for the creation of the order it is necessary to send a json object of the MAWB type that contains the following fields:
MAWB
Field name Type MaxLength Required Comments mawb_number String 11 Required This is the folio number assigned by the Iata Agent on your MAWB, by standard it must be 11 digits number. In case the master number is already registered and you want to carry out an update, it is necessary to add the parameter "isUpdate" to the consumption, otherwise the system prevents duplication of MAWB creation with the same number.
mawb_format Byte(array)
Required Add the file with the digital version of the MAWB format on a byte array conversion.
mawb_format_fileName String 100 Required You must indicate the name of your file with pdf extension isUpdate Boolean True or false Required Validates if the MAWB was updated mawb_content Guide (Array)
Required This field must contain all the HAWB numbers, the numbers added here must correspond to the assigned tracking guide number generated using the
, if the order was created before you only need to fill the field guideNumber of each element of the array
mawb_object Object
Required General mawb data, some values are decimal, integer and text. expected_arrive_date String 20 Optional Please inform us about the date when the MAWB will arrive with us
expected format of the string is: yyyy-MM-dd HH:mm:ss using 24h standard
close_mawb Boolean True or false It is to close the MAWB in 10 hours.
MAWB OBJECT
Field name Type maxlength Required Comments weigth Double 5 Required Weight of the mawb paquetes Integer 5 Required Number of mawb packets id_origen Integer 2 Required if the mawb the origin is CN please put 18.To MX origin type 26. otherwise type 19. physicalWeight Double 5 Required Physical weight of the mawb volumetricWeight Double 5 Required Volumetric weight of the mawb Please review the section “VolumetricWeight.” colocacion String 3 Required Place the mawb customs of arrival if your mawb arrival in AIFA put NLU, else if your mawb arrival in CDMX put MEX, else if your mawb arrival in GDL put GDL, else if your mawb arrival in LAREDO put NLR bultos Integer 5 Required Mawb lumps
MAWB CONTENT
Field Name Type maxLength Required Comments guideNumber String 30 Required Guide number of HAWB saca String 30 Required it´s the bag id or your cartoon number of your product or house client_reference String 60 Required Client´s reference of your product in the case exist if not exist you can use a dummy zip code String 5 Optional Zip of your consignee sender Address Required It is the sender of the shipment receiver Address Required It is the consignee of the shipment rfc_curp String 18 Optional RFC: It is the unique registration key that identifies any person who carries out an economic activity and must contribute to public spending before the SAT.
CURP: The Unique Population Registration Code (CURP) is an instrument that individually registers all inhabitants of the country, both nationals and foreign residents, as well as Mexican men and women who live in other countries.
The tax identification number of the country of residence or the social security number in the case of foreigners.
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
( This section is only for users who don’t generate guides with Hound Express.)
sender(Address)
Field Name Type Maxlength Required Comments zip
(zip code)
String 10 Required Zip code for the address of the sender city String 100 Required City for the address of the sender country String 50 Required Country for the address of the sender String 100 Required Email address that helps to contact the sender street String 250 Required Street for the address of the sender phone Phone 100 Required Phone that helps to contact the sender contact PersonName
Required It is an object of the type PersonName see the
for reference
county String 100 Required Neighborhood, Town, municipality, district, County, etc. for the address of the receiver shipment state String 50 Optional State for the address of the sender streetNumber String 50 Optional Street and number of the sender's address apartmentNumber String 50 Optional Apartment, internal, etc. Number for the address of the sender
receiver(Address)
Field Name Type Maxlength Required Comments zip
(zip code)
String 10 Required Zip code for the address of the receiver shipment country String 50 Required Country for the address of the receiver shipment String 100 Required Email address that helps to contact the receiver street String 250 Required Street for the address of the receiver shipment phone Phone 100 Required Phone that helps to contact the receiver contact PersonName
Required It is an object of the type PersonName see the
for reference
city String 100 Required City for the address of the receiver shipment county String 100 Optional Neighborhood, Town, municipality, district, County, etc. for the address of the receiver shipment state String 50 Optional State for the address of the receiver shipment streetNumber String 50 Optional Street and number of the receiver's address apartmentNumber String 50 Optional Apartment, internal, etc. Number for the address of the receiver shipment
Contact
PersonName
Field Name Type Maxlength Required Comments givenName String 200 Required In this field it is expected to receive the name and may include the full name but it is recommended to divide it into its different parts within the PersonName object surname String 50 Optional This field is used for the paternal surname, although it is optional it is recommended not to include the full name inside the givenName but it is better to divide it, since it helps in later searches rfc String 18 Required The RFC is the identification number used by the SAT to identify individuals engaged in economic activities.
The CURP is a unique code that registers all residents of the country, both citizens and foreigners. For foreigners, the tax identification number from their country of residence or their social security number is used.
This section is only for users who don’t generate guides with Hound Express. If that’s not your case, you can skip it. If have duds, don’t forget you can use our artificial intelligence to generate an example
packagePieces
Field Name Type Maxlength Required Comments height Integer 9 Required In centimeters.
It must be an integer number.
length Integer Min Lenght: 1 Required In centimeters. This field is for the parcel measurements.
It must be an integer number.
width Integer Min Lenght: 1 Required In centimeters. This field is for the parcel measurements.
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
declaredValue Float 10,2 Required enter the declared value of the merchandise, since in Mexico and other countries there is a regulation in which the law requires the value of the merchandise to be declared and the description of the material contained in the shipment to be announced. description String 500 Optional Use this field to enter the description of the contents of the package descriptionSpanish String 500 Use this field to enter the description spanish of the contents of the package piece Integer 9 Required It is the TOTAL quantity of items that the package contains, regardless their variety.
Example: Assuming the shipment contains mice and cables, the pieces field must include the total number of articles:
For this example, if you bring 5 mice and 4 cables, the piece field should be filled as 9.
We fully understand that sometimes you have this information repeated for several shipments, so just as in the other cases you can place a fixed value.
made_in String 3 Required In this field, the CatCountryCode catalog code_alpha_3 must be sent. This field refers to the physical location of the final production of an item (where the product was manufactured). items Item(Array)
Optional In this field, you can specify the information for each item contained in the package
Items
Field Name Type Maxlength Required Comments quantity Integer 99 Required Min. 1 piece description String 100 Required Item description declaredValue Float 999.9 Required In Mexico and other countries there is a regulation where the law requires that the value of the merchandise is declared and the description of the material that the shipment contains must be announced. hts_code String 30 Required HTS stands for Harmonized Tariff Schedule, a classification system used in the United States to help determine customs duties to be paid on imports. HTS codes are 10-digits (the first six digits are the same as the HS code for the goods). made_in String 3 Required In this field, the CatCountryCode catalog code_alpha_3 must be sent. This field refers to the physical location of the final production of an item (where the product was manufactured). sku String 50 Optional SKU Item
VolumetricWeight :Is a measure used in logistics and shipping to determine how much space a package occupies in relation to its actual weight.
It is calculated using the formula:
Volumetric Weight = (length × height × width) / 5000where the dimensions are in centimeters and the result is in kilograms.
Response
Successful response
Field name Type Comments zipFile byteArray This field contains a zip folder that includes the excel and pdf of the manifest msg Array This field contains the message data.
Msg
Field Name Type Comments code String This field to indicate code of the response value String This field to indicate description of the response in english type String This field to indicate type of the response description String This field to indicate description of the response in spanish
wsErrors elements
Field Name Type Commens code String Error code type Integer Severity of the error description String Description with more details of the detected error
Errors
Type Code Description error ECGOFJ The object json is malformed, it must have a correctr structure, please verify the documentation on: [URL API DOCS] error NOMAWBF The field: mawb_format_fileName must not be empty error NOMAWBC The field: mawb_format must not be null and must have the byteArray of the digitalized MAWB error NOMAWBDF The field: Expected_arrive_date must be on yyyy-MM-dd HH:mm:ss format error NOWEIG The field: weight in mawb object is requered error NOPAQ The field: paquetes in mawb object is requered error NOPAQ The field: id_origen in mawb object is requered error NOPAQ The field: physicalWeight in mawb object is requered error NOPAQ The field: volumetricWeight in mawb object is requered error NOPAQ The field: colocacion in mawb object is requered error NOPAQ The field: bultos in mawb object is requered error NOMAT The field: manifest type in mawb object is requered error NOMAWBO The field: Mawb object is requered error ERROR The field: valor_declarado is required on guide: ( [MESSAGE] ) error ERROR The field: peso is required on guide: ( [MESSAGE] ) error ERROR we detect an error: ( [MESSAGE] ) error ERRHSC ( [MESSAGE] )
OK