API atual/Referência completa/WhatsApp: catálogo na Meta

Ligar e desligar a sincronização

Consulta, liga e desliga o envio do catálogo de um seller para o catálogo da Meta.

O catálogo da Meta (Commerce Manager) é a vitrine que o próprio WhatsApp mostra ao cliente dentro da conversa. Ligando a sincronização, a plataforma copia os produtos ativos de um seller para esse catálogo e mantém as alterações em dia (a cada hora, automaticamente). A cópia é de mão única: a loja é a fonte, a Meta recebe. A configuração é por seller e usa o token do número de WhatsApp desse seller.

Consultar o estado

Devolve o estado do seller ou {"state": null} se nunca foi ligada.

GET/api/v1/admin/whatsapp/catalog-syncAdmin

Mostra se a sincronização do catálogo está ligada para o seller

Parâmetros de consulta

vendor_idstring

UUID do seller. Obrigatório, a menos que o usuário esteja vinculado a um seller.

Exemplo de requisição (Consultar o estado)

bash

curl "$BASE_URL/api/v1/admin/whatsapp/catalog-sync?vendor_id=94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36" \
  -H "Authorization: Bearer $TOKEN"

Resposta (Consultar o estado)

200Estado

json

{
  "state": {
    "id": "2c1d7f4e-9a60-4c0b-8b1a-5e6f7a8b9c0d",
    "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
    "meta_catalog_id": "1234567890123456",
    "enabled": true,
    "last_full_sync_at": "2026-10-11T20:00:00Z",
    "last_full_sync_count": 120,
    "last_incremental_sync_at": "2026-10-11T21:00:00Z",
    "sync_frequency_seconds": 3600,
    "created_at": "2026-10-01T12:00:00Z",
    "updated_at": "2026-10-11T21:00:00Z"
  }
}

Campos da resposta

stateobject

Estado da sincronização do seller, ou null se nunca foi ligada.

idstring

UUID do registro.

vendor_idstring

UUID do seller.

meta_catalog_idstring

Id do catálogo na Meta.

enabledboolean

Sincronização ligada.

last_full_sync_atstring

Última sincronização completa.

last_full_sync_countinteger

Produtos enviados nela.

last_full_sync_errorstring

Erro da última sincronização completa, se houve.

last_incremental_sync_atstring

Última sincronização incremental (automática, de hora em hora).

sync_frequency_secondsinteger

Intervalo da sincronização automática, em segundos.

created_atstring

Criação.

updated_atstring

Última alteração.

Erros (Consultar o estado)

Status	Quando	Corpo
400	Sem `vendor_id` (a rota exige o seller; usuários vinculados a um seller usam o próprio).	`{"error":"vendor_id required"}`
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O módulo WhatsApp Commerce está desligado na loja, o usuário não é administrador ou não tem o privilégio exigido.	`{"error":"module_disabled","module":"whatsapp-commerce"}` ou `{"error":"insufficient privileges","required":"manage_settings"}` ou `{"error":"admin access required"}`

Ligar

Confere na Meta se o id do catálogo existe e é acessível com o token do seller e, se sim, liga a sincronização. Chamar de novo troca o catálogo e revalida. Não envia produtos: use a rota de sincronização completa em seguida.

POST/api/v1/admin/whatsapp/catalog-sync/enableAdmin

Liga a sincronização e informa o catálogo da Meta

Corpo da requisição

vendor_idstringobrigatório

UUID do seller. Obrigatório, a menos que o usuário esteja vinculado a um seller.

meta_catalog_idstringobrigatório

Id do catálogo no Commerce Manager da Meta.

Exemplo de requisição (Ligar)

bash

curl -X POST "$BASE_URL/api/v1/admin/whatsapp/catalog-sync/enable" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
    "meta_catalog_id": "1234567890123456"
  }'

Resposta (Ligar)

200Ligada

json

{
  "state": {
    "id": "2c1d7f4e-9a60-4c0b-8b1a-5e6f7a8b9c0d",
    "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
    "meta_catalog_id": "1234567890123456",
    "enabled": true,
    "last_full_sync_at": "2026-10-11T20:00:00Z",
    "last_full_sync_count": 120,
    "last_incremental_sync_at": "2026-10-11T21:00:00Z",
    "sync_frequency_seconds": 3600,
    "created_at": "2026-10-01T12:00:00Z",
    "updated_at": "2026-10-11T21:00:00Z"
  }
}

