Skip to main content

Endpoint

Serviço destinado a permitir a criação e inclusão de cadastros de contatos dentro do 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) Campos de informações pessoais se aplicam apenas a pessoas físicas (tipo_pessoa = “F”) (2) Data de nascimento deve estar no formato dd/mm/aaaa. Exemplo: “01/01/2012” (3) Os valores de cidade e país devem estar de acordo com as tabelas oficiais de municípios e países (4) Campos de endereço de cobrança são opcionais e devem ser informados apenas se diferentes do endereço principal (5) O campo CRT é desconsiderado para pessoas físicas (tipo_pessoa = “F”) (6) Valores decimais devem usar ”.” como separador decimal. Exemplo: “5.25” (7) O ID do vendedor informado deve existir no sistema, caso contrário retornará erro (8) O campo nome_vendedor é desconsiderado se id_vendedor for informado

Retorno

(9) Retornado quando status = “Erro” (10) Retornado quando o processamento gera resultados individuais por registro (11) Retornado quando o registro foi incluído com sucesso

Exemplo de chamada

Exemplo de retorno

Sucesso

Erro - Token inválido

Erro - Dados inválidos

Observações

  • É possível incluir múltiplos contatos em uma única chamada através do array contatos
  • O campo sequencia é obrigatório para identificar cada contato no retorno
  • 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
  • Campos de pessoa física são aplicáveis apenas quando tipo_pessoa = “F”