Skip to main content

Endpoint

Serviço destinado a modificar cadastros de contatos existentes no sistema Olist.

Parâmetros

Estrutura do objeto contato

Campos principais

Informações pessoais

Endereço principal

Endereço de cobrança

Informações de contato

Informações comerciais

Listas de tipos e pessoas

(1) Para localizar o contato a ser alterado, são utilizados os campos de busca na seguinte ordem: id → codigo → cpf_cnpj. Informe ao menos um desses campos (2) Campos de endereço de cobrança são opcionais e devem ser informados apenas se diferentes do endereço principal (3) Campos de informações pessoais se aplicam apenas a pessoas físicas e devem ser informados somente quando necessário (4) Data de nascimento deve estar no formato dd/mm/aaaa. Exemplo: “01/01/2012” (5) Valores decimais devem usar ”.” como separador decimal. Exemplo: “5.25” (6) O ID do vendedor informado deve existir no sistema, caso contrário retornará erro (7) O campo nome_vendedor é desconsiderado se id_vendedor for informado (8) Tipos de contato informados serão apenas adicionados. Tipos existentes não serão removidos ou alterados (9) Pessoas de contato informadas serão apenas adicionadas. Se o nome já existir, não haverá remoção ou alteração (10) O campo CRT é desconsiderado se tipo_pessoa for igual a “F”

Retorno

(11) Retornado quando status = “Erro” (12) Retornado quando o processamento gera resultados individuais por registro (13) Retornado quando o registro foi alterado com sucesso

Exemplo de chamada

Exemplo de retorno

Sucesso

Sucesso - Múltiplos registros

Erro - Token inválido

Erro - Contato não encontrado

Observações

  • É possível alterar múltiplos contatos em uma única chamada através do array contatos
  • O contato é localizado pelos campos id, codigo ou cpf_cnpj nessa ordem de prioridade
  • Apenas os campos informados serão atualizados. Campos não enviados manterão seus valores atuais
  • Tipos de contato e pessoas de contato são sempre adicionados, nunca removidos
  • Consulte a tabela de cidades para valores válidos de município
  • Consulte a tabela de códigos de erro para interpretação dos erros
  • Para obter o ID de um contato, use o endpoint de pesquisa de contatos