API Reference

Webhooks

Puedes registrarte a webhooks desde tus Configuraciones > Integraciones

Esta documentación es para los webhooks versión 1

Puedes recibir webhooks para:

  • Nuevas guías.
  • Actualizaciones en el status de una guía.

Los webhooks mantienen el mismo formato de datos.
Este es un ejemplo para una nueva guía

{
    "type": "shipment.label_created",
    "purchase": {
        "object_status": "PAYED",
        "object_id": 2186646,
        "owner_id": 51306,
        "invoice_id": null,
        "invoice_url": null,
        "folio_alegra": null,
        "invoiced_at": null,
        "payment_provider": "mienvio_wallet",
        "payment_id": "mienvio_wallet_eQWGtEmFYx1751582825_51306",
        "last_4": null,
        "amount": 642.26,
        "created_at": "2025-07-03 17:47:05",
        "shipments": [
            {
                "object_purpose": "LABEL_CREATED",
                "status": "LABEL_CREATED",
                "created_at": "2025-07-03 17:45:13",
                "updated_at": "2025-07-03 15:47:13",
                "object_id": 6793308,
                "owner_id": 51306,
                "address_from": {
                    "object_type": "FROMTO",
                    "object_id": 12582535,
                    "name": "Adrian Camiruaga",
                    "street": "C. Lucerna 19",
                    "street2": "Juarez",
                    "reference": "Frente a Ctro Integrador Bienestar",
                    "zipcode": "06600",
                    "city": "Cuauht\u00e9moc",
                    "state": "Ciudad de M\u00e9xico",
                    "level_1": "06600",
                    "level_2": "Cuauht\u00e9moc",
                    "level_3": "Ciudad de M\u00e9xico",
                    "country": "Mexico",
                    "email": "[email protected]",
                    "phone": "3330573757",
                    "bookmark": false,
                    "alias": "Rappi origen",
                    "owner_id": 51306,
                    "active": true,
                    "metadata": null,
                    "origin_destiny": false,
                    "user_fiscal_id_number": "CATS990413B93",
                    "ups_shipper_number": null
                },
                "address_to": {
                    "object_type": "FROMTO",
                    "object_id": 11865706,
                    "name": "Cesar Martinez",
                    "street": "Isla Salomon 2600 Int 2 Jardines",
                    "street2": "Del Sur 2",
                    "reference": "asdsadsad",
                    "zipcode": "44950",
                    "city": "Guadalajara",
                    "state": "Jalisco",
                    "level_1": "44950",
                    "level_2": "Guadalajara",
                    "level_3": "Jalisco",
                    "country": "Mexico",
                    "email": "[email protected]",
                    "phone": "+523319654050",
                    "bookmark": false,
                    "alias": "11865706-order-address-to",
                    "owner_id": 51306,
                    "active": true,
                    "metadata": null,
                    "origin_destiny": true,
                    "user_fiscal_id_number": "XAXX010101000",
                    "ups_shipper_number": null
                },
                "weight": 0.5,
                "height": 10,
                "length": 10,
                "width": 10,
                "real_weight": 0,
                "real_volumetric_weight": 0,
                "real_height": 0,
                "real_length": 0,
                "real_width": 0,
                "weight_sent": null,
                "weight_difference": 0,
                "declared_value": 250,
                "description": "Armazones para tarjetas",
                "rate": {
                    "object_id": 13831024,
                    "amount": 0,
                    "currency": "MXN",
                    "min_weight": 0,
                    "max_weight": 150,
                    "servicelevel": "estandar",
                    "duration_terms": "5 a 12 d\u00edas h\u00e1biles",
                    "days": 10,
                    "trackable": true,
                    "collect_home": true,
                    "provider": "Estafeta",
                    "provider_img": "\/media\/providers\/Estafeta.svg",
                    "extended_zone": false,
                    "from_level_1": "",
                    "from_level_1_id": null,
                    "from_level_2": "",
                    "from_level_3": "",
                    "from_country": "",
                    "to_level_1": "",
                    "to_level_1_id": null,
                    "to_level_2": "",
                    "to_level_3": "",
                    "to_country": "",
                    "service_id": 0,
                    "owner_contract": false,
                    "product_id": null,
                    "is_ocurre": false,
                    "delivery_type": null,
                    "delivery_frequency": null,
                    "extended_zone_amount": null,
                    "exceed_dimensions_amount": null,
                    "collect_pct": null,
                    "collect_amount": null,
                    "eta": "2025-07-13",
                    "discount_pct": null,
                    "discount_amount": null,
                    "insurance_cost": 0,
                    "direct_delivery_cost": 0,
                    "saturday_delivery_cost": 0,
                    "signature_required_cost": 0,
                    "total_taxes": 0
                },
                "label": {
                    "id": 1929434,
                    "tracking_number": "700000000011270006K6CM",
                    "tracking_url": "https:\/\/tracking.mienvio.mx\/700000000011270006K6CM",
                    "label_url": "https:\/\/s3.amazonaws.com\/mienvio\/1751582832041978000_51306_700000000011270006K6CM.pdf",
                    "pickup": null
                },
                "insurance": null,
                "items": null,
                "order": null,
                "coupon_code": "",
                "overweight_charge": null,
                "currency": null,
                "devolution": false,
                "total": 0,
                "marketplace": "manual",
                "internal_id": null,
                "route": "paid",
                "pickups": [],
                "printed": false,
                "commercial_invoice": null,
                "is_international": false,
                "has_insurance": 0,
                "direct_delivery": 0,
                "saturday_delivery": 0,
                "delivery_signature_type": 0,
                "signature_required_cost": 0,
                "saturday_delivery_cost": 0,
                "direct_delivery_cost": 0,
                "total_taxes": 0,
                "package": null
            }
        ],
        "invoice_detail": null
    },
    "shipments": [
        {
            "shipment_id": 6793308,
            "weight": "0.50",
            "amount": "642.26",
            "label_url": "https:\/\/s3.amazonaws.com\/mienvio\/1751582832041978000_51306_700000000011270006K6CM.pdf",
            "tracking": "700000000011270006K6CM"
        }
    ]
}

