VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/WhatsApp: configuração

Segmento e perfil de comércio

Escolhe o segmento da loja (farmácia, moda, autopeças...) que ajusta o atendimento e o checkout do WhatsApp.

Cada loja escolhe um segmento principal. O segmento liga regras próprias do ramo (receita médica, idade mínima, compatibilidade com veículo, cotação antes da compra, CNPJ, cadeia fria) e muda os textos padrão da conversa. Sem escolha, a loja usa general, o comportamento comum.

Catálogo de segmentos

GET/api/v1/vendor/whatsapp-confluence/segmentsSeller

Lista os segmentos disponíveis

Cabeçalhos

Authorizationstringobrigatório
Bearer $TOKEN. Token de acesso de um usuário seller (lojista). Veja Tokens.

Exemplo de requisição

bash
curl "$BASE_URL/api/v1/vendor/whatsapp-confluence/segments" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Segmentos
json
{
  "segments": [
    {
      "id": "general",
      "name_key": "general",
      "description_key": "generalDesc",
      "capabilities": [
        "catalog",
        "cart",
        "checkout",
        "campaigns"
      ]
    },
    {
      "id": "pharmacy",
      "name_key": "pharmacy",
      "description_key": "pharmacyDesc",
      "capabilities": [
        "catalog",
        "cart",
        "checkout",
        "prescription",
        "controlled",
        "cold_chain",
        "age_gate",
        "campaigns"
      ],
      "default_rule_hints": [
        "requires_prescription",
        "controlled_schedule",
        "cold_chain"
      ]
    }
  ]
}

Campos da resposta

segmentsarray

Lista fechada, com os 12 segmentos. O exemplo mostra 2.

idstring
Id do segmento, o valor que PUT /commerce-profile aceita.
name_keystring
Chave de tradução do nome. Não é um texto pronto.
description_keystring
Chave de tradução da descrição.
capabilitiesarray
Recursos que o segmento habilita.
default_rule_hintsarray
Sugestões de regra para marcar produtos do ramo. Omitido quando não há.

Erros

StatusQuandoCorpo de exemplo
401Sem token ou token inválido.{"error":"missing authorization header"}
403O usuário não é um seller, ou o seller ainda está em análise de cadastro.{"error":"vendor_pending_review"}
Os 12 segmentos
idcapabilities
generalcatalog, cart, checkout, campaigns
foodcatalog, cart, checkout, modifiers, age_gate, eta, campaigns
grocerycatalog, cart, checkout, bulk_qty, age_gate, cold_chain, campaigns
pharmacycatalog, cart, checkout, prescription, controlled, cold_chain, age_gate, campaigns
auto_partscatalog, cart, checkout, vehicle_fitment, quote, sku_search, campaigns
fashioncatalog, cart, checkout, variants, size_guide, campaigns
beautycatalog, cart, checkout, variants, age_gate, campaigns
electronicscatalog, cart, checkout, warranty, serial, campaigns
petcatalog, cart, checkout, pet_profile, prescription, campaigns
constructioncatalog, cart, checkout, quote, bulk_qty, measure, campaigns
b2bcatalog, cart, checkout, cnpj, quote, price_tiers, campaigns
healthcatalog, cart, checkout, appointment, campaigns

Ler o perfil

Quando a loja nunca gravou um perfil, a resposta traz segment: general, config e labels vazios.

GET/api/v1/vendor/whatsapp-confluence/commerce-profileSeller

Retorna o segmento e os textos da loja

Cabeçalhos

Authorizationstringobrigatório
Bearer $TOKEN. Token de acesso de um usuário seller (lojista). Veja Tokens.

Exemplo de requisição

bash
curl "$BASE_URL/api/v1/vendor/whatsapp-confluence/commerce-profile" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Perfil
json
{
  "segment": "pharmacy",
  "config": {},
  "labels": {
    "cart.noun": "Carrinho"
  },
  "updated_at": "2026-09-11T01:40:05.834426Z",
  "capabilities": [
    "catalog",
    "cart",
    "checkout",
    "prescription",
    "controlled",
    "cold_chain",
    "age_gate",
    "campaigns"
  ]
}

