Listado de direcciones de un cliente
Esta función permite obtener un listado de todas las direcciones de un cliente.
Parámetros de Entrada
Parámetro | Tipo | Descripción |
|---|---|---|
clientId CAMPO OBLIGATORIO | Integer | Identificador del cliente |
Parámetros de Salida
Parámetro | Tipo | Descripción |
|---|---|---|
locationId | Integer | Identificador de la dirección |
additionalData | String | Campo donde se incluyen datos adicionales de la dirección |
addressLine1 | String | Línea 1 de la dirección |
addressLine2 | String | Línea 2 de la dirección |
city | String | Ciudad |
countryId | Integer | Identificador del país. Los códigos de país están indicados en el anexo 5.1 Códigos de país de este documento. |
county | String | Municipio |
locationTypes | List | Tipos de dirección. El parámetro contiene un listado de String con los tipos de dirección. Los posibles valores son: BI = Facturación, CE = Certificado, SH = Envío |
mainLocation | Boolean | Indica si esta dirección es la principal |
name | String | Nombre descriptivo de la dirección |
stateId | Integer | Identificador de la provincia. Los códigos de las provincias se pueden obtener con una llamada al API (Recuperar provincias de un país). |
zipCode | String | Código postal |
Códigos Error
Código | Descripción |
|---|---|
1000 | Error genérico |
3300 | Error obteniendo el listado de direcciones |
3301 | Error por falta de parámetros obligatorios |
Ejemplos
Llamada (Método GET)
https://servidor:8443/calibry-rest-api/rest/cif/client/{clientId}/locations
https://servidor:8443/calibry-rest-api/rest/cif/client/1/locations
Headers:
Authorization
Respuestas
Correcta:
[
{
"locationId": 2,
"name": "Dirección 2",
"addressLine1": "Calle río Ebro 1",
"addressLine2": "",
"city": "Madrid",
"county": "",
"zipCode": "28002",
"stateId": 28,
"countryId": 63,
"additionalData": "",
"mainLocation": false,
"locationTypes": ["BI","SH"]
}
]
Error:
{"code":"3301"}