Operaciones de envíos

Última actualización: 2026-11-04 · Base URL: https://api.shalom-api.lat

Este grupo trabaja sobre guías que ya existen en la cuenta Shalom Pro. Todos los listados requieren una instancia con sesión activa (instanceId) y devuelven la paginación del panel en data.meta. Para anular un pendiente o consultar guías que aún no son públicas, usa la instancia dueña de la cuenta.

POST/account/pending-shipmentsShalom Pro

Lista de envíos pendientes

Obtiene el espejo (mirror) de la respuesta de Shalom para los envíos que están en estado PENDIENTE.

Parámetro	Descripción
instanceId*	ID de la instancia (en el body).

{
  "instanceId": "2e656a02-7e37-4573-9d68-e76740d337dc"
}

Respuesta (ejemplo)

{
  "0": {
    "id": 19763252,
    "shipping_date": "2026-11-09",
    "service_order_id_empresarial": 106620694,
    "service_order_serie_empresarial": "V207",
    "origin_station": { "ter_id": 7, "name": "AV PARRA 379", "abbreviation": "AQP" },
    "destination_station": { "ter_id": 582, "name": "CHALA", "abbreviation": "CLA" },
    "recipient_id": 23958
  }
}

Nota: Espejo de la vista de envíos pendientes de Shalom Pro. Es un objeto con claves numéricas ("0", "1"...), no una lista; sin pendientes devuelve {}. service_order_id_empresarial es el ose_id que acepta DELETE /account/pending-shipments.

DELETE/account/pending-shipmentsShalom Pro

Eliminar un envío pendiente

Anula un envío que todavía está pendiente en la cuenta Shalom Pro. Usa el mismo endpoint del panel (/delete-preguia o /delete-guia según el ose_id). Consume 1 operación.

Parámetro	Descripción
instanceId*	ID de la instancia (en el body).
guia	Número de guía (8 a 12 dígitos). Alternativa a ose_id.
ose_id	ose_id / service_order_id del envío pendiente. Alternativa a guia.

{
  "instanceId": "2e656a02-7e37-4573-9d68-e76740d337dc",
  "guia": "100007970"
}

Respuesta (ejemplo)

{
  "success": true,
  "message": "Envío pendiente eliminado",
  "guia": "100007970",
  "ose_id": 103479872
}

Nota: Envía guia u ose_id (uno de los dos). Si la guía no está en tus envíos pendientes responde 404; si Shalom rechaza la anulación, 409 con su mensaje. No se puede deshacer.

GET/account/tracking-listShalom Pro

Seguimiento de envíos (en tránsito)

Espejo de la vista "Seguimiento de envíos" de Shalom Pro: envíos en tránsito paginados con guía, código, fecha, origen y destino.

Parámetro	Descripción
instanceId*	ID de la instancia conectada (querystring).
page	Página (default 1).

curl -X GET "https://api.shalom-api.lat/account/tracking-list?instanceId={instanceId}&page={page}" \
  -H "x-api-key: TU_API_KEY"

Respuesta (ejemplo)

{
  "success": true,
  "message": "Lista de envíos en tránsito.",
  "data": {
    "items": [
      {
        "id": 91230250,
        "guideNumber": "12345678",
        "code": "ABCD",
        "shippingDate": "2026-10-01 10:00:00",
        "origin": { "id": 159, "name": "Agencia Origen" },
        "destination": { "id": 497, "name": "Agencia Destino" }
      }
    ],
    "meta": { "current_page": 1, "last_page": 3, "per_page": 20, "total": 48 }
  }
}

Nota: Requiere una instancia con sesión de Shalom Pro. 409 si la sesión venció; 502 si Shalom falla.

GET/account/historyShalom Pro

Historial de envíos entregados

Espejo de la vista "Historial de envíos" de Shalom Pro: envíos entregados paginados, con filtros por fecha, documento, guía y destino.

Parámetro	Descripción
instanceId*	ID de la instancia conectada (querystring).
page	Página (default 1).
from_date	Fecha inicial YYYY-MM-DD.
to_date	Fecha final YYYY-MM-DD.
document_type	DNI \| RUC \| CE.
document_number	Documento del remitente o destinatario.
order_number	Número de guía.
destination	ID o nombre de la agencia destino.