Campos da resposta

stateobject

Estado da sincronização do seller, ou null se nunca foi ligada.

idstring

UUID do registro.

vendor_idstring

UUID do seller.

meta_catalog_idstring

Id do catálogo na Meta.

enabledboolean

Sincronização ligada.

last_full_sync_atstring

Última sincronização completa.

last_full_sync_countinteger

Produtos enviados nela.

last_full_sync_errorstring

Erro da última sincronização completa, se houve.

last_incremental_sync_atstring

Última sincronização incremental (automática, de hora em hora).

sync_frequency_secondsinteger

Intervalo da sincronização automática, em segundos.

created_atstring

Criação.

updated_atstring

Última alteração.

Erros (Ligar)

Status	Quando	Corpo
400	`vendor_id` ou `meta_catalog_id` ausente; o seller não tem número de WhatsApp com token; ou a Meta recusou o catálogo (a mensagem vem em `error`).	`{"error":"whatsapp catalog: vendor has no WhatsApp credentials configured"}`
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O módulo WhatsApp Commerce está desligado na loja, o usuário não é administrador ou não tem o privilégio exigido.	`{"error":"module_disabled","module":"whatsapp-commerce"}` ou `{"error":"insufficient privileges","required":"manage_settings"}` ou `{"error":"admin access required"}`

Desligar

Para as sincronizações futuras. Os produtos que já estão na Meta não são apagados e o histórico é mantido: religar continua de onde parou.

POST/api/v1/admin/whatsapp/catalog-sync/disableAdmin

Desliga a sincronização do catálogo do seller

Corpo da requisição

vendor_idstringobrigatório

UUID do seller.

Exemplo de requisição (Desligar)

bash

curl -X POST "$BASE_URL/api/v1/admin/whatsapp/catalog-sync/disable" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36"
  }'

Resposta (Desligar)

200Desligada

json

{
  "ok": true
}

Campos da resposta

okboolean

true.

Erros (Desligar)

Status	Quando	Corpo
400	Sem `vendor_id` (a rota exige o seller; usuários vinculados a um seller usam o próprio).	`{"error":"vendor_id required"}`
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O módulo WhatsApp Commerce está desligado na loja, o usuário não é administrador ou não tem o privilégio exigido.	`{"error":"module_disabled","module":"whatsapp-commerce"}` ou `{"error":"insufficient privileges","required":"manage_settings"}` ou `{"error":"admin access required"}`

Veja também

API atual/Referência completa/WhatsApp: catálogo na Meta

Ligar e desligar a sincronização

Consulta, liga e desliga o envio do catálogo de um seller para o catálogo da Meta.

Consultar o estado

Devolve o estado do seller ou {"state": null} se nunca foi ligada.

GET/api/v1/admin/whatsapp/catalog-syncAdmin

Mostra se a sincronização do catálogo está ligada para o seller

Parâmetros de consulta

vendor_idstring

UUID do seller. Obrigatório, a menos que o usuário esteja vinculado a um seller.

Exemplo de requisição (Consultar o estado)

bash

curl "$BASE_URL/api/v1/admin/whatsapp/catalog-sync?vendor_id=94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36" \
  -H "Authorization: Bearer $TOKEN"

Resposta (Consultar o estado)

200Estado

json

{
  "state": {
    "id": "2c1d7f4e-9a60-4c0b-8b1a-5e6f7a8b9c0d",
    "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
    "meta_catalog_id": "1234567890123456",
    "enabled": true,
    "last_full_sync_at": "2026-10-11T20:00:00Z",
    "last_full_sync_count": 120,
    "last_incremental_sync_at": "2026-10-11T21:00:00Z",
    "sync_frequency_seconds": 3600,
    "created_at": "2026-10-01T12:00:00Z",
    "updated_at": "2026-10-11T21:00:00Z"
  }
}

Campos da resposta

stateobject

Estado da sincronização do seller, ou null se nunca foi ligada.

idstring

UUID do registro.

vendor_idstring

UUID do seller.

meta_catalog_idstring

Id do catálogo na Meta.

enabledboolean

Sincronização ligada.

last_full_sync_atstring

Última sincronização completa.

last_full_sync_countinteger

Produtos enviados nela.

last_full_sync_errorstring

Erro da última sincronização completa, se houve.

