Queue - Notificar Entrega

Endpoint para crear objetos en la cola de procesamiento relacionados con notificaciones de entrega.

📥 Collection Postman

Descargar Collection - Queue Integration

URLs

Método	URL	Acción	Descripción
POST	/api/v1/integration/queue	Registrar	Crea un objeto en la cola de procesamiento para notificación de entrega
GET	/api/v1/integration/queue/{id}	Visualizar	Verifica el estado de procesamiento de un objeto en la cola

Producción:

{connect-producao}/api/v1/integration/queue

Homologación:

{connect-homologacao}/api/v1/integration/queue

Autenticación

Todas las solicitudes requieren un token de acceso obtenido en el endpoint de Security. El token debe ser enviado en el header AccessToken.

Crear Objeto en la Cola

Solicitud

Endpoint: POST {connect-producao}/api/v1/integration/queue

Headers:

AccessToken: {access_token}
Content-Type: application/json

Body:

{
  "action": "notify-delivery",
  "data": {
    "entrega_id": 57,
    "fk_tiny_pedidos": 135,
    "order_id": "3D3E-9E1A-45329",
    "tiny_id": 1021986006,
    "deliveryOperatorName": "Operador de Entrega",
    "deliveryOperatorDocument": "12345678900",
    "deliveryOperatorLocation": 54000000109,
    "status": "Entregado",
    "entrega_created_at": "2025-05-20T02:00:00Z",
    "entrega_updated_at": "2025-05-20T02:29:00Z"
  }
}

Campos del Body

Campo	Tipo	Obligatorio	Descripción
entrega_id	number	Sí	ID interno de la entrega
fk_tiny_pedidos	number	Sí	ID del pedido en el sistema externo
order_id	string	Sí	ID único del pedido
tiny_id	number	Sí	ID en el sistema Tiny
deliveryOperatorName	string	Sí	Nombre del operador de entrega
deliveryOperatorDocument	string	Sí	Documento del operador de entrega
deliveryOperatorLocation	number	Sí	Ubicación del operador
status	string	Sí	Estado de la entrega
entrega_created_at	string	Sí	Fecha de creación de la entrega
entrega_updated_at	string	Sí	Fecha de actualización de la entrega

Respuesta de Éxito

Estado: 201 Created

{
  "id": "uuid-del-objeto",
  "created": "2025-01-01T00:00:00Z",
  "iCode": 0,
  "iMsg": "Objeto creado con éxito",
  "processDate": null,
  "processStatus": "pending",
  "processMsg": null
}

Verificar Procesamiento

Solicitud

Endpoint: GET {connect-producao}/api/v1/integration/queue/{id}

Headers:

AccessToken: {access_token}

Respuesta de Éxito

Estado: 200 OK

{
  "id": "uuid-del-objeto",
  "created": "2025-01-01T00:00:00Z",
  "iCode": 0,
  "iMsg": "Procesado con éxito",
  "processDate": "2025-01-01T00:05:00Z",
  "processStatus": "completed",
  "processMsg": "Notificación de entrega procesada",
  "data": {
    "entrega_id": 57,
    "fk_tiny_pedidos": 135,
    "order_id": "3D3E-9E1A-45329",
    "tiny_id": 1021986006,
    "deliveryOperatorName": "Operador de Entrega",
    "deliveryOperatorDocument": "12345678900",
    "deliveryOperatorLocation": 54000000109,
    "status": "Entregado",
    "entrega_created_at": "2025-05-20T02:00:00Z",
    "entrega_updated_at": "2025-05-20T02:29:00Z"
  }
}

Ejemplo de Implementación

async function notificarEntrega(datosEntrega, accessToken) {
  const response = await fetch('{connect-producao}/api/v1/integration/queue', {
    method: 'POST',
    headers: {
      'AccessToken': accessToken,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      action: 'notify-delivery',
      data: datosEntrega
    })
  });

  if (!response.ok) {
    throw new Error(`Error ${response.status}: ${response.statusText}`);
  }

  return await response.json();
}