Lista de Clientes

Definición

GET https://api.avanto.mx/v1/customers

Recursos

Recurso	Tipo	Default	Descripción
q	string	none	Consulta. Texto a buscar en customer_name (nombre del cliente) o en sic_code (RFC)
fields	string	none	Campo o lista de campos a obtener
expand	string	none	Objeto u objetos relacionados a obtener: contacts y/o subsidiaries
page	integer	1	Página de resultados a regresar
limit	string	20	Número del 1 al 20 que representa la cantidad máxima de resultados a regresar por paginación

Ejemplos

Petición vía HTTPs

Obtener los clientes cuyo nombre o RFC contenga "FER"

GET https://api.avanto.mx/v1/customers?q=FER

Obtener los siguientes 10 clientes a partir de la página 2

GET https://api.avanto.mx/v1/customers?page=2&limit=10

Obtener los campos de Nombre de cliente, RFC y sucursales

GET https://api.avanto.mx/v1/customers?fields=customer_name,sic_code,subsidiaries.subsidiary_name&expand=subsidiaries

Petición vía cURL

Obtener los clientes cuyo nombre o RFC contenga "FER"

curl --request GET \
  --url 'https://api.avanto.mx/v1/customers?q=FER' \
  --header 'authorization: Bearer [Token autenticación]' \

Obtener los siguientes 10 clientes a partir de la página 2

curl --request GET \
  --url 'https://api.avanto.mx/v1/customers?page=2&limit=10' \
  --header 'authorization: Bearer [Token autenticación]' \

Obtener los campos de Nombre de cliente, RFC y sucursales

curl --request GET \
  --url 'https://api.avanto.mx/v1/customers?fields=customer_name%2Csic_code%2Csubsidiaries.subsidiary_name&expand=subsidiaries' \
  --header 'authorization: Bearer [Token autenticación]' \