Buscar clientes

Con esta función, se tiene la capacidad de leer los clientes que han sido registrados en el sistema. Es importante destacar que se puede proporcionar el nombre de un cliente en concreto a través de un parámetro de URL query. También se puede proporcionar el identificador de un cliente de nuestro sistema. No obstante, no se recomienda usar los dos parámetros a la vez en la misma llamada. En ese caso, prevalecerá el nombre del cliente por encima del valor del identificador. En caso de no especificar este parámetro, se llevará a cabo la lectura de todos los clientes del sistema.

URL

/CTNEAT/CUSTOMER/READ/{tkn}

Método HTTP

GET

Parámetros de la solicitud

Nombre del parámetro Tipo de dato Descripción del parámetro Obligatorio Posibles valores
CUSTOMERNAME cadena Nombre del cliente No (Si el nombre no se especifica, la API devolverá todos los clientes del sistema) Cualquiera
CUSTOMERID numérico Identificador del cliente No Valores enteros de 0 a 999999999

Encabezados de la solicitud

Nombre del encabezado Descripción del encabezado Obligatorio

Cuerpo de la solicitud

No se requiere un cuerpo de solicitud para este método HTTP.

Parámetros de la respuesta

Nombre del parámetro Tipo de dato Descripción del parámetro
Result JSON Json con la descripción del resultado de la operación
Elementos de Result

Códigos de estado de la respuesta

Código de estado Descripción del código de estado Posibles razones
200 OK La solicitud fue exitosa
400 Petición errónea Alguno de los parámetros pasados no es correcto
500 Error interno Error en el servidor
401 Unauthorized El usuario no está autenticado

Ejemplo de consulta

http://ctincoming/CUSTOMER/READ/693DDFEC2F4BFDDEAF04DD2724984C9B3CA89D553DD8E5B9BB233AD6BB6075F1?CUSTOMERNAME=NOMBRE_CLIENTE

Ejemplo de respuesta

{ 
  "NRecords":1, 
  "Data":[ 
    { 
      "CustomerName":"NOMBRE_CLIENTE", 
      "NIF":"NIF1234567", 
      "Address":"DIRECCIÓN", 
      "PostalCode":"CP000", 
      "City":"CIUDAD", 
      "State":"ESTADO O PROVÍNCIA",
      "Email":"EMAIL",
      "PhoneNumber":"931001000"
      "Web":"www.una-url.com"
    } 
  ] 
}

Revision #7
Created 7 November 2025 10:09:51 by Marc Bayod
Updated 17 April 2026 07:05:24 by Marc Bayod