Recolecciones

Programa recolecciones a domicilio con cualquier paquetería, consulta su estado y cancélalas cuando lo necesites.

Una recolección le pide a la paquetería pasar por tus paquetes a una dirección, en una fecha y ventana horaria. Programa, consulta y cancela recolecciones con cualquier paquetería desde el mismo API.

El ciclo de vida

PENDING → CONFIRMED → IN_PROGRESS → COMPLETED
                 ↘ CANCELLED
                 ↘ FAILED

Endpoints

Programa una recolección

Parámetros del cuerpo

curl -X POST https://api.sendit.mx/v1/pickups \
  -H "X-API-Key: sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "carrierCode": "DHL",
    "pickupAddressId": "clx_direccion_origen",
    "pickupDate": "2026-07-20",
    "readyTime": "09:00",
    "closingTime": "18:00",
    "packageCount": 5,
    "totalWeight": 12.5,
    "contactName": "Juan Pérez",
    "contactPhone": "+525512345678",
    "specialInstructions": "Tocar el timbre dos veces, preguntar por Juan.",
    "shipmentIds": ["clxship001", "clxship002"]
  }'

{
  "success": true,
  "data": {
    "id": "clxpickup_xyz",
    "carrierCode": "DHL",
    "pickupDate": "2026-07-20",
    "readyTime": "09:00",
    "closingTime": "18:00",
    "packageCount": 5,
    "totalWeight": "12.5",
    "status": "CONFIRMED",
    "confirmationNumber": "DHL-A1B2C3D4",
    "confirmedAt": "2026-07-17T10:30:00.000Z"
  }
}

Guarda el confirmationNumber. Es la referencia que la paquetería reconoce si necesitas aclarar algo por teléfono.

Consulta qué paqueterías recolectan

GET /v1/pickups/carriers

{
  "success": true,
  "data": [
    { "carrierCode": "DHL", "carrierName": "DHL Express", "supportsPickups": true },
    { "carrierCode": "ESTAFETA", "carrierName": "Estafeta", "supportsPickups": true },
    { "carrierCode": "FEDEX", "carrierName": "FedEx", "supportsPickups": true }
  ]
}

Lista y filtra

GET /v1/pickups?carrierCode=DHL&status=CONFIRMED&dateFrom=2026-07-01&dateTo=2026-07-31

La paginación sigue el modelo de página descrito en Paginación y filtros.

Cancela una recolección

curl -X PATCH https://api.sendit.mx/v1/pickups/clxpickup_xyz/cancel \
  -H "X-API-Key: sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "reason": "Los paquetes no estarán listos a tiempo" }'

Las recolecciones CANCELLED o COMPLETED ya no se pueden cancelar (400).

Refresca el estado

POST /v1/pickups/:id/refresh-status

Consulta directamente a la paquetería y actualiza el registro local. Úsalo cuando necesites un estado más fresco que el último sincronizado.

Errores