Visão Geral
Last updated
Através da API de Clientes você pode consultar os clientes cadastrados na sua loja: listar (com busca e paginação) e ver os detalhes de um cliente específico.
O módulo de Clientes é somente leitura (consulta). O cadastro dos clientes é feito pela própria loja, no checkout/site — a API apenas oferece a consulta desses dados. Não existem endpoints para criar, editar ou excluir clientes.
Estas páginas são guias práticos. A referência completa de cada campo, tipo e schema está no simulador online:
Listar e buscar clientes
GET
/clientes/
Detalhes de um cliente
GET
/clientes/{Codigo}/
Em vez de consultar a listagem repetidamente, você pode ser notificado quando um cliente é cadastrado ou editado, usando o recurso de Webhook (eventos Clientes_Cadastro e Clientes_Edicao):
Last updated