Como criar um cliente

📘
Os clientes são os que compram os seus produtos, o que os torna obrigatórios para os seus pedidos de venda.

Os clientes são criados por meio do nosso endpoint de Entidade. A requisição deve ser parecida com esta:

[
  {
    "name": "John Doe",              // Nome da pessoa ou empresa
    "tradeName": "John Doe",         // Nome fantasia (para pessoa física, você pode repetir o nome)
    "personType": 2,                 // Tipo de pessoa (1 = Jurídica / Empresa, 2 = Física / Pessoa)
    "entityTypeId": 1,               // Tipo de entidade
    "relationalEntityCode": "8504",  // Id da entidade no sistema de origem
    "situationCode": 1               // Situação da entidade (1 = Ativo, 2 = Inativo, 3 = Em cadastro)
  }
]

Estes são os campos obrigatórios para criar um cliente.

🚧
Os clientes sempre têm a propriedade entityTypeId definida como 1.

🚧
Dependendo da configuração do WMS e do tipo de pessoa, o campo document (CPF para pessoa física, CNPJ para pessoa jurídica) também pode ser obrigatório.

🚧
Os campos de endereço são opcionais, mas, se você preencher qualquer um deles, os seguintes tornam-se obrigatórios: street, zipCode, initialsState, district e city.

📘
É possível criar vários clientes na mesma requisição.

Campos opcionais

Nome	Descrição	Valor padrão
subtype	Qualquer subtipo que você queira adicionar a esta entidade
entityNote	Quaisquer observações que você queira adicionar a uma entidade
street	Logradouro (endereço)
typeAddressCode	Código do tipo de endereço (1 = Residencial, 2 = Comercial, 3 = Faturamento, 4 = Entrega, 5 = Cobrança)
district	Bairro
zipCode	CEP
complement	Complemento do endereço
city	Cidade
initialsState	Sigla do estado (UF)
state	Nome completo do estado / distrito. Fallback para `initialsState`: resolvido internamente para a sigla quando `initialsState` não é informado.
country	Nome completo do país. Opcional; usado apenas para desambiguar `state` quando o mesmo nome existe em mais de um país.
flag	As flags são usadas para agrupar entidades
stateRegistration	Inscrição Estadual da empresa (somente Brasil)
routeId	Id da rota no WMS a ser associada a esta entidade
route	Descrição da rota no WMS a ser associada a esta entidade

Para mais informações sobre as propriedades necessárias, consulte a nossa Referência da API aqui.

Updated 4 days ago

Did this page help you?