Referência da API
Clientes
Serviços para gerenciamento completo dos dados cadastrais de clientes, seus endereços e grupos.
Gestão de Clientes
-
Busca um cliente da sua loja pelo documento e devolve o cadastro completo, com endereços e vínculos de preço.
-
Cadastra um cliente na sua loja, com o endereço e, opcionalmente, os vínculos de tipo, grupo e tag de preço. O cliente criado já pode acessar a loja com o username e a senha informados.
-
Atualiza o cadastro de um cliente da sua loja. É uma atualização parcial: envie só os campos que quer mudar.
-
Ativa ou inativa um cliente da sua loja. Cliente inativo não acessa a loja nem finaliza compra.
Endereços
-
Lista os endereços de um cliente da sua loja.
-
Acrescenta um endereço ao cadastro de um cliente da sua loja.
-
Remove um endereço do cadastro de um cliente da sua loja.
-
Remove todos os endereços de um cliente da sua loja de uma vez.
Grupo de Clientes
-
Consulta grupos de cliente da sua loja por nome ou por id externo.
-
Cria um grupo de clientes da sua loja. O grupo define a que tipo de documento se aplica e quais formas de entrega e de pagamento ficam restritas para quem estiver nele.
-
Exclui um grupo de clientes da sua loja. Os clientes que estavam no grupo continuam cadastrados, o que sai é o grupo e os vínculos com ele.
-
Vincula um tipo de preço ao cliente. É o que faz o cliente passar a receber a tabela de preços daquele tipo.
-
Desfaz o vínculo entre um cliente e um tipo de preço. O cliente deixa de receber a tabela de preços daquele tipo.
Gerado a partir da coleção pública da API, publicada em 04/09/2026: api-docs.cws.digital.