API

Atividades

Registrar e acompanhar atividades, tarefas e prazos via API.

Atividades

Gerencie atividades, tarefas, prazos e eventos da sua loja ou shopping automotivo. Atividades podem estar vinculadas a veículos, clientes ou negócios.

GET /v1/activities

Lista todas as atividades do time.

Query Parameters

ParâmetroTipoPadrãoDescrição
pagenumber1Página atual
limitnumber20Itens por página (máx: 100)
typestring-Filtrar por tipo: task, deadline, meeting, call, email, note
statusstring-Filtrar por status: pending, in_progress, completed, cancelled
prioritystring-Filtrar por prioridade: alta, media, baixa
vehicle_idstring-Filtrar por veículo
client_idstring-Filtrar por cliente
deal_idstring-Filtrar por negócio
assigned_tostring-Filtrar por responsável
fromstring-Data inicial (YYYY-MM-DD)
tostring-Data final (YYYY-MM-DD)
overdueboolean-Apenas atividades atrasadas
sortstringdue_dateOrdenação

Request

curl -X GET "https://api.shopcar.com.br/v1/activities?status=pending&priority=alta" \
  -H "Authorization: Bearer ea_live_sua_chave_aqui"

Response

{
  "success": true,
  "data": [
    {
      "id": "act_abc123def456",
      "type": "task",
      "title": "Realizar inspeção veicular",
      "description": "Inspeção completa incluindo laudo cautelar e revisão mecânica",
      "status": "pending",
      "priority": "alta",
      "due_date": "2026-02-10",
      "vehicle": {
        "id": "veh_xyz789",
        "title": "Honda Civic EXL 2.0 2024",
        "plate": "ABC1D23"
      },
      "assigned_to": {
        "id": "user_123",
        "name": "Carlos Mendes"
      },
      "created_at": "2026-02-01T10:00:00Z"
    },
    {
      "id": "act_xyz789ghi012",
      "type": "deadline",
      "title": "Prazo para transferência de documentação",
      "description": "Prazo final para transferência do documento do veículo",
      "status": "pending",
      "priority": "alta",
      "due_date": "2026-02-15",
      "vehicle": {
        "id": "veh_abc456",
        "title": "Toyota Corolla XEi 2.0 2025",
        "plate": "DEF2G34"
      },
      "assigned_to": {
        "id": "user_456",
        "name": "Ana Silva"
      },
      "created_at": "2026-02-05T09:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 45,
    "pages": 3
  }
}

POST /v1/activities

Cria uma nova atividade.

Request Body

CampoTipoObrigatórioDescrição
typestringSimTipo da atividade
titlestringSimTítulo
descriptionstringNãoDescrição detalhada
prioritystringNãoPrioridade: alta, media, baixa (padrão: media)
due_datestringNãoData limite (YYYY-MM-DD)
due_timestringNãoHora limite (HH:mm)
vehicle_idstringNãoID do veículo vinculado
client_idstringNãoID do cliente vinculado
deal_idstringNãoID do negócio vinculado
assigned_tostringNãoID do usuário responsável
reminderobjectNãoConfiguração de lembrete
recurrenceobjectNãoConfiguração de recorrência
metadataobjectNãoDados customizados

Tipos de Atividade

TipoDescrição
taskTarefa a ser executada
deadlinePrazo de documentação ou entrega
meetingReunião ou visita ao showroom
callLigação telefônica
emailEmail a enviar/responder
noteAnotação/observação

Request

curl -X POST https://api.shopcar.com.br/v1/activities \
  -H "Authorization: Bearer ea_live_sua_chave_aqui" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "task",
    "title": "Realizar inspeção veicular",
    "description": "Inspeção completa incluindo laudo cautelar e revisão mecânica",
    "priority": "alta",
    "due_date": "2026-02-10",
    "vehicle_id": "veh_xyz789ghi012",
    "assigned_to": "user_123",
    "reminder": {
      "enabled": true,
      "before_minutes": 1440
    }
  }'

Objeto Reminder

{
  "enabled": true,
  "before_minutes": 1440,
  "channels": ["email", "push"]
}
CampoTipoDescrição
enabledbooleanAtivar lembrete
before_minutesnumberMinutos antes do prazo (1440 = 1 dia)
channelsarrayCanais: email, push, sms

Response

