status: podendo receber valores como ativo ou inativo define o status do cliente no sistema. Caso não seja informado será definido por padrão como ativo.
Obrigatóriotipo: podendo receber valores como PF ou PJ define o tipo de cliente.
Obrigatóriodocumento: espera-se receber uma string com o documento do cliente, podendo este representar um CPF ou um CNPJ.
Obrigatórionome: espera-se receber uma string com o nome do cliente.
telefone: espera-se receber uma string com o telefone do cliente, sendo composto por DDD + Número.
Obrigatórioemail: espera-se receber uma string com um e-mail válido do cliente.
cep: espera-se receber uma string com o CEP do endereço do cliente.
uf: espera-se receber uma string com dois caracteres representando a unidade da federação do endereço do cliente.
cidade: espera-se receber uma string com o nome da cidade do endereço do cliente.
bairro: espera-se receber uma string com o nome do bairro do endereço do cliente.
logradouro: espera-se receber uma string com o logradouro do endereço do cliente.
PUT
v1/psintegra/cliente/{id: inteiro}
Realizar Atualizações de um Cliente
Descrição
Este endpoint privado, recebe um json com informações de um produto e faz a tratativa dos dados e os atualiza, podendo ser parcial ou total.
status: podendo receber valores como ativo ou inativo define o status do cliente no sistema. Caso não seja informado será definido por padrão como ativo.
tipo: podendo receber valores como PF ou PJ define o tipo de cliente.
documento: espera-se receber uma string com o documento do cliente, podendo este representar um CPF ou um CNPJ.
nome: espera-se receber uma string com o nome do cliente.
telefone: espera-se receber uma string com o telefone do cliente, sendo composto por DDD + Número.
email: espera-se receber uma string com um e-mail válido do cliente.
cep: espera-se receber uma string com o CEP do endereço do cliente.
uf: espera-se receber uma string com dois caracteres representando a unidade da federação do endereço do cliente.
cidade: espera-se receber uma string com o nome da cidade do endereço do cliente.
bairro: espera-se receber uma string com o nome do bairro do endereço do cliente.
logradouro: espera-se receber uma string com o logradouro do endereço do cliente.
DELETE
v1/psintegra/cliente/{id: inteiro}
Deletar Cliente do Sistema
Descrição
Este endpoint privado, recebe um id de cliente na sua composição, e após validações remove o cliente do sistema de forma definitiva.
status: podendo receber valores como ativo ou inativo define o status do produto no sistema. Caso não seja informado será definido por padrão como ativo.
Obrigatóriotipo: recebe uma string com o tipo do produto.
grupo: recebe uma string com o grupo do produto.
Obrigatóriosku: espera-se receber uma string com o SKU do produto, este é um valor único e não poderá ser duplicado.
ncm: espera-se receber o código do NCM do produto, será salvo em banco de dados apenas caracteres os numéricos do NCM.
Obrigatóriodescricao: espera receber o nome/descrição identificadora do produto.
PUT
v1/psintegra/produto/{id: inteiro}
Realizar Atualização de um Produto
Descrição
Este endpoint privado, recebe um json com informações de um produto e faz a atualização dos dados recebidos, podendo ser total ou parcial.
status: podendo receber valores como ativo ou inativo define o status do produto no sistema. Caso não seja informado será definido por padrão como ativo.
tipo: recebe uma string com o tipo do produto.
grupo: recebe uma string com o grupo do produto.
sku: espera-se receber uma string com o SKU do produto, este é um valor único e não poderá ser duplicado.
ncm: espera-se receber o código do NCM do produto, será salvo em banco de dados apenas caracteres os numéricos do NCM.
descricao: espera receber o nome/descrição identificadora do produto.
DELETE
v1/psintegra/produto/{id: inteiro}
Deletar Produto do Sistema
Descrição
Este endpoint privado, recebe um id de produto na sua composição, e após validações remove o produto do sistema de forma definitiva.