VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Guia rápido/Clientes

POSTAtualizar status do cliente

Atualiza status, limite de crédito, formas de pagamento e grupos de usuários de um ou mais clientes pelo CNPJ.

Use este endpoint para atualizar o status do cliente, o limite de crédito, as formas de pagamento disponíveis e os grupos de usuários dele no e-commerce. O corpo é um array e o cliente é identificado pelo CNPJ. Você pode atualizar vários clientes em uma única requisição.

Dica

Você pode atualizar vários clientes em uma única requisição. Recomendamos enviar no máximo 50 CNPJs por requisição, para ter bom desempenho.

POST/api/customerSeller

Atualiza status, limite, pagamentos e grupos do cliente

Cabeçalhos

Authorizationstringobrigatório
Basic Auth. Combinação usuário:senha codificada em Base64 (o e-mail e a chave de API do Seller Center).

O corpo é um array de objetos de cliente. Recomendamos enviar no máximo 50 CNPJs por requisição, para ter bom desempenho.

Corpo da requisição

CNPJstringobrigatório
CNPJ do cliente (número de registro da empresa) que será atualizado.
statusstring
AD
Status do cliente no e-commerce. A: ativo, o cliente pode fazer pedidos se houver limite de crédito disponível. D: desativado, o cliente não pode fazer pedidos mesmo com crédito disponível.
limitstring
Valor máximo que o cliente pode ter em pedidos em aberto. Use ponto (não vírgula) como separador decimal. Se não for informado, o valor padrão de R$ 99.999.999,00 é atribuído. O valor deve já descontar os pedidos em aberto.
paymentsarray

Formas de pagamento disponíveis para o cliente.

codestring
Código interno da forma de pagamento, configurado no Seller Center. Obrigatório ao usar payments.
statusstring
AD
A: o cliente vê e pode usar a forma de pagamento. D: a forma de pagamento fica oculta e indisponível para este cliente. Obrigatório ao usar payments.
usergroupsarray

Grupos de usuários do cliente.

codestring
Código interno do grupo de usuários, configurado no Seller Center. Obrigatório ao usar usergroups.
statusstring
AD
A: o cliente é incluído neste grupo. D: o cliente é excluído deste grupo. Obrigatório ao usar usergroups.

Exemplo de requisição

bash
curl -X POST "$BASE_URL/api/customer" \
  -u "$EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '[
  {
    "CNPJ": "27547771000150",
    "limit": "47894.99",
    "status": "A",
    "payments": [
      {
        "code": "CARX",
        "status": "A"
      },
      {
        "code": "DINH",
        "status": "D"
      }
    ],
    "usergroups": [
      {
        "code": "51",
        "status": "A"
      }
    ]
  }
]'

Resposta

200Clientes atualizados (200 OK)
json
{
  "count": 1
}

Campos da resposta

countinteger
Número de clientes atualizados com sucesso.

Erros

StatusDescrição
200 OKStatus do(s) cliente(s) atualizado(s) com sucesso.
400 Bad RequestFormato de requisição inválido ou campos obrigatórios ausentes.
401 UnauthorizedCredenciais de autenticação ausentes ou inválidas.
404 Not FoundUm ou mais CNPJs não foram encontrados no sistema.
Nota

Ao gerenciar formas de pagamento e grupos de usuários, você só precisa incluir os que quer alterar. As atribuições existentes que não aparecem na requisição continuam como estavam.

Importante

O limite de crédito (limit) deve já descontar os valores em aberto. Por exemplo, se o cliente tem R$ 100.000 de crédito total e R$ 20.000 em pedidos em aberto, defina o limite em R$ 80.000 para que ele não ultrapasse o crédito total.

Veja também

  • Adicionar clientes
  • Visão geral de clientes
  • Erros
Anterior
Rotas sem versão
Próxima
Grupos de usuários
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também