curl -X GET "https://api.shalom-api.lat/account/history?instanceId={instanceId}&page={page}&from_date={from_date}&to_date={to_date}&document_number={document_number}&order_number={order_number}" \
  -H "x-api-key: TU_API_KEY"

Respuesta (ejemplo)

{
  "success": true,
  "message": "Historial de envíos entregados.",
  "data": {
    "items": [
      {
        "id": 91234250,
        "serviceOrderIdEmpresarial": 91234250,
        "guideNumber": "12345678",
        "code": "ABCD",
        "shippingDate": "2026-10-01 10:00:00",
        "origin": { "id": 159, "name": "Agencia Origen" },
        "destination": { "id": 497, "name": "Agencia Destino" },
        "receiver": { "name": "JUAN PEREZ GOMEZ", "document": "12345678" },
        "packageDelivered": true,
        "price": "12.00",
        "product": { "id": 1096, "name": "PAQUETE XXS" }
      }
    ],
    "meta": { "current_page": 1, "last_page": 44, "per_page": 20, "total": 861 }
  }
}

Nota: Mismos filtros que el panel. Requiere instancia con sesión.

GET/account/vouchersShalom Pro

Lista de comprobantes disponibles

Lista los envíos entregados con su ose_id y un enlace listo para descargar el ticket oficial por /track/voucher. Acepta los filtros del historial.

Parámetro	Descripción
instanceId*	ID de la instancia conectada (querystring).
page	Página (default 1).
from_date	Fecha inicial YYYY-MM-DD.
to_date	Fecha final YYYY-MM-DD.
document_type	DNI \| RUC \| CE.
document_number	Documento del remitente o destinatario.
order_number	Número de guía.
destination	ID o nombre de la agencia destino.

curl -X GET "https://api.shalom-api.lat/account/vouchers?instanceId={instanceId}&page={page}&from_date={from_date}&to_date={to_date}&order_number={order_number}" \
  -H "x-api-key: TU_API_KEY"

Respuesta (ejemplo)

{
  "success": true,
  "message": "Historial de envíos entregados.",
  "data": {
    "items": [
      {
        "ose_id": 91234250,
        "guia": "12345678",
        "codigo": "ABCD",
        "serie": "V336",
        "fecha": "2026-10-01 10:00:00",
        "producto": "PAQUETE XXS",
        "monto": "12.00",
        "entregado": true,
        "origen": "Agencia Origen",
        "destino": "Agencia Destino",
        "destinatario": { "nombre": "JUAN PEREZ GOMEZ", "documento": "12345678" },
        "ticket_path": "/track/voucher?instanceId=UUID&ose_id=91234250",
        "ticket_url": "https://api.shalom-api.lat/track/voucher?instanceId=UUID&ose_id=91234250"
      }
    ],
    "meta": { "current_page": 1, "last_page": 44, "per_page": 20, "total": 861 }
  }
}

Nota: El ticket_url apunta al ticket oficial (PDF; agrega &format=image para JPEG). Requiere instancia con sesión.

Pendientes y anulación

POST /account/pending-shipments devuelve el espejo de los envíos que todavía no salieron. DELETE /account/pending-shipments anula uno por guia u ose_id usando el mismo endpoint del panel (/delete-preguia o /delete-guia según el ose_id).

La anulación no se puede deshacer: confirma la guía antes de llamarlo.

Seguimiento e historial

GET /account/tracking-list muestra los envíos en tránsito y GET /account/history los entregados. Ambos son paginados (page) y devuelven data.items + data.meta.

El historial acepta from_date, to_date, document_type, document_number, order_number y destination.

Comprobantes

GET /account/vouchers devuelve los entregados ya normalizados con ose_id, guía, código, producto, monto, destinatario y ticket_url listo para descargar el ticket oficial.

El ticket se descarga con GET /track/voucher (PDF o imagen agregando &format=image).

Errores de esta sección

404	La guía o el ose_id no existe en la cuenta (o no está en los envíos pendientes).
409	La instancia perdió la sesión de Shalom Pro: vuelve a iniciar sesión.
502	Shalom no respondió el listado. Reintenta en unos minutos.

Continúa con

Crear envíos en Shalom Pro Rastrear envíos Gestionar una guía ya creada

¿Aún no tienes API key?

Escríbenos por WhatsApp y la recibes de inmediato para probar todos estos ejemplos.

Solicitar API key