Queue - Notify Delivery

Endpoint para criar objetos na fila de processamento relacionados a notificações de entrega.

📥 Collection Postman

Baixar Collection - Queue Integration

URLs

Método	URL	Ação	Descrição
POST	/api/v1/integration/queue	Cadastrar	Cria um objeto na fila de processamento para notificação de entrega
GET	/api/v1/integration/queue/{id}	Visualizar	Verifica o status de processamento de um objeto na fila

Produção:

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

Homologação:

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

Autenticação

Todas as requisições requerem um token de acesso obtido no endpoint de Security. O token deve ser enviado no header AccessToken.

Criar Objeto na Fila

Requisição

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": "Entregue",
    "entrega_created_at": "2025-05-20T02:00:00Z",
    "entrega_updated_at": "2025-05-20T02:29:00Z"
  }
}

Campos do Body

Campo	Tipo	Obrigatório	Descrição
entrega_id	number	Sim	ID interno da entrega
fk_tiny_pedidos	number	Sim	ID do pedido no sistema externo
order_id	string	Sim	ID único do pedido
tiny_id	number	Sim	ID no sistema Tiny
deliveryOperatorName	string	Sim	Nome do operador de entrega
deliveryOperatorDocument	string	Sim	Documento do operador de entrega
deliveryOperatorLocation	number	Sim	Localização do operador
status	string	Sim	Status da entrega
entrega_created_at	string	Sim	Data de criação da entrega
entrega_updated_at	string	Sim	Data de atualização da entrega

Resposta de Sucesso

Status: 201 Created

{
  "id": "uuid-do-objeto",
  "created": "2025-01-01T00:00:00Z",
  "iCode": 0,
  "iMsg": "Objeto criado com sucesso",
  "processDate": null,
  "processStatus": "pending",
  "processMsg": null
}

Verificar Processamento

Requisição

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

Headers:

AccessToken: {access_token}

Resposta de Sucesso

Status: 200 OK

{
  "id": "uuid-do-objeto",
  "created": "2025-01-01T00:00:00Z",
  "iCode": 0,
  "iMsg": "Processado com sucesso",
  "processDate": "2025-01-01T00:05:00Z",
  "processStatus": "completed",
  "processMsg": "Notificação de entrega processada",
  "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": "Entregue",
    "entrega_created_at": "2025-05-20T02:00:00Z",
    "entrega_updated_at": "2025-05-20T02:29:00Z"
  }
}

Exemplo de Implementação

async function notificarEntrega(dadosEntrega, 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: dadosEntrega
    })
  });

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

  return await response.json();
}