Ejemplo de un webhook para cambio de estado en el envio.

{
    "type": "shipment.label_created",
    "purchase": {
        "object_status": "PAYED",
        "object_id": 2186646,
        "owner_id": 51306,
        "invoice_id": null,
        "invoice_url": null,
        "folio_alegra": null,
        "invoiced_at": null,
        "payment_provider": "mienvio_wallet",
        "payment_id": "mienvio_wallet_eQWGtEmFYx1751582825_51306",
        "last_4": null,
        "amount": 642.26,
        "created_at": "2025-07-03 17:47:05",
        "shipments": [
            {
                "object_purpose": "LABEL_CREATED",
                "status": "LABEL_CREATED",
                "created_at": "2025-07-03 17:45:13",
                "updated_at": "2025-07-03 15:47:13",
                "object_id": 6793308,
                "owner_id": 51306,
                "address_from": {
                    "object_type": "FROMTO",
                    "object_id": 12582535,
                    "name": "Adrian Camiruaga",
                    "street": "C. Lucerna 19",
                    "street2": "Juarez",
                    "reference": "Frente a Ctro Integrador Bienestar",
                    "zipcode": "06600",
                    "city": "Cuauht\u00e9moc",
                    "state": "Ciudad de M\u00e9xico",
                    "level_1": "06600",
                    "level_2": "Cuauht\u00e9moc",
                    "level_3": "Ciudad de M\u00e9xico",
                    "country": "Mexico",
                    "email": "[email protected]",
                    "phone": "3330573757",
                    "bookmark": false,
                    "alias": "Rappi origen",
                    "owner_id": 51306,
                    "active": true,
                    "metadata": null,
                    "origin_destiny": false,
                    "user_fiscal_id_number": "CATS990413B93",
                    "ups_shipper_number": null
                },
                "address_to": {
                    "object_type": "FROMTO",
                    "object_id": 11865706,
                    "name": "Cesar Martinez",
                    "street": "Isla Salomon 2600 Int 2 Jardines",
                    "street2": "Del Sur 2",
                    "reference": "asdsadsad",
                    "zipcode": "44950",
                    "city": "Guadalajara",
                    "state": "Jalisco",
                    "level_1": "44950",
                    "level_2": "Guadalajara",
                    "level_3": "Jalisco",
                    "country": "Mexico",
                    "email": "[email protected]",
                    "phone": "+523319654050",
                    "bookmark": false,
                    "alias": "11865706-order-address-to",
                    "owner_id": 51306,
                    "active": true,
                    "metadata": null,
                    "origin_destiny": true,
                    "user_fiscal_id_number": "XAXX010101000",
                    "ups_shipper_number": null
                },
                "weight": 0.5,
                "height": 10,
                "length": 10,
                "width": 10,
                "real_weight": 0,
                "real_volumetric_weight": 0,
                "real_height": 0,
                "real_length": 0,
                "real_width": 0,
                "weight_sent": null,
                "weight_difference": 0,
                "declared_value": 250,
                "description": "Armazones para tarjetas",
                "rate": {
                    "object_id": 13831024,
                    "amount": 0,
                    "currency": "MXN",
                    "min_weight": 0,
                    "max_weight": 150,
                    "servicelevel": "estandar",
                    "duration_terms": "5 a 12 d\u00edas h\u00e1biles",
                    "days": 10,
                    "trackable": true,
                    "collect_home": true,
                    "provider": "Estafeta",
                    "provider_img": "\/media\/providers\/Estafeta.svg",
                    "extended_zone": false,
                    "from_level_1": "",
                    "from_level_1_id": null,
                    "from_level_2": "",
                    "from_level_3": "",
                    "from_country": "",
                    "to_level_1": "",
                    "to_level_1_id": null,
                    "to_level_2": "",
                    "to_level_3": "",
                    "to_country": "",
                    "service_id": 0,
                    "owner_contract": false,
                    "product_id": null,
                    "is_ocurre": false,
                    "delivery_type": null,
                    "delivery_frequency": null,
                    "extended_zone_amount": null,
                    "exceed_dimensions_amount": null,
                    "collect_pct": null,
                    "collect_amount": null,
                    "eta": "2025-07-13",
                    "discount_pct": null,
                    "discount_amount": null,
                    "insurance_cost": 0,
                    "direct_delivery_cost": 0,
                    "saturday_delivery_cost": 0,
                    "signature_required_cost": 0,
                    "total_taxes": 0
                },
                "label": {
                    "id": 1929434,
                    "tracking_number": "700000000011270006K6CM",
                    "tracking_url": "https:\/\/tracking.mienvio.mx\/700000000011270006K6CM",
                    "label_url": "https:\/\/s3.amazonaws.com\/mienvio\/1751582832041978000_51306_700000000011270006K6CM.pdf",
                    "pickup": null
                },
                "insurance": null,
                "items": null,
                "order": null,
                "coupon_code": "",
                "overweight_charge": null,
                "currency": null,
                "devolution": false,
                "total": 0,
                "marketplace": "manual",
                "internal_id": null,
                "route": "paid",
                "pickups": [],
                "printed": false,
                "commercial_invoice": null,
                "is_international": false,
                "has_insurance": 0,
                "direct_delivery": 0,
                "saturday_delivery": 0,
                "delivery_signature_type": 0,
                "signature_required_cost": 0,
                "saturday_delivery_cost": 0,
                "direct_delivery_cost": 0,
                "total_taxes": 0,
                "package": null
            }
        ],
        "invoice_detail": null
    },
    "shipments": [
        {
            "shipment_id": 6793308,
            "weight": "0.50",
            "amount": "642.26",
            "label_url": "https:\/\/s3.amazonaws.com\/mienvio\/1751582832041978000_51306_700000000011270006K6CM.pdf",
            "tracking": "700000000011270006K6CM"
        }
    ]
}