HomeGuidesAPI Reference
Log In
Guides

Como criar um fornecedor

📘

Os fornecedores são obrigatórios para criar Produtos e Pedidos de Compra, pois cada um deles precisa de um fornecedor associado. Também são usados em KPIs dentro do sistema.

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

[
  {
    "name": "The Coca-Cola Company", // Nome da pessoa ou empresa
    "tradeName": "Coca-Cola",        // Nome fantasia da empresa
    "personType": 1,                 // Tipo de pessoa (1 = Jurídica / Empresa, 2 = Física / Pessoa)
    "entityTypeId": 2,               // 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 fornecedor.

🚧

Os fornecedores sempre têm a propriedade entityTypeId definida como 2.

🚧

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 fornecedores na mesma requisição.

Campos opcionais

NomeDescriçãoValor padrão
subtypeQualquer subtipo que você queira adicionar a esta entidade
entityNoteQuaisquer observações que você queira adicionar a uma entidade
streetLogradouro (endereço)
typeAddressCodeCódigo do tipo de endereço (1 = Residencial, 2 = Comercial, 3 = Faturamento, 4 = Entrega, 5 = Cobrança)
districtBairro
zipCodeCEP
complementComplemento do endereço
cityCidade
initialsStateSigla do estado (UF)
stateNome completo do estado / distrito. Fallback para initialsState: resolvido internamente para a sigla quando initialsState não é informado.
countryNome completo do país. Opcional; usado apenas para desambiguar state quando o mesmo nome existe em mais de um país.
flagAs flags são usadas para agrupar entidades
stateRegistrationInscrição Estadual da empresa (somente Brasil)
routeIdId da rota no WMS a ser associada a esta entidade
routeDescrição da rota no WMS a ser associada a esta entidade
glnGlobal Location Number do fornecedor

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


Did this page help you?