{
  "success": true,
  "data": {
    "id": "act_new123abc456",
    "type": "task",
    "title": "Realizar inspeção veicular",
    "description": "Inspeção completa incluindo laudo cautelar e revisão mecânica",
    "status": "pending",
    "priority": "alta",
    "due_date": "2026-02-10",
    "vehicle_id": "veh_xyz789ghi012",
    "assigned_to": "user_123",
    "reminder": {
      "enabled": true,
      "before_minutes": 1440,
      "channels": ["email", "push"]
    },
    "created_at": "2026-02-04T10:30:00Z",
    "updated_at": "2026-02-04T10:30:00Z"
  }
}

GET /v1/activities/:id

Busca uma atividade específica.

Request

curl -X GET https://api.shopcar.com.br/v1/activities/act_abc123def456 \
  -H "Authorization: Bearer ea_live_sua_chave_aqui"

Response

{
  "success": true,
  "data": {
    "id": "act_abc123def456",
    "type": "task",
    "title": "Realizar inspeção veicular",
    "description": "Inspeção completa incluindo laudo cautelar e revisão mecânica",
    "status": "pending",
    "priority": "alta",
    "due_date": "2026-02-10",
    "due_time": null,
    "vehicle": {
      "id": "veh_xyz789",
      "title": "Honda Civic EXL 2.0 2024",
      "plate": "ABC1D23"
    },
    "client": {
      "id": "cli_abc123",
      "name": "João da Silva"
    },
    "assigned_to": {
      "id": "user_123",
      "name": "Carlos Mendes",
      "email": "carlos@loja.com"
    },
    "created_by": {
      "id": "user_456",
      "name": "Ana Silva"
    },
    "reminder": {
      "enabled": true,
      "before_minutes": 1440,
      "channels": ["email", "push"]
    },
    "metadata": {},
    "created_at": "2026-02-01T10:00:00Z",
    "updated_at": "2026-02-04T14:00:00Z"
  }
}

PUT /v1/activities/:id

Atualiza uma atividade.

Request

curl -X PUT https://api.shopcar.com.br/v1/activities/act_abc123def456 \
  -H "Authorization: Bearer ea_live_sua_chave_aqui" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "in_progress",
    "due_date": "2026-02-12"
  }'

Response

{
  "success": true,
  "data": {
    "id": "act_abc123def456",
    "status": "in_progress",
    "due_date": "2026-02-12",
    "updated_at": "2026-02-04T15:00:00Z"
  }
}

PUT /v1/activities/:id/complete

Marca uma atividade como concluída.

Request

curl -X PUT https://api.shopcar.com.br/v1/activities/act_abc123def456/complete \
  -H "Authorization: Bearer ea_live_sua_chave_aqui" \
  -H "Content-Type: application/json" \
  -d '{
    "notes": "Inspeção realizada e laudo aprovado"
  }'

Response

{
  "success": true,
  "data": {
    "id": "act_abc123def456",
    "status": "completed",
    "completed_at": "2026-02-04T16:00:00Z",
    "completed_by": {
      "id": "user_123",
      "name": "Carlos Mendes"
    },
    "completion_notes": "Inspeção realizada e laudo aprovado"
  }
}

DELETE /v1/activities/:id

Exclui uma atividade.

Atividades concluídas não podem ser excluídas, apenas canceladas.

Request

curl -X DELETE https://api.shopcar.com.br/v1/activities/act_abc123def456 \
  -H "Authorization: Bearer ea_live_sua_chave_aqui"

Response

{
  "success": true,
  "data": {
    "id": "act_abc123def456",
    "deleted": true
  }
}

GET /v1/activities/overdue

Lista atividades atrasadas.

Request

curl -X GET https://api.shopcar.com.br/v1/activities/overdue \
  -H "Authorization: Bearer ea_live_sua_chave_aqui"

Response

{
  "success": true,
  "data": [
    {
      "id": "act_overdue123",
      "type": "deadline",
      "title": "Prazo para transferência de documentação",
      "status": "pending",
      "priority": "alta",
      "due_date": "2026-02-01",
      "days_overdue": 3,
      "vehicle": {
        "id": "veh_abc",
        "title": "Fiat Argo Drive 1.0 2023"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 5,
    "pages": 1
  }
}

Status das Atividades

StatusDescrição
pendingPendente - não iniciada
in_progressEm andamento
completedConcluída
cancelledCancelada

Erros Comuns

CódigoErroSolução
400Invalid typeUse um tipo válido
400Invalid statusUse: pending, in_progress, completed, cancelled
400Invalid priorityUse: alta, media ou baixa
404Activity not foundVerifique o ID
404Vehicle not foundVerifique o vehicle_id
422Cannot delete completed activityUse cancelamento

On this page