Campos da resposta

segmentstring
generalfoodgrocerypharmacyauto_partsfashionbeautyelectronicspetconstructionb2bhealth
Id do segmento ativo.
configobject
Objeto livre com configurações do segmento. A plataforma o guarda como veio.
labelsobject
Textos que a loja troca no lugar dos padrões do segmento, por chave. Exemplo: "cart.noun": "Sacola" muda a palavra "Carrinho" nas mensagens.
updated_atstring
Última gravação (RFC 3339). Omitido se nunca gravado.
capabilitiesarray
Recursos do segmento, calculados a partir de segment. Somente leitura.

Erros

StatusQuandoCorpo de exemplo
401Sem token ou token inválido.{"error":"missing authorization header"}
403O usuário não é um seller, ou o seller ainda está em análise de cadastro.{"error":"vendor_pending_review"}
500Falha ao ler o perfil.{"error":"..."}

Gravar o perfil

A gravação substitui segment, config e labels de uma vez. Para mudar um texto sem perder os outros, leia o perfil, altere e devolva o objeto inteiro. A resposta é o perfil já salvo.

PUT/api/v1/vendor/whatsapp-confluence/commerce-profileSeller

Define o segmento, a configuração e os textos

Cabeçalhos

Authorizationstringobrigatório
Bearer $TOKEN. Token de acesso de um usuário seller (lojista). Veja Tokens.
Content-Typestringobrigatório
application/json.

Corpo da requisição

segmentstringpadrão: general
Id de um segmento da lista. Vazio vale general.
configobject
Configuração livre do segmento. Omitido vira {}.
labelsobject
Textos trocados, por chave. Omitido vira {} e apaga os textos anteriores.

Exemplo de requisição

bash
curl -X PUT "$BASE_URL/api/v1/vendor/whatsapp-confluence/commerce-profile" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "segment": "pharmacy",
  "config": {},
  "labels": {
    "cart.noun": "Carrinho"
  }
}'

Resposta

200Perfil salvo
json
{
  "segment": "pharmacy",
  "config": {},
  "labels": {
    "cart.noun": "Carrinho"
  },
  "updated_at": "2026-09-11T01:40:05.834426Z",
  "capabilities": [
    "catalog",
    "cart",
    "checkout",
    "prescription",
    "controlled",
    "cold_chain",
    "age_gate",
    "campaigns"
  ]
}

Campos da resposta

segmentstring
generalfoodgrocerypharmacyauto_partsfashionbeautyelectronicspetconstructionb2bhealth
Id do segmento ativo.
configobject
Objeto livre com configurações do segmento. A plataforma o guarda como veio.
labelsobject
Textos que a loja troca no lugar dos padrões do segmento, por chave. Exemplo: "cart.noun": "Sacola" muda a palavra "Carrinho" nas mensagens.
updated_atstring
Última gravação (RFC 3339). Omitido se nunca gravado.
capabilitiesarray
Recursos do segmento, calculados a partir de segment. Somente leitura.

Erros

StatusQuandoCorpo de exemplo
401Sem token ou token inválido.{"error":"missing authorization header"}
403Falta o privilégio vendor_settings ou vendor_manage_whatsapp, ou o WhatsApp da loja não é deste seller.{"error":"store_whatsapp_owner_required"}
400Segmento fora da lista.{"error":"unknown segment \"hotel\""}
400Corpo que não é JSON.{"error":"invalid json"}
Mudar de segmento não migra os produtos

O segmento troca regras e textos, mas as marcações que você já pôs em produtos (por exemplo exigir receita) continuam como estavam. Revise o catálogo depois de mudar.

Veja também

  • Visão geral da seção
  • Boas-vindas
  • Ajustes do canal
Anterior
Ajustes do canal
Próxima
Mensagem de boas-vindas
Nesta página
  • Catálogo de segmentos
  • Exemplo de requisição
  • Resposta
  • Erros
  • Ler o perfil
  • Exemplo de requisição
  • Resposta
  • Erros
  • Gravar o perfil
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também