vamobotDocs

Lojas

Consulte a loja da sua organização, o número de WhatsApp dela e se ela está conectada.

A loja é o número de WhatsApp da sua organização. Cada organização tem uma loja: é dela o storeId que você usa ao criar contatos, importar em massa e registrar pedidos. A conexão do WhatsApp é feita no Vamo (veja Conectar o WhatsApp); a API só lê.

GET /stores

Lista as lojas da organização (na prática, uma). Acesso: chave secreta ou publicável (leitura).

curl https://vamo.ai/api/v1/stores \
  -H "Authorization: Bearer pk_live_SUA_CHAVE_PUBLICAVEL"

Resposta 200

{
  "data": [
    {
      "id": "7b1e2c3d-4a5f-4b6c-8d7e-9f0a1b2c3d4e",
      "name": "Loja Aurora",
      "phoneNumber": "+55 11 3456-7890",
      "status": "active",
      "connectedAt": "2026-09-10T15:20:00.000Z",
      "createdAt": "2026-09-10T15:02:00.000Z"
    }
  ]
}

Com uma chave publicável, esta é a forma segura de mostrar no seu site o número de WhatsApp da loja (num botão "Fale conosco", por exemplo).

GET /stores/:id

A loja pelo ID, com os mesmos campos. Acesso: chave secreta ou publicável (leitura). 404 (Store not found) se ela não for da sua organização.

curl https://vamo.ai/api/v1/stores/7b1e2c3d-4a5f-4b6c-8d7e-9f0a1b2c3d4e \
  -H "Authorization: Bearer sk_live_SUA_CHAVE"

Status

statusSignifica
activeWhatsApp conectado: a loja envia e recebe
pendingA conexão começou e ainda não terminou
disconnectedO número foi desconectado (pela loja ou pela Meta)
inactiveA loja não está em uso

Só uma loja active envia mensagens. Trate qualquer outro status como "fora do ar" e mostre ao usuário que o WhatsApp precisa ser conectado. Para saber na hora em que isso muda, assine os webhooks store.connected e store.disconnected.

phoneNumber vem no formato que a Meta mostra o número e fica vazio (null) enquanto a loja não tem um número conectado.

Nesta página