Enviadores

List saved recipients. Returns ids usable as to_id (each belongs to a sender — pass the matching from_id when shipping). Filters: sender_id, q, postal_code; paginated. Español: lista destinatarios guardados; usa sus ids como to_id junto con el from_id del remitente dueño.

list_recipients

List saved senders (the address book). Returns ids usable as from_id in get_shipping_rates and create_shipment — prefer ids over retyping addresses. Filters: q (name search), postal_code; paginated. Español: lista remitentes guardados; usa sus ids como from_id en vez de reescribir direcciones.

list_senders

List the account's shipments (paginated). Filters: guia (tracking number), status (created|collected|in_transit|out_for_delivery|delivered|exception|returned|cancelled|unknown), from/to (ISO dates). Español: lista los envíos de la cuenta con filtros opcionales.

list_shipments

List the account's webhooks in this connection's mode (live or sandbox): url, subscribed events, status (active / auto-disabled with the reason), consecutive failure count and the last delivery outcome. Secrets are never included. Español: lista los webhooks de la cuenta con su estado y última entrega.

list_webhooks

Quote a Mexican domestic shipment across all available carriers and compare services. Origin/destination: a bare postal code ({"postal_code":"01000"}), a full address, or saved from_id/to_id. One box: package. Several boxes (2-10) as ONE shipment: packages (never both). The result lists each distinct shipping service ONCE (carrier + service level, e.g. "DHL · Express") with its price range (price_from-price_to) and its bookable options (options[], cheapest first, each with its own rate_id and price). A rate_id is usable in create_shipment for 30 minutes. Prices are for shipping only: coverage (seguro) is not quoted or sold through this server. The quote answers within about 15 seconds: incomplete:true means some carrier quotes did not arrive in time — every listed option is still valid and bookable, and quoting again may list more. Español: cotiza con todas las paqueterías; cada servicio aparece UNA vez con su rango de precios y sus opciones (cada una con rate_id, vigente 30 minutos); package = una caja, packages = varias cajas en un mismo envío; los precios son solo de envío (el seguro no se cotiza ni se vende por este servidor); la cotización responde en unos 15 segundos y incomplete:true indica que algunas cotizaciones no llegaron a tiempo (las opciones listadas siguen siendo válidas; cotizar de nuevo puede mostrar más).

get_shipping_rates

Register an HTTPS endpoint that receives shipment and pickup events as they happen, instead of polling. Events: shipment.created, shipment.collected, shipment.in_transit, shipment.out_for_delivery, shipment.delivered, shipment.exception, shipment.returned, shipment.cancelled, pickup.resolved. The URL must be public https:// on port 443 or 8443 (private and internal hosts are rejected); max 5 active webhooks per account; a webhook is disabled automatically if the API key that registered it is revoked. The result includes the signing SECRET EXACTLY ONCE — it is derived, never stored, and can never be shown again. Each delivery is a POST whose X-Enviadores-Signature header is t=<unix>,v1=<hex HMAC-SHA256(secret, "<t>.<raw body>")>; failed deliveries retry with backoff (1m, 5m, 30m, 2h, 12h) and a webhook is auto-disabled after 20 consecutive failures. Sandbox (ek_test_) webhooks receive only the sandbox shipment.created / shipment.cancelled and the test ping. Español: registra un endpoint HTTPS que recibe eventos de envíos y recolecciones; el secreto de firma se muestra UNA sola vez; máximo 5 webhooks activos por cuenta.

register_webhook

Request cancellation of one of your shipments. Approval may be asynchronous depending on the carrier; the result includes the request state. Español: solicita la cancelación; la aprobación puede ser asíncrona según la paquetería.

cancel_shipment

REQUEST a carrier pickup (recolección) at the sender's address for a shipment you already created, so nobody has to drop the package off at a counter. This files a request — it does NOT book a courier. The Enviadores team arranges it with the carrier and emails the requester the outcome, so the result always comes back as awaiting_confirmation: never tell the user a pickup is confirmed. Pickups can be requested ONLY for Estafeta, FedEx, DHL, UPS and Paquetexpress; for any other carrier tell the user to take the package to one of that carrier's own points. One open pickup per shipment. Times are LOCAL (America/Mexico_City): give the courier a window, e.g. ready_time 10:00 / close_time 17:00. Español: SOLICITA la recolección a domicilio de un envío ya creado — no la agenda automáticamente; sólo con Estafeta, FedEx, DHL, UPS y Paquetexpress; nuestro equipo la confirma con la paquetería y avisa por correo; horarios en hora local de México.

schedule_pickup

Save a recipient under a sender (sender_id required) and get back its id for to_id. Same-content dedupe as senders. referencia/delivery_instructions travel to the carrier where supported. Español: guarda un destinatario bajo un remitente y devuelve su id para to_id.

create_recipient

Save a sender in the address book and get back its id for from_id. Idempotent by content: the same name+address reuses the existing row (no duplicates). name is the full name (given names + surnames); company is an optional extra. Español: guarda un remitente y devuelve su id; repetir la misma dirección reutiliza la fila.

create_sender

Send a signed {"event":"ping"} to one webhook RIGHT NOW (synchronous, 10s budget) and report whether the endpoint answered 2xx, its HTTP status and any transport error. Use it right after register_webhook, or to diagnose a webhook whose deliveries are failing. A failed ping never counts toward auto-disable. Español: envía un ping firmado al webhook y reporta si el endpoint respondió 2xx.

test_webhook

Track a shipment by tracking number (guía) on any supported carrier; returns the canonical status and its history. Español: rastrea una guía y devuelve el estatus canónico y su historial.

track_shipment

Validate a Mexican postal code against the official SEPOMEX catalog; returns state, municipality and colonias. Use it to confirm the CP and pick the right colonia before quoting. Español: valida un CP contra SEPOMEX y devuelve estado, municipio y colonias.

validate_postal_code