# SendIt

> Documentación del API de SendIt — cotiza con múltiples paqueterías, genera guías y rastrea envíos en México.

## Docs

- [Documentación de SendIt](https://docs.sendit.mx/): Una sola API REST para cotizar, generar guías y rastrear envíos con todas las paqueterías de México.

## Primeros pasos

- [Tu primera guía](https://docs.sendit.mx/getting-started/quickstart): Crea un envío, compara cotizaciones y compra tu primera guía en modo de prueba — de cero a PDF en minutos.
- [Autenticación y llaves de API](https://docs.sendit.mx/getting-started/authentication): Autentica cada petición con llaves sk_test_ y sk_live_: creación, alcances, rotación y buenas prácticas.
- [Modo de prueba](https://docs.sendit.mx/getting-started/test-mode): Un sandbox aislado con formas de API conocidas, paqueterías simuladas y saldo virtual, sin dinero real.
- [Organizaciones y sandbox personal](https://docs.sendit.mx/getting-started/organizations-and-sandbox): Cómo funcionan las organizaciones, tu organización personal de pruebas y el cambio de contexto entre equipos.
- [Pruébalo en Postman](https://docs.sendit.mx/getting-started/postman): Importa el API completo en Postman con un clic desde la especificación OpenAPI, y conecta agentes de IA con llms.txt.

## Convenciones del API

- [Errores y formato de respuesta](https://docs.sendit.mx/api-conventions/errors): El sobre de respuesta estándar, el objeto de error y cómo resolver cada código que puede devolver el API.
- [Paginación y filtros](https://docs.sendit.mx/api-conventions/pagination-and-filtering): Cómo paginar cada listado del API, qué filtros acepta cada recurso y cómo traer muchos recursos en una sola llamada.
- [Límites de peticiones](https://docs.sendit.mx/api-conventions/rate-limits): Los presupuestos por clase de endpoint (read, write, quote), los encabezados X-RateLimit-* y cómo manejar un 429 con reintentos correctos.
- [Idempotencia](https://docs.sendit.mx/api-conventions/idempotency): El encabezado Idempotency-Key, opcional pero recomendado, reproduce una petición interrumpida sin riesgo de cargos duplicados.
- [Versionamiento del API](https://docs.sendit.mx/api-conventions/versioning): Versionamiento por fecha al estilo de las mejores plataformas: fija tu versión y actualiza cuando tú decidas.
- [Alcances (scopes)](https://docs.sendit.mx/api-conventions/scopes): La lista canónica de alcances y cómo limitar cada llave de API al mínimo privilegio necesario.
- [Operaciones asíncronas](https://docs.sendit.mx/api-conventions/asynchronous-operations): Elige entre la respuesta síncrona predeterminada y la compra asíncrona opcional de guías.
- [Registros de peticiones](https://docs.sendit.mx/api-conventions/request-logs): Consulta el metadato de cada llamada de tu organización al API: método, ruta, código de estado y duración.

## Envíos

- [Envíos](https://docs.sendit.mx/shipping/shipments): El objeto shipment, su ciclo de vida y cómo crear, consultar y cancelar envíos.
- [Direcciones y validación](https://docs.sendit.mx/shipping/addresses): Direcciones a nivel colonia, validación contra catálogos oficiales y búsqueda de códigos postales.
- [Cotizaciones](https://docs.sendit.mx/shipping/rates): Compara tarifas de todas las paqueterías en una sola llamada; el total cotizado es exactamente lo que pagas.
- [Guías](https://docs.sendit.mx/shipping/labels): Compra una guía a partir de una cotización: el precio cotizado es el precio cobrado, sin sorpresas.
- [Cancelaciones y reembolsos](https://docs.sendit.mx/shipping/refunds): Cancela guías no usadas y recibe el crédito completo en tu monedero.
- [Recolecciones](https://docs.sendit.mx/shipping/pickups): Programa recolecciones a domicilio con cualquier paquetería, consulta su estado y cancélalas cuando lo necesites.
- [Reglas de envío](https://docs.sendit.mx/shipping/shipping-rules): Automatiza la selección de paquetería y servicio con reglas SI/ENTONCES evaluadas en cada envío.
- [Lotes y manifiestos](https://docs.sendit.mx/shipping/batches): Compra guías en lote de forma asíncrona, con resultados parciales y manifiestos por paquetería.
- [Rastreadores](https://docs.sendit.mx/shipping/trackers): Rastrea guías generadas fuera de SendIt con estados normalizados y webhooks, sin importar la paquetería.
- [Paqueterías y servicios](https://docs.sendit.mx/shipping/carriers): Consulta el catálogo de servicios y usa códigos exactos al elegir una cotización.
- [Cuentas de paquetería](https://docs.sendit.mx/shipping/carrier-accounts): Elige qué paqueterías y servicios cotizan para tu organización, y conecta tu propio contrato con una paquetería.
- [Rastreo público](https://docs.sendit.mx/shipping/public-tracking): Comparte un enlace opaco para que tu comprador consulte el paquete sin cuenta y sin exponer datos personales.

## Órdenes

- [Órdenes](https://docs.sendit.mx/orders/orders): Modela pedidos de tu tienda con artículos, canal de venta y uno o más envíos por orden.
- [Catálogo de productos](https://docs.sendit.mx/orders/products): Un catálogo opcional de productos que se vincula automáticamente a los artículos de tus órdenes.

## Monedero y facturación

- [Monedero y fondeo](https://docs.sendit.mx/wallet-and-billing/wallet): Tu saldo prepagado en MXN: fondea por SPEI, tarjeta o PayPal y consulta cada transacción.
- [Planes y cuotas](https://docs.sendit.mx/wallet-and-billing/subscriptions-and-quotas): Los planes de SendIt, las guías incluidas por mes y cómo funcionan los excedentes.
- [CFDI y facturación](https://docs.sendit.mx/wallet-and-billing/cfdi): Configura el perfil fiscal de tu organización y consulta sus registros de factura.
- [Seguros y reclamaciones](https://docs.sendit.mx/wallet-and-billing/insurance-claims): Asegura envíos por valor declarado y presenta reclamaciones con evidencia cuando algo sale mal.

## Webhooks y eventos

- [Webhooks](https://docs.sendit.mx/webhooks-and-events/webhooks): Recibe eventos en tu servidor: registro de endpoints, verificación de firmas HMAC y política de reintentos.
- [Notificaciones al destinatario](https://docs.sendit.mx/webhooks-and-events/notifications): Correos y mensajes de WhatsApp automáticos para tu comprador en cada hito del envío, con reglas de consentimiento y control por evento y canal.

## English

### Docs

- [SendIt documentation](https://docs.sendit.mx/en): One REST API to quote, generate labels, and track shipments with every major Mexican carrier.

### Getting started

- [Your first label](https://docs.sendit.mx/en/getting-started/quickstart): Create a shipment, compare rates, and buy your first label (guía) in test mode — from zero to PDF in minutes.
- [Authentication & API keys](https://docs.sendit.mx/en/getting-started/authentication): Authenticate every request with sk_test_ and sk_live_ keys: creation, scopes, rotation, and best practices.
- [Test mode](https://docs.sendit.mx/en/getting-started/test-mode): An isolated sandbox with familiar API shapes, simulated carriers, and a virtual balance, with no real money.
- [Organizations & personal sandbox](https://docs.sendit.mx/en/getting-started/organizations-and-sandbox): How organizations work, your personal test organization, and switching context between teams.
- [Try it in Postman](https://docs.sendit.mx/en/getting-started/postman): Import the full API into Postman in one click from the OpenAPI spec, and connect AI agents with llms.txt.

### API conventions

- [Errors & response format](https://docs.sendit.mx/en/api-conventions/errors): The standard response envelope, the error object, and how to resolve every code the API can return.
- [Pagination and filtering](https://docs.sendit.mx/en/api-conventions/pagination-and-filtering): How to paginate each API list, which filters each resource accepts, and how to fetch many resources in one call.
- [Rate limits](https://docs.sendit.mx/en/api-conventions/rate-limits): Per-endpoint-class budgets (read, write, quote), the X-RateLimit-* headers, and how to handle a 429 with correct retries.
- [Idempotency](https://docs.sendit.mx/en/api-conventions/idempotency): The Idempotency-Key header, optional but recommended, replays an interrupted request with no risk of duplicate charges.
- [API versioning](https://docs.sendit.mx/en/api-conventions/versioning): Date-based versioning: pin your version and upgrade on your own schedule, with a clear deprecation policy.
- [Scopes](https://docs.sendit.mx/en/api-conventions/scopes): The canonical scope list and how to limit each API key to the minimum privilege it needs.
- [Asynchronous operations](https://docs.sendit.mx/en/api-conventions/asynchronous-operations): Choose between the default synchronous response and optional asynchronous label purchasing.
- [Request logs](https://docs.sendit.mx/en/api-conventions/request-logs): Read the metadata for every API call your organization made: method, path, status code, and duration.

### Shipping

- [Shipments](https://docs.sendit.mx/en/shipping/shipments): The shipment object, its lifecycle, and how to create, retrieve, and cancel shipments.
- [Addresses & validation](https://docs.sendit.mx/en/shipping/addresses): Colonia-level addresses, validation against official catalogs, and postal code lookup.
- [Rates](https://docs.sendit.mx/en/shipping/rates): Compare rates from every carrier in a single call; the quoted total is exactly what you pay.
- [Labels](https://docs.sendit.mx/en/shipping/labels): Buy a label (guía) from a rate: the quoted price is the charged price, no surprises.
- [Refunds & voids](https://docs.sendit.mx/en/shipping/refunds): Void unused labels and receive the full credit back to your wallet.
- [Pickups](https://docs.sendit.mx/en/shipping/pickups): Schedule carrier pickups (recolecciones), check their status, and cancel them when needed.
- [Shipping rules](https://docs.sendit.mx/en/shipping/shipping-rules): Automate carrier and service selection with IF/THEN rules evaluated on every shipment.
- [Batches & manifests](https://docs.sendit.mx/en/shipping/batches): Buy labels in bulk asynchronously, with partial-success results and per-carrier manifests.
- [Trackers](https://docs.sendit.mx/en/shipping/trackers): Track labels generated outside SendIt with normalized statuses and webhooks, whatever the carrier.
- [Carriers and services](https://docs.sendit.mx/en/shipping/carriers): Read the service catalog and use exact codes when selecting a rate.
- [Carrier accounts](https://docs.sendit.mx/en/shipping/carrier-accounts): Choose which carriers (paqueterías) and services quote for your organization, and connect your own negotiated carrier contract.
- [Public tracking](https://docs.sendit.mx/en/shipping/public-tracking): Share an opaque link so your buyer can check a package without an account or exposed personal data.

### Orders

- [Orders](https://docs.sendit.mx/en/orders/orders): Model store orders with line items, sales channel, and one or more shipments per order.
- [Product catalog](https://docs.sendit.mx/en/orders/products): An optional product catalog that links automatically to your orders' line items.

### Wallet & billing

- [Wallet & funding](https://docs.sendit.mx/en/wallet-and-billing/wallet): Your prepaid MXN balance: fund via SPEI, card, or PayPal and review every transaction.
- [Plans & quotas](https://docs.sendit.mx/en/wallet-and-billing/subscriptions-and-quotas): SendIt's plans, the labels included per month, and how overage works.
- [CFDI and invoicing](https://docs.sendit.mx/en/wallet-and-billing/cfdi): Configure your organization's fiscal profile and read its invoice records.
- [Insurance & claims](https://docs.sendit.mx/en/wallet-and-billing/insurance-claims): Insure shipments by declared value and file claims with evidence when something goes wrong.

### Webhooks & events

- [Webhooks](https://docs.sendit.mx/en/webhooks-and-events/webhooks): Receive events on your server: endpoint registration, HMAC signature verification, and the retry policy.
- [Recipient notifications](https://docs.sendit.mx/en/webhooks-and-events/notifications): Automatic emails and WhatsApp messages to your buyer at every shipment milestone, with consent rules and per-event, per-channel control.