last_incremental_sync_atstring

Última sincronização incremental (automática, de hora em hora).

sync_frequency_secondsinteger

Intervalo da sincronização automática, em segundos.

created_atstring

Criação.

updated_atstring

Última alteração.

Erros (Consultar o estado)

Status	Quando	Corpo
400	Sem `vendor_id` (a rota exige o seller; usuários vinculados a um seller usam o próprio).	`{"error":"vendor_id required"}`
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O módulo WhatsApp Commerce está desligado na loja, o usuário não é administrador ou não tem o privilégio exigido.	`{"error":"module_disabled","module":"whatsapp-commerce"}` ou `{"error":"insufficient privileges","required":"manage_settings"}` ou `{"error":"admin access required"}`

Ligar

POST/api/v1/admin/whatsapp/catalog-sync/enableAdmin

Liga a sincronização e informa o catálogo da Meta

Corpo da requisição

vendor_idstringobrigatório

UUID do seller. Obrigatório, a menos que o usuário esteja vinculado a um seller.

meta_catalog_idstringobrigatório

Id do catálogo no Commerce Manager da Meta.

Exemplo de requisição (Ligar)

bash

curl -X POST "$BASE_URL/api/v1/admin/whatsapp/catalog-sync/enable" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
    "meta_catalog_id": "1234567890123456"
  }'

Resposta (Ligar)

200Ligada

json

{
  "state": {
    "id": "2c1d7f4e-9a60-4c0b-8b1a-5e6f7a8b9c0d",
    "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
    "meta_catalog_id": "1234567890123456",
    "enabled": true,
    "last_full_sync_at": "2026-10-11T20:00:00Z",
    "last_full_sync_count": 120,
    "last_incremental_sync_at": "2026-10-11T21:00:00Z",
    "sync_frequency_seconds": 3600,
    "created_at": "2026-10-01T12:00:00Z",
    "updated_at": "2026-10-11T21:00:00Z"
  }
}

Campos da resposta

stateobject

Estado da sincronização do seller, ou null se nunca foi ligada.

idstring

UUID do registro.

vendor_idstring

UUID do seller.

meta_catalog_idstring

Id do catálogo na Meta.

enabledboolean

Sincronização ligada.

last_full_sync_atstring

Última sincronização completa.

last_full_sync_countinteger

Produtos enviados nela.

last_full_sync_errorstring

Erro da última sincronização completa, se houve.

last_incremental_sync_atstring

Última sincronização incremental (automática, de hora em hora).

sync_frequency_secondsinteger

Intervalo da sincronização automática, em segundos.

created_atstring

Criação.

updated_atstring

Última alteração.

Erros (Ligar)

Status	Quando	Corpo
400	`vendor_id` ou `meta_catalog_id` ausente; o seller não tem número de WhatsApp com token; ou a Meta recusou o catálogo (a mensagem vem em `error`).	`{"error":"whatsapp catalog: vendor has no WhatsApp credentials configured"}`
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O módulo WhatsApp Commerce está desligado na loja, o usuário não é administrador ou não tem o privilégio exigido.	`{"error":"module_disabled","module":"whatsapp-commerce"}` ou `{"error":"insufficient privileges","required":"manage_settings"}` ou `{"error":"admin access required"}`

Desligar

Para as sincronizações futuras. Os produtos que já estão na Meta não são apagados e o histórico é mantido: religar continua de onde parou.

POST/api/v1/admin/whatsapp/catalog-sync/disableAdmin

Desliga a sincronização do catálogo do seller

Corpo da requisição

vendor_idstringobrigatório

UUID do seller.

Exemplo de requisição (Desligar)

bash

curl -X POST "$BASE_URL/api/v1/admin/whatsapp/catalog-sync/disable" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36"
  }'

Resposta (Desligar)

200Desligada

json

{
  "ok": true
}

Campos da resposta

okboolean

true.

Erros (Desligar)

Status	Quando	Corpo
400	Sem `vendor_id` (a rota exige o seller; usuários vinculados a um seller usam o próprio).	`{"error":"vendor_id required"}`
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O módulo WhatsApp Commerce está desligado na loja, o usuário não é administrador ou não tem o privilégio exigido.	`{"error":"module_disabled","module":"whatsapp-commerce"}` ou `{"error":"insufficient privileges","required":"manage_settings"}` ou `{"error":"admin access required"}`