01 / Guía
Qué completarás en este recorrido
Al terminar tendrás un envío de prueba, una lista de opciones comparable, una guía en PDF o ZPL y un número de rastreo de prueba. Nada de este recorrido mueve saldo real.
Antes de empezar necesitas una cuenta de SendIt y una llave que comience con sk_test_. La misma llave identifica el modo de prueba en todas las solicitudes.
Origen y destino completos con código postal, colonia, ciudad y estado.
Peso y dimensiones finales del paquete.
Una llave de prueba guardada de forma segura en tu servidor.
Un lugar donde descargar y revisar la guía resultante.
02 / Guía
1. Crea el envío y recibe las cotizaciones
Envía los datos una sola vez a POST /v1/shipments. La respuesta crea el envío y devuelve rates[] dentro del mismo flujo; no necesitas abrir una cotización separada.
El ejemplo usa direcciones ilustrativas y un paquete expresado en kilogramos y centímetros. Sustitúyelos por datos de prueba que representen los pedidos reales de tu negocio.
POST /v1/shipments
X-API-Key: sk_test_...
Content-Type: application/json
{
"fromAddress": {
"contactName": "Almacén CDMX",
"contactPhone": "5512345678",
"street": "Insurgentes Sur",
"exteriorNumber": "1602",
"neighborhood": "Crédito Constructor",
"city": "Ciudad de México",
"state": "CDMX",
"postalCode": "03940",
"country": "MX"
},
"toAddress": {
"contactName": "María López",
"contactPhone": "3312345678",
"street": "Av. López Mateos",
"exteriorNumber": "45",
"neighborhood": "Jardines del Sol",
"city": "Guadalajara",
"state": "JAL",
"postalCode": "45050",
"country": "MX"
},
"parcel": {
"weight": 2.5,
"length": 30,
"width": 20,
"height": 15
}
}03 / Guía
2. Elige una opción sin recalcular el total
Cada elemento de rates[] incluye un id, el total en MXN y la entrega estimada. Presenta esas opciones como llegaron y conserva el id de la que elijas; ese rateId es lo que autoriza la compra.
La cotización dura 24 horas. Si ratesStatus indica que las opciones siguen pendientes, espera el resultado señalado por ratesPollUrl antes de mostrar una selección final.
Compara el total, no componentes internos del precio.
Conserva el rateId como un identificador opaco: no intentes construirlo.
No mezcles una opción de otro envío ni una cotización vencida.
Si ninguna opción cubre el envío, permite corregir los datos y volver a intentar.
04 / Guía
3. Compra la guía elegida
Envía el rateId al endpoint de la guía. PDF funciona para impresión convencional y ZPL para una impresora térmica compatible. Idempotency-Key es opcional; puedes incluirlo como práctica segura cuando una compra se reintente por un problema de red.
POST /v1/shipments/:id/label
X-API-Key: sk_test_...
Content-Type: application/json
{
"rateId": "DHL_standard_a1b2c3",
"labelFormat": "PDF"
}05 / Guía
4. Verifica el resultado completo
Una compra correcta devuelve la URL de la guía, un número de rastreo de prueba y los importes persistidos como cadenas decimales. Confirma que puedes guardar esos valores y asociarlos con el pedido original.
Después revisa el envío desde el dashboard y recorre sus cambios de estado en modo de prueba. Cuando ese circuito funciona, ya tienes una base para conectar tus pedidos reales sin cambiar el contrato de integración.
La guía abre y conserva el formato solicitado.
El número de rastreo pertenece al mismo envío.
El saldo afectado es el saldo virtual de prueba.
Tu pedido conserva el shipmentId y trackingNumber para consultas posteriores.
Siguiente paso
Completa la tarea.
Preguntas frecuentes
Respuestas rápidas.
¿La primera solicitud ya devuelve cotizaciones?
Sí. POST /v1/shipments crea el envío y devuelve rates[] dentro de la respuesta. Si todavía están pendientes, la respuesta indica dónde esperar el resultado.
¿Necesito una tarjeta para usar el modo de prueba?
No. El modo de prueba usa $10,000 MXN de saldo virtual y permanece separado del saldo real.
¿Puedo comprar la guía en una sola llamada?
Sí. POST /v1/shipments admite una compra opcional en la misma solicitud. Para una primera integración, el flujo de dos pasos suele ser más fácil de entender y revisar.
¿Qué formato de guía puedo solicitar?
PDF o ZPL. PDF es adecuado para impresión convencional; ZPL requiere una impresora térmica compatible y una configuración validada.