Skip to content

Pessoas

Juliano Bailão edited this page Jan 17, 2017 · 2 revisions

##Paginate Exibe uma página de registros, pode ser passado como parâmetro via array:

  • pageSize: Quantidade de registros a ser exibida por página
  • start: Ponto inicial da paginação
  • Qualquer outro parâmetro descrito na documentação da api
$response = $client->people()->paginate(['pageSize' => 100, 'start' => 0]);

##Get Exibe os dados de 1 registro em específico, deve ser passado como parâmetro em integer:

  • Id do registro
// sendo 45 o id do registro em questão
$response = $client->people()->get(45);

##Create Cria um novo registro.

$person = $client->people()->create();

// verifique a documentação da api para informações sobre os campos
$person->fill([
  'field_name' => 'field_value',
  'foo'        => 'bar',
]);

$response = $person->save();

##Update Atualiza os dados de um registro.

// sendo 45 o id do registro em questão.
$person = $client->people()->update(45);

$person->fill([
  'field_name' => 'field_value',
]);

// caso deseje atualizar alguns campos em específico,
// sugiro que ao invés de utilizar o método fill,
// utilize desta forma:
$person->field_name = 'field_value';
$person->field = 'value';

$response = $person->save();

##Documento Busca uma pessoa pelo número do documento, use para verificar se um cpf/cnpj já está cadastrado no sistema. É necessário passar como parâmetro via string:

  • Número do documento, cpf/cnpj
// sendo 56169189207 o número do documento em questão
$response = $client->people()->document(56169189207);

##Validar Documento Verificar se um cpf/cnpj é válido de acordo com as validações do sistema. É necessário passar como parâmetro via string:

  • Número do documento, cpf/cnpj
// sendo 56169189207 o número do documento em questão
$response = $client->people()->validateDocument(56169189207);

##Endereços de entrega Exibe uma lista dos endereços de entrega da pessoa. É necessário passar como parâmetro via integer:

  • Id da pessoa
// sendo 81178 o id da pessoa em questão
$response = $client->people()->deliverAddresses(81178);

##Valores padrão Exibe uma lista dos valores padrão da pessoa. É necessário passar como parâmetro via integer:

  • Id da pessoa
// sendo 81178 o id da pessoa em questão
$response = $client->people()->defaultValues(81178);

← Localidade e Endereços

Clone this wiki locally