API Documentation
Overview
The Airpost API is following the REST architectural style and uses resource-oriented URLs as well as HTTP response codes to communicate any API error. All API responses return JSON and property names are pascal-cased, ascii strings.
In the right sidebar, you can find examples that work as they are. You only need to fill the ApiKey variable with your personal API key. You can find it under your user configuration on https://www.airpostgroup.com/UserPanel/MyAccount/MyAccounts
Sandbox Endpoint:
https://sandbox.airpost.com.mx/Api/
Production Endpoint:
https://app.airpost.mx/Api/
Authentication
In order to authenticate you need to use your User Name used to access to your account and your API key. You can find it under your profile. Authentication to our API is performed using HTTP Basic Auth. Please be sure to keep your API key secret so nobody else will create shipments with your account and without your authorization.
Basic Auth
Notification
Notification Object
WARNING = 1
INFO = 2
SUCCESS = 3
# Example Object
{
"Notification": {
"Code": "0",
"Message": "La solicitud ha sido procesada exitosamente.",
"Severity": 3
}
}
Contact
Contact Object
# Example Object
{
"Contact": {
"ContactName": "Luis Pérez",
"Company": "Airpost Group",
"StreetLine1": "Av. Patria #3117 O",
"StreetLine2": "Col. Loma Bonita",
"ZipCode": "45086",
"City": "Zapopan",
"County": "Zapopan",
"State": "Jalisco",
"Country": "México",
"StateCode": "JA",
"CountryCode": "MX",
"Phone1": "3338257149",
"Ext1": "",
"Phone2": "",
"Ext2": "",
"MobilePhone": "",
"Email": "contacto@airpost.mx",
"Notes": ""
}
}
Carrier
Carrier Object
AMPM = 2
DHL = 3
ESTAFETA = 4
FEDEX = 5
REGIONAL = 6
REDPACK = 7
SENDEX = 8
AIRPOST = 9
UPS = 10
ENVÍA = 11
TUFESA = 12
MÁXIMA = 13
MEXPOST_SEPOMEX = 14
VENCEDOR = 15
DASPACK = 16
VALLARTA_PLUS = 17
AEROMÉXICO = 18
FLECHA AMARILLA = 19
PAQUETEXPRESS = 20
TRAVISA = 21
POTOSINOS = 22
# Example Object
{
"Carrier": {
"CarrierId": 9,
"CarrierName": "AIRPOST",
"IsSuggestedProvider": true
}
}
Service
Service Object
NATIONAL_TWO_DAYS = 11
NATIONAL_EXPRESS = 13
NATIONAL_EXPRESS_PRIORITY = 18
NATIONAL_EXPRESS_PLUS = 19
INTERNATIONAL_ECONOMY = 21
INTERNATIONAL_EXPRESS_PRIORITY = 22
INTERNATIONAL_EXPRESS_PLUS = 23
NATIONAL_SATURDAY_DELIVERY = 24
NATIONAL_ECONOMY_FREIGHT = 29
NATIONAL_EXPRESS_FREIGHT = 30
INTERNATIONAL_ECONOMY_FREIGHT = 31
INTERNATIONAL_EXPRESS_FREIGHT = 32
NATIONAL_SAME_DAY = 38
USD
# Example Object
{
"Service": {
"ServiceId": 10,
"Carrier": {
"CarrierId": 4,
"CarrierName": "ESTAFETA",
"IsSuggestedProvider": false
},
"ServiceName": "NACIONAL ECONÓMICO",
"Unit": null,
"PublicPrice": 0,
"TaxRate": 0,
"Currency": null,
"EstimatedDeliveryDate": null,
"IsExtendedArea": false
}
}
Label
Label Object
# Example Object
{
"Label": {
"ShippingLabelBase64": ""
}
}
Event
Event Object
# Example Object
{
"Event":
{
"Code": null,
"Description": "En proceso de entrega Irapuato",
"Date": "2017-11-08T17:48:00Z",
"Location": {
"StreetLine1": null,
"StreetLine2": null,
"ZipCode": null,
"City": "IRAPUATO",
"County": null,
"State": "",
"Country": null,
"StateCode": null,
"CountryCode": "MX"
},
"Comments": null
}
}
Package
Package Object
USD
# Example Object
{
"Package": [
"PackageId": 999999999,
"Service": {
"ServiceId": 10,
"Carrier": {
"CarrierId": 4,
"CarrierName": "ESTAFETA",
"IsSuggestedProvider": false
},
"ServiceName": "NACIONAL ECONÓMICO",
"Unit": null,
"PublicPrice": 0,
"TaxRate": 0,
"Currency": null,
"EstimatedDeliveryDate": null,
"IsExtendedArea": false
},
"Label": {
"LabelId": 0,
"FileName": null,
"ContentType": null,
"FileBytes": null,
"IsMainMergedFile": false
},
"TrackingNumber": "9958698217781780277621",
"Weight": 25.6,
"Length": 20,
"Height": 20,
"Width": 20,
"Content": "LIBROS",
"PublicPrice": 210,
"TaxRate": 0,
"DeclaredValue": 0,
"Currency": "MXN",
"Reference": null,
"CostCenter": null,
"IsExtendedArea": false,
"IsPickedUp": true,
"IsDelivered": true,
"EstimatedDeliveryDate": "2017-11-13T22:23:22Z",
"DeliveryDate": "2017-11-08T18:58:00Z",
"ReceivedBy": "JAVIER M.",
"ShipmentStatus": "Entregado",
"ShipmentStatusCode": "DL",
"ShipmentSubstatus": "Recibido por: JAVIER M.",
"Events": []
}
}
Shipment
Shipment Object
# Example Object
{
"Shipment":
{
"ShipmentId": 999999,
"Sender": {
"ContactName": "Luis Pérez",
"Company": "Airpost Group",
"StreetLine1": "Av. Patria #3117 O",
"StreetLine2": "Col. Loma Bonita",
"ZipCode": "45086",
"City": "Zapopan",
"County": "Zapopan",
"State": "Jalisco",
"Country": "México",
"StateCode": "JA",
"CountryCode": "MX",
"Phone1": "3338257149",
"Ext1": "",
"Phone2": "",
"Ext2": "",
"MobilePhone": "",
"Email": "contacto@airpost.mx",
"Notes": ""
},
"Recipient": {
"ContactName": "Luis Pérez",
"Company": "Airpost Group",
"StreetLine1": "Av. Patria #3117 O",
"StreetLine2": "Col. Loma Bonita",
"ZipCode": "45086",
"City": "Zapopan",
"County": "Zapopan",
"State": "Jalisco",
"Country": "México",
"StateCode": "JA",
"CountryCode": "MX",
"Phone1": "3338257149",
"Ext1": "",
"Phone2": "",
"Ext2": "",
"MobilePhone": "",
"Email": "contacto@airpost.mx",
"Notes": ""
},
"ShipmentDate": "2017-11-06T22:23:22Z",
"ValueAddedServices": [],
"Packages": [
{
"PackageId": 999999999,
"Service": {
"ServiceId": 10,
"Carrier": {
"CarrierId": 4,
"CarrierName": "ESTAFETA",
"IsSuggestedProvider": false
},
"ServiceName": "NACIONAL ECONÓMICO",
"Unit": null,
"PublicPrice": 0,
"TaxRate": 0,
"Currency": null,
"EstimatedDeliveryDate": null,
"IsExtendedArea": false
},
"Label": {
"LabelId": 0,
"FileName": null,
"ContentType": null,
"FileBytes": null,
"IsMainMergedFile": false
},
"TrackingNumber": "9958698217781780277621",
"Weight": 25.6,
"Length": 20,
"Height": 20,
"Width": 20,
"Content": "LIBROS",
"PublicPrice": 210,
"TaxRate": 0,
"DeclaredValue": 0,
"Currency": "MXN",
"Reference": null,
"CostCenter": null,
"IsExtendedArea": false,
"IsPickedUp": true,
"IsDelivered": true,
"EstimatedDeliveryDate": "2017-11-13T22:23:22Z",
"DeliveryDate": "2017-11-08T18:58:00Z",
"ReceivedBy": "JAVIER M.",
"ShipmentStatus": "Entregado",
"ShipmentStatusCode": "DL",
"ShipmentSubstatus": "Recibido por: JAVIER M.",
"Events": [
{
"Code": null,
"Description": "En proceso de entrega Irapuato",
"Date": "2017-11-08T17:48:00Z",
"Location": {
"StreetLine1": null,
"StreetLine2": null,
"ZipCode": null,
"City": "IRAPUATO",
"County": null,
"State": "",
"Country": null,
"StateCode": null,
"CountryCode": "MX"
},
"Comments": null
},
{
"Code": null,
"Description": "Llegada a centro de distribución Irapuato",
"Date": "2017-11-08T15:43:00Z",
"Location": {
"StreetLine1": null,
"StreetLine2": null,
"ZipCode": null,
"City": "IRAPUATO",
"County": null,
"State": "",
"Country": null,
"StateCode": null,
"CountryCode": "MX"
},
"Comments": null
},
{
"Code": null,
"Description": "Llegada a centro de distribución Guadalajara",
"Date": "2017-11-07T01:11:00Z",
"Location": {
"StreetLine1": null,
"StreetLine2": null,
"ZipCode": null,
"City": "GUADALAJARA",
"County": null,
"State": "",
"Country": null,
"StateCode": null,
"CountryCode": "MX"
},
"Comments": null
}
]
}
],
"CustomsClearanceDetail": null
}
}
GET | Track
Track a shipment.
Track Object
ENGLISH = 1
PACKAGE_ID = 1
TRACKING_NUMBER = 2
REFERENCE = 3
# Example Request https://app.airpost.mx/Api/Track?preferredLanguage=0&searchTerm=70279079&trackingType=2
# Example Response { "Shipments": [ { "ShipmentId": 999999, "Sender": { "ContactName": "Luis Pérez", "Company": "Airpost Group", "StreetLine1": "Av. Patria #3117 O", "StreetLine2": "Col. Loma Bonita", "ZipCode": "45086", "City": "Zapopan", "County": "Zapopan", "State": "Jalisco", "Country": "México", "StateCode": "JA", "CountryCode": "MX", "Phone1": "3338257149", "Ext1": "", "Phone2": "", "Ext2": "", "MobilePhone": "", "Email": "contacto@airpost.mx", "Notes": "" }, "Recipient": { "ContactName": "Luis Pérez", "Company": "Airpost Group", "StreetLine1": "Av. Patria #3117 O", "StreetLine2": "Col. Loma Bonita", "ZipCode": "45086", "City": "Zapopan", "County": "Zapopan", "State": "Jalisco", "Country": "México", "StateCode": "JA", "CountryCode": "MX", "Phone1": "3338257149", "Ext1": "", "Phone2": "", "Ext2": "", "MobilePhone": "", "Email": "contacto@airpost.mx", "Notes": "" }, "ShipmentDate": "2017-11-06T22:23:22Z", "ValueAddedServices": [], "Packages": [ { "PackageId": 999999999, "Service": { "ServiceId": 10, "Carrier": { "CarrierId": 4, "CarrierName": "ESTAFETA", "IsSuggestedProvider": false }, "ServiceName": "NACIONAL ECONÓMICO", "Unit": null, "PublicPrice": 0, "TaxRate": 0, "Currency": null, "EstimatedDeliveryDate": null, "IsExtendedArea": false }, "Label": { "LabelId": 0, "FileName": null, "ContentType": null, "FileBytes": null, "IsMainMergedFile": false }, "TrackingNumber": "9958698217781780277621", "Weight": 25.6, "Length": 20, "Height": 20, "Width": 20, "Content": "LIBROS", "PublicPrice": 210, "TaxRate": 0, "DeclaredValue": 0, "Currency": "MXN", "Reference": null, "CostCenter": null, "IsExtendedArea": false, "IsPickedUp": true, "IsDelivered": true, "EstimatedDeliveryDate": "2017-11-13T22:23:22Z", "DeliveryDate": "2017-11-08T18:58:00Z", "ReceivedBy": "JAVIER M.", "ShipmentStatus": "Entregado", "ShipmentStatusCode": "DL", "ShipmentSubstatus": "Recibido por: JAVIER M.", "Events": [ { "Code": null, "Description": "En proceso de entrega Irapuato", "Date": "2017-11-08T17:48:00Z", "Location": { "StreetLine1": null, "StreetLine2": null, "ZipCode": null, "City": "IRAPUATO", "County": null, "State": "", "Country": null, "StateCode": null, "CountryCode": "MX" }, "Comments": null }, { "Code": null, "Description": "Llegada a centro de distribución Irapuato", "Date": "2017-11-08T15:43:00Z", "Location": { "StreetLine1": null, "StreetLine2": null, "ZipCode": null, "City": "IRAPUATO", "County": null, "State": "", "Country": null, "StateCode": null, "CountryCode": "MX" }, "Comments": null }, { "Code": null, "Description": "Llegada a centro de distribución Guadalajara", "Date": "2017-11-07T01:11:00Z", "Location": { "StreetLine1": null, "StreetLine2": null, "ZipCode": null, "City": "GUADALAJARA", "County": null, "State": "", "Country": null, "StateCode": null, "CountryCode": "MX" }, "Comments": null } ] } ], "CustomsClearanceDetail": null } ], "Notifications": [ { "Code": "0", "Message": "La solicitud ha sido procesada exitosamente.", "Severity": 3 } ] }
POST | Rate
Rate a shipment.
Rate Object
ENGLISH = 1
# Example Request { "PreferredLanguage": 0, "Shipment": { "Sender": { "ZipCode": "45086", "City": "Zapopan", "County": "Zapopan", "State": "Jalisco", "Country": "México", "StateCode": "JA", "CountryCode": "MX" }, "Recipient": { "ZipCode": "06600", "City": "Ciudad de México", "County": "Cuauhtémoc", "State": "Ciudad de México", "Country": "México", "StateCode": "DF", "CountryCode": "MX" }, "Packages": [ { "Weight": 25.6, "Length": 20, "Height": 20, "Width": 20 } ] } }
# Example Response { "Services": [ { "ServiceId": 10, "Carrier": { "CarrierId": 12, "CarrierName": "TUFESA", "IsSuggestedProvider": false }, "ServiceName": "NACIONAL ECONÓMICO", "Unit": "", "PublicPrice": 175.50, "TaxRate": 16, "Currency": "MXN", "EstimatedDeliveryDate": "18/11/2017 11:59:00 p. m.", "IsExtendedArea": false }, { "ServiceId": 10, "Carrier": { "CarrierId": 7, "CarrierName": "REDPACK", "IsSuggestedProvider": false }, "ServiceName": "NACIONAL ECONÓMICO", "Unit": "", "PublicPrice": 175.50, "TaxRate": 16, "Currency": "MXN", "EstimatedDeliveryDate": "19/11/2017 11:59:00 p.m.", "IsExtendedArea": false }, { "ServiceId": 10, "Carrier": { "CarrierId": 1, "CarrierName": "AEROFLASH", "IsSuggestedProvider": true }, "ServiceName": "NACIONAL ECONÓMICO", "Unit": "", "PublicPrice": 175.50, "TaxRate": 16, "Currency": "MXN", "EstimatedDeliveryDate": "15/11/2017 11:59:00 p. m.", "IsExtendedArea": false }, { "ServiceId": 10, "Carrier": { "CarrierId": 8, "CarrierName": "SENDEX", "IsSuggestedProvider": true }, "ServiceName": "NACIONAL ECONÓMICO", "Unit": "", "PublicPrice": 175.50, "TaxRate": 16, "Currency": "MXN", "EstimatedDeliveryDate": "18/11/2017 11:59:00 p. m.", "IsExtendedArea": false }, { "ServiceId": 10, "Carrier": { "CarrierId": 4, "CarrierName": "ESTAFETA", "IsSuggestedProvider": false }, "ServiceName": "NACIONAL ECONÓMICO", "Unit": "", "PublicPrice": 175.50, "TaxRate": 16, "Currency": "MXN", "EstimatedDeliveryDate": "19/11/2017 11:59:00 p.m.", "IsExtendedArea": false }, { "ServiceId": 10, "Carrier": { "CarrierId": 5, "CarrierName": "FEDEX", "IsSuggestedProvider": true }, "ServiceName": "NACIONAL ECONÓMICO", "Unit": "", "PublicPrice": 175.50, "TaxRate": 16, "Currency": "MXN", "EstimatedDeliveryDate": "18/11/2017 09:00:00 p. m. ", "IsExtendedArea": false }, { "ServiceId": 13, "Carrier": { "CarrierId": 5, "CarrierName": "FEDEX", "IsSuggestedProvider": true }, "ServiceName": "NACIONAL EXPRÉS", "Unit": "", "PublicPrice": 175.50, "TaxRate": 16, "Currency": "MXN", "EstimatedDeliveryDate": "14/11/2017 09:00:00 p. m. ", "IsExtendedArea": false }, { "ServiceId": 18, "Carrier": { "CarrierId": 5, "CarrierName": "FEDEX", "IsSuggestedProvider": true }, "ServiceName": "NACIONAL EXPRÉS PRIORITARIO", "Unit": "", "PublicPrice": 175.50, "TaxRate": 16, "Currency": "MXN", "EstimatedDeliveryDate": "14/11/2017 10:30:00 a. m. ", "IsExtendedArea": false }, { "ServiceId": 34, "Carrier": { "CarrierId": 10, "CarrierName": "UPS", "IsSuggestedProvider": true }, "ServiceName": "NACIONAL EXPRÉS", "Unit": "", "PublicPrice": 175.50, "TaxRate": 4, "Currency": "MXN", "EstimatedDeliveryDate": "14/11/2017 11:30:00 p. m.", "IsExtendedArea": false }, { "ServiceId": 22, "Carrier": { "CarrierId": 10, "CarrierName": "UPS", "IsSuggestedProvider": true }, "ServiceName": "NACIONAL EXPRÉS PRIORITARIO", "Unit": "", "PublicPrice": 175.50, "TaxRate": 4, "Currency": "MXN", "EstimatedDeliveryDate": "14/11/2017 10:30:00 a. m.", "IsExtendedArea": false }, { "ServiceId": 23, "Carrier": { "CarrierId": 10, "CarrierName": "UPS", "IsSuggestedProvider": true }, "ServiceName": "NACIONAL EXPRÉS PLUS", "Unit": "", "PublicPrice": 175.50, "TaxRate": 4, "Currency": "MXN", "EstimatedDeliveryDate": "14/11/2017 08:30:00 a. m.", "IsExtendedArea": false }, { "ServiceId": 13, "Carrier": { "CarrierId": 7, "CarrierName": "REDPACK", "IsSuggestedProvider": false }, "ServiceName": "NACIONAL EXPRÉS", "Unit": "", "PublicPrice": 175.50, "TaxRate": 16, "Currency": "MXN", "EstimatedDeliveryDate": "14/11/2017 11:59:00 p.m.", "IsExtendedArea": false }, { "ServiceId": 19, "Carrier": { "CarrierId": 5, "CarrierName": "FEDEX", "IsSuggestedProvider": true }, "ServiceName": "NACIONAL EXPRÉS PLUS", "Unit": "", "PublicPrice": 175.50, "TaxRate": 16, "Currency": "MXN", "EstimatedDeliveryDate": "14/11/2017 08:30:00 a. m. ", "IsExtendedArea": false } ], "Notifications": [ { "Code": "0", "Message": "La solicitud ha sido procesada exitosamente.", "Severity": 3 } ] }
POST | Create
Create a shipment.
Shipment Object
ENGLISH = 1
# Example Request { "PreferredLanguage": 0, "Shipment": { "Sender": { "ContactName": "Juan Pérez", "Company": "Airpost Group", "StreetLine1": "Av. Patria #3117 O", "StreetLine2": "Col. Loma Bonita", "ZipCode": "45086", "City": "Zapopan", "County": "Zapopan", "State": "Jalisco", "Country": "Mexico", "StateCode": "JA", "CountryCode": "MX", "Phone1": "3338257149", "Email": "contacto@airpost.mx" }, "Recipient": { "ContactName": "Juan Pérez", "Company": "Museo Tamayo", "StreetLine1": "Paseo de la Reforma #51", "StreetLine2": "Col. Bosque de Chapultepec", "ZipCode": "11580", "City": "Miguel Hidalgo", "County": "Miguel Hidalgo", "State": "Ciudad de México", "Country": "Mexico", "StateCode": "DF", "CountryCode": "MX", "Phone1": "5541228200", "Email": "contacto@museo.org" }, "Packages": [ { "Weight": 3, "Length": 41, "Height": 31, "Width": 20, "Content": "LIBROS", "Service": { "ServiceId": 13, "Carrier": { "CarrierId": 10, "CarrierName": "UPS" } } } ] } }
# Example Response { { "Shipment": { "ShipmentId": 999669, "Sender": { "Id": 71632, "ContactName": "JUAN PÉREZ", "Company": "AIRPOST GROUP", "GovernmentId": "", "TaxpayerId": "", "Phone1": "3338257149", "Ext1": "", "Phone2": "", "Ext2": "", "MobilePhone": "", "Email": "CONTACTO@AIRPOST.MX", "StreetLine1": "AV. PATRIA #3117 O", "StreetLine2": "COL. LOMA BONITA", "ZipCode": "45086", "City": "ZAPOPAN", "County": "ZAPOPAN", "State": "JALISCO", "Country": "MÉXICO (MX)", "StateCode": "", "CountryCode": "" }, "Recipient": { "Id": 55534, "ContactName": "JUAN PÉREZ", "Company": "MUSEO TAMAYO", "GovernmentId": "", "TaxpayerId": "", "Phone1": "5541228200", "Ext1": "", "Phone2": "", "Ext2": "", "MobilePhone": "", "Email": "CONTACTO@MUSEO.ORG", "StreetLine1": "PASEO DE LA REFORMA #51", "StreetLine2": "COL. BOSQUE DE CHAPULTEPEC", "ZipCode": "11580", "City": "MIGUEL HIDALGO", "County": "MIGUEL HIDALGO", "State": "CIUDAD DE MÉXICO", "Country": "MÉXICO (MX)", "StateCode": "", "CountryCode": "" }, "ShipmentDate": "2018-01-11T18:11:11", "ValueAddedServices": [], "Packages": [ { "PackageId": 100251572, "Service": { "ServiceId": 13, "Carrier": { "CarrierId": 10, "CarrierName": "UPS", "IsSuggestedProvider": false }, "ServiceName": "NACIONAL EXPRÉS", "Unit": "", "PublicPrice": 0, "TaxRate": 0, "Currency": "", "EstimatedDeliveryDate": null, "IsExtendedArea": false }, "TrackingNumber": "1Z10A10X0493890107", "Weight": 3, "Length": 41, "Height": 31, "Width": 20, "TaxRate": 16, "PublicPrice": { "Amount": 1, "Currency": "MXN" }, "DeclaredValue": { "Amount": 0, "Currency": "MXN" }, "Content": "LIBROS", "Reference": "", "IsExtendedArea": false, "IsPickedUp": false, "IsDelivered": false, "EstimatedDeliveryDate": "0001-01-01T00:00:00", "DeliveryDate": "0001-01-01T00:00:00", "ReceivedBy": "", "ShipmentStatus": "", "ShipmentStatusCode": "", "ShipmentSubstatus": "", "Events": [] } ] }, "Label": { "ShippingLabelBase64": "" }, "Notifications": [ { "Code": "0", "Message": "La solicitud ha sido procesada exitosamente.", "Severity": 3 } ] } }
Notification List
Notification List
The request has been processed successfully.
The preferred language is not currently supported.
The weight of the packages to be documented must be greater than zero.
There is no coverage for the information provided.
There are no available services for the weight or the dimensions provided.
The data in the request you provided is invalid or incomplete.
The sender data in the request you provided is invalid or incomplete.
The recipient data in the request you provided is invalid or incomplete.
The authentication credentials are not valid.
The user is not enabled.
Your account is inactive because it has debts. Regularize your situation to continue with the service.
The search criteria is not valid or is not currently supported.
No results were found for the search information you have provided.
The shipment must contain at least one package.