getClients

GET /tmwxdapi/getClients

Retorna os clientes cadastrados na loja (limite de 50 clientes).

  • id ID(s) do(s) Cliente(s). Poderá definir mais de um, separados por vírgula. Quando informado, a pesquisa ignorará os parâmetros cpfCnpj, email e busca.

    Exemplos:
    GET /tmwxdapi/getClients?id=5,23,44
  • cpfCnpj CPF ou CNPJ do cliente. É aceito apenas um. Quando informado, a pesquisa ignorará os parâmetros email e busca.

    Exemplos:
    GET /tmwxdapi/getClients?cpfCnpj=304.704.107-77
  • email Email principal do cliente. É aceito apenas um. Quando informado, a pesquisa ignorará os parâmetros busca.

    Exemplos:
    GET /tmwxdapi/getClients?email=comercial@tmw.com.br
  • busca Termos de busca. Será pesquisado no campo nome do cliente.

    Exemplos:
    GET /tmwxdapi/getClients?busca=joão
  • campos Limitar os campos que serão retornados. Separe os campos desejados por vírgula.
    Campos permitidos: id, nome, pessoa, finalidade, cpfCnpj, rgIe, sexo, dataNF, cep, logradouro, num, comp, bairro, cidade, uf, ibge, tel, cel, email e/ou cadastro.

    Exemplos:
    GET /tmwxdapi/getClients?campos=id,nome,tel
  • qtdeClientes Retorna a quantidade total de clientes. Quando informado, a pesquisa ignorará os parâmetros campos, inicio e limite.

    Exemplos:
    GET /tmwxdapi/getClients?qtdeClientes
  • inicio Indica a partir de qual registro deve começar a listagem (registro inicial: 0).
    limite Quantidade de clientes retornados (máximo permitido: 50).

    Exemplos:
    GET /tmwxdapi/getClients?inicio=40&limite=20
GET /tmwxdapi/getClients?campos=id,nome,email,ibge&limite=2

Dados vindos da API na  Loja Modelo
Acesse o Teste:  Runscope
Response (JSON):

{
    "status": true,
    "clientes": [
        {
            "id": "24",
            "nome": "Alexandre Duarte",
            "email": "alexandre.duarte@montacasa.com.br",
            "ibge": "4106902"
        },
        {
            "id": "7",
            "nome": "Alini Ramalho Bispo",
            "email": "alini_bispo@hotmail.com",
            "ibge": "3551603"
        }
    ]
}