🚧
If you need help don't forget to use our artificial intelligence
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.
📘
To 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:
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_object | Object | - | Required | General mawb data, some values are decimal, integer and text. |
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 create order service , if the order was created before you only need to fill the field guideNumber of each element of the array |
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 |
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 |
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 |
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 |
Field Name | Type | maxLength | Required | Comments |
---|
guideNumber | String | 30 | Required | Guide number of HAWB |
description_complementary | String | 500 | Required | it´s the description of your product |
saca | String | 30 | Required | it´s the bag id or your cartoon number of your product or house |
piece | Integer | 5 | Optional | Total pieces of product |
valor_declarado | Double | 10 | Required | Declared value of your product in USD |
peso | Double | 10 | Optional | Weight of your product |
zip code | Integer | 5 | Optional | Zip of your consignee |
client_reference | String | 60 | Required | Client´s reference of your product in the case exist if not exist you can use a dummy |
sender | Address | | Required | It is the sender of the shipment |
receiver | Address | | Required | It is the consignee of the shipment |
antidumping | Integer | | Optional | Identify, by catalog, whether a product is eligible for antidumping duty application |
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. |
hts_code | Integer | 10
Min 6 | Optional | 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 | Integer | | Optional | Identify, by catalog, the physical location of the final production of an item (where the product was manufactured). |
Field Name | Type | Maxlength | Required | Comments |
---|
zip
(zip code) | Integer | 10 | Required | Zip code for the address of the sender |
contact | PersonName | - | Required | It is an object of the type PersonName see the PersonName for reference |
city | String | 100 | Required | City for the address of the sender |
country | String | 50 | Required | Country for the address of the sender |
county | String | 100 | Required | Neighborhood, Town, municipality, district, County, etc. for the address of the receiver shipment |
street | String | 250 | Required | Street for the address of the sender |
phone | Phone | 100 | Required | Phone that helps to contact the sender |
Field Name | Type | Maxlength | Required | Comments |
---|
zip
(zip code) | Integer | 10 | Required | Zip code for the address of the receiver shipment |
contact | PersonName | - | Required | It is an object of the type PersonName see the PersonName for reference |
city | String | 100 | Required | City for the address of the receiver shipment |
country | String | 50 | Required | Country for the address of the receiver shipment |
county | String | 100 | Required | Neighborhood, Town, municipality, district, County, etc. for the address of the receiver shipment |
street | String | 250 | Required | Street for the address of the receiver shipment |
phone | Phone | 100 | Required | Phone that helps to contact the receiver |
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 |
👍
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. |
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 |
❗️
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] ) |