Autopaquete API
!Bienvenidos a la API de Autopaquete! Nuestra API esta diseñada sobre REST y el formato
de respuesta para todos las peticiones es JSON.
Con los endpoints de la API de Autopaquete puede acceder a información
sobre envíos. Contamos con un ambiente de producción y un ambiente de prueba para acceder
a dichos ambientes debe contar con sus respectivos tokens.
Puedes ver ejemplos de código en la caja oscura a la derecha.
Autenticación
Todos los endpoints de la API Autopaquete requieren de una llave de API (o token de autenticación) que identifique la cuenta de usuario que se usará para realizar las operaciones. El token de autenticación tiene que enviarse como parte de la petición HTTP como valor de la cabecera ‘Authorization’.
HTTP Request
POST https://api.autopaquete.com.mx/
-
curl "https://api.autopaquete.com.mx/v1/rates"
-
-H "Authorization: Bearer <YOUR_API_KEY>"
-
-H "Content-Type: application/json"
Cotizar
Obtener la cotización del envío
Este endpoint recibe códigos postales y medidas del paquete. Devuelve una lista de servicios disponibles en la zona de destino con sus respectivas tarifas.
HTTP Request
POST https://api.autopaquete.com.mx/v1/rates
Parametros
Campo | Tipo | Descripción |
---|---|---|
zip_from | String | Código postal origen del paquete |
zip_to | String | Código postal destino del paquete |
parcel | Object | Información sobre medidas del paquete |
height | Int | Alto del paquete expresado en cm |
width | Int | Ancho del paquete expresado en cm |
depth | Int | Largo del paquete expresado en cm |
weight | Int | Peso del paquete expresado en kg |
product_value | Int | Valor del paquete expresado en MXN |
Respuesta
Campo | Tipo | Descripción | |
---|---|---|---|
parcel | Object | Información sobre medidas del paquete | |
rates | Array | Lista de servicios disponibles | |
Shipping_code | String | Identificador de la paqueteria | |
service_img | String | Imagen de la paqueteria | |
shipping_company | String | Nombre de la paqueteria | |
shipping_services | String | Nombre del servicio de la paqueteria | |
delivery_days | String | Descripción de los días de entrega | |
delivery_date | String | Fecha estimada de entrega | |
delivery_type | String | Tipo de entrega (domicilio o sucursal) | |
service_zone | String | Zona de servicio definido por la paqueteria | |
extended_area | Boolean | Indica si el servicio está fuera de la zona de entrega normal | |
shipping_rates | Object | Informacion detallada sobre costos de envío | |
base | Int | Precio base | |
extended_area | Int | Precio de servicio extra | |
zonification | Int | Costo de zonificación | |
insurance | Int | Costo del seguro del paquete | |
total | Int | Total del costo |
-
curl "https://api.autopaquete.com.mx/v1/rates"
-
-H "Authorization: Bearer <YOUR_API_KEY>"
-
-H "Content-Type: application/json"
-
-d '{
"zip_from": "44100",
"zip_to": "49500",
"parcel": {
"height": 1,
"width": 5,
"depth": 5,
"weight": 1,
"product_value": 0
}
}'
{
"zip_from": "44100",
"city_from": "Guadalajara",
"state_from": "Jalisco",
"zip_to": "49500",
"city_to": "Mazamitla",
"state_to": "Jalisco",
"parcel": {
"height": 1,
"width": 5,
"depth": 5,
"weight": 1,
"product_value": 0,
"volumetric_weight": 1,
"total_weight": 1
},
"rates": [
{
"shipping_code": "ESTAFETA_ECONOMICO",
"service_img": "https://api.autopaquete.com.mx/media/services/estafeta.png",
"shipping_company": "ESTAFETA",
"shipping_services": "ESTAFETA TERRESTRE",
"delivery_days": "1 a 3 días hábiles",
"delivery_date": "2023-03-21",
"delivery_type": "NORMAL",
"service_zone": null,
"extended_area": true,
"shipping_rates": {
"base": 15,
"extra_weight": 0,
"excess_weight": 0,
"excess_dimensions": 0,
"extended_area": 160,
"zonification": 0,
"fuel": 22.75,
"insurance": 0,
"subtotal": 197.75,
"iva": 31.64,
"total": 229.39,
"currency": "MXN",
}
},
{
"shipping_code": "ESTAFETA_ECONOMICO_B",
"service_img": "https://api.autopaquete.com.mx/media/services/estafeta_Qap2rsn.png",
"shipping_company": "ESTAFETA",
"shipping_services": "ESTAFETA TERRESTRE",
"delivery_days": "1 a 3 días hábiles",
"delivery_date": "2023-03-21",
"delivery_type": "NORMAL",
"service_zone": null,
"extended_area": true,
"shipping_rates": {
"base": 27,
"extra_weight": 0,
"excess_weight": 0,
"excess_dimensions": 0,
"extended_area": 160,
"zonification": 0,
"fuel": 0,
"insurance": 0,
"subtotal": 187,
"iva": 29.92,
"total": 216.92,
"currency": "MXN",
}
}
]
}
Enviar
Crear un envío
Valida los datos de entrada y los envía a la paqueteria seleccionada para generar el envío.
HTTP Request
POST https://api.autopaquete.com.mx/v1/shippings
Parametros
Campo | Tipo | Descripción |
---|---|---|
shipping_code | String | Identificador de la paqueteria |
address_from | Object | Dirección de origen |
address_to | Object | Dirección de entrega |
parcel | Object | Información del paquete |
product_value | Int | Valor del producto expresado en MXN |
insurance | Boolean | Envío asegurado |
Respuesta
Campo | Tipo | Descripción |
---|---|---|
id | String | Identificador único del envío |
creation_date | String | Fecha y hora de la creación del envío |
shipping_label_id | String | Identificador único de la etiqueta de envío |
shipping_tracking_id | String | Identificador único del seguimiento de envío |
shipping_code | String | Identificador de la paqueteria |
service_img | String | Imagen de la paqueteria |
shipping_company | String | Nombre de la paqueteria |
shipping_services | String | Nombre del servicio |
delivery_days | String | Descripción de los días de entrega |
delivery_date | String | Fecha estimada de entrega |
delivery_type | String | Tipo de entrega (domicilio o sucursal) |
service_zone | String | Zona de servicio definido por la paqueteria |
extended_area | Boolean | Indica si el servicio está fuera de la zona de entrega normal |
address_from | Object | Dirección de origen |
address_to | Object | Dirección de entrega |
Parcel | Object | Información del paquete |
bienes_transp | Int | Clave del producto definido por el SAT |
paking_code | String | Código del paquete definido por el SAT |
shipping_rates | Object | Información detallada de los costos de envío |
base | Int | Precio base |
extended_area | Int | Precio de servicio extra |
zonification | Int | Costo de zonificación |
insurance | Int | Costo del seguro del paquete |
total | Int | Total del costo |
current_balance | Int | Saldo actual |
label | String | PDF de la guía códificada en base 64 |
-
curl "https://api.autopaquete.com.mx/v1/shippings"
-
-H "Authorization: Bearer <YOUR_API_KEY>"
-
-H "Content-Type: application/json"
-
-d '
{
"shipping_code": "ESTAFETA_ECONOMICO_B",
"address_from":{
"company": "Autopaquete Servicios SA de CV",
"name": "Aris Bersain Osorio Villa",
"phone": 3333333333,
"email": "[email protected]",
"street": "Circunvalacion Poniente",
"street_number":"37",
"neighborhood":"Fracc La Concordia",
"zip_code": "45530",
"reference":"una casa"
},
"address_to":{
"company": "Autopaquete Servicios SA de CV",
"name": "Aris Bersain Osorio Villa",
"phone": 3333333333,
"email": "[email protected]",
"street":"San Ignacio",
"street_number":"15",
"neighborhood":"Francisco I madero",
"zip_code": "24344",
"reference":"Casa de dos pisos color rojo"
},
"parcel":{
"product_description": "INSUMOS",
"product_value": 100,
"insurance": false,
"height": 10,
"width": 25,
"depth": 30,
"weight": 70
}
}
'
{
"id": "a0f4b85f-668e-466a-9fd5-f55ecdfa7fee",
"creation_date": "2023-03-17T15:15:45.330658",
"update_date": "2023-03-17T15:15:45.330658",
"shipping_tracking_id": null,
"shipping_code": "ESTAFETA_ECONOMICO_B",
"service_img": "https://api.autopaquete.com.mx/media/services/estafeta_vT7C6Xa.png",
"shipping_company": "ESTAFETA",
"shipping_services": "ESTAFETA TERRESTRE",
"delivery_days": "1 a 3 días hábiles",
"delivery_date": "2023-03-21",
"delivery_type": "NORMAL",
"service_zone": null,
"extended_area": false,
"address_from": {
"company": "Autopaquete Servicios SA de CV",
"name": "Aris Bersain Osorio Villa",
"phone": 3310524928,
"email": "[email protected]",
"street": "Circunvalacion Poniente",
"street_number": "37",
"neighborhood": "Fracc La Concordia",
"zip_code": "45530",
"reference": "una casa",
"rfc": "MEBA930127MJ7",
"city": "San Pedro Tlaquepaque",
"state": "Jalisco"
},
"address_to": {
"company": "Autopaquete Servicios SA de CV",
"name": "Aris Bersain Osorio Villa",
"phone": 3310524928,
"email": "[email protected]",
"street": "San fernando",
"street_number": "15",
"neighborhood": "Nueva Santa Maria",
"zip_code": "24344",
"reference": "Casa de dos pisos color rojo",
"rfc": "XAXX010101000",
"city": "Candelaria",
"state": "Jalisco"
},
"parcel": {
"product_description": "INSUMOS",
"product_value": 100,
"insurance": false,
"height": 10,
"width": 25,
"depth": 30,
"weight": 70,
"bienes_transp": "44121500",
"paking_code": "4G",
"volumetric_weight": 2,
"total_weight": 70,
},
"shipping_rates": {
"base": 49,
"extra_weight": 1848,
"excess_weight": ,
"excess_dimensions": 0,
"extended_area": 0,
"zonification": 0,
"fuel": 0,
"insurance": 0,
"subtotal": 1897,
"iva": 303.52,
"total": 2200.52,
"currency": "MXN"
},
"current_balance": 1055209.87,
"label": "<base_64>"
}