Listado de clientes
Esta función permite obtener un listado de todos los clientes existentes.
Parámetros de Entrada
Parámetro | Tipo | Descripción |
|---|---|---|
clientId | Integer | Identificador del cliente. |
updatedDateFrom | Long | Fecha actualización desde. El formato de la fecha es en número de milisegundos. |
updatedDateTo | Long | Fecha actualización hasta. El formato de la fecha es en número de milisegundos. |
Parámetros de Salida
Parámetro | Tipo | Descripción |
|---|---|---|
id | String | Identificador del cliente. |
name | String | Nombre. |
phone | String | Teléfono. |
String | Dirección de correo. | |
identificationDocumentId | String | Dirección de correo. |
identificationDocumentTypeId | String | Tipo documento de identidad: 1 = CIF, 2 = NIF, 3 = NIE. |
observations | String | Observaciones. |
externalCode | String | Código externo. |
extraField1 | String | Otros 1. |
extraField2 | String | Otros 2. |
extraField3 | String | Otros 3. |
city | String | Localidad. |
sateName | String | Nombre provincia. |
stateId | String | Identificador de la provincia. |
zipCode | String | Código Postal. |
addressLine1 | String | Datos dirección 1. |
addressLine2 | String | Datos dirección 2. |
addressName | String | Nombre dirección. |
additionalData | String | Otros datos. |
updatedDate | Long | Fecha de actualización. El formato de la fecha es en número de milisegundos. |
countryCode | String | Código de país (Ver Anexo de códigos). |
customerBlocked | Boolean | Indica si el cliente está bloqueado |
Códigos Error
Código | Descripción |
|---|---|
1000 | Error genérico. |
3000 | Error obteniendo el listado de clientes. |
Ejemplos
Llamada (Método GET)
https://servidor:8443/calibry-rest-api/rest/cif/client
https://servidor:8443/calibry-rest-api/rest/cif/client?clientId=1
https://servidor:8443/calibry-rest-api/rest/cif/client?clientId=1&updatedDateFrom=1603706400000
HTTP Headers:
Authorization
Respuestas
Correcta:
[
{
"id": "17",
"name": "Cliente ASDF",
"phone": "+34 123456789",
"email": "cliente@dominioCliente.com",
"identificationDocumentId": "123654789Z",
"observations": "-",
"identificationDocumentTypeId": "1",
"externalCode": "180403-23",
"extraField1": "-",
"extraField2": "-",
"extraField3": "-",
"city": "Tres Cantos",
"stateName": "Madrid",
"stateId": "28",
"zipCode": "28760",
"addressLine1": "Calle río Ebro",
"addressLine2": null,
"addressName": "Dirección Principal",
"additionalData": "Laboratorio en tercera planta.",
"updatedDate":1603706400000,
"countryCode": "ES",
"customerBlocked":false
}
]
Error:
{"code":"3000"}