Creación de direcciones de un cliente
Esta función permite crear direcciones para un cliente dado.
Parámetros de Entrada
Parámetro | Tipo | Descripción |
|---|---|---|
clientId CAMPO OBLIGATORIO | Integer | Identificador del cliente |
additionalData | String | Campo donde se incluyen datos adicionales de la dirección |
addressLine1 CAMPO OBLIGATORIO | 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. Este campo es obligatorio si se especifica el identificador de la provincia (stateId) 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 |
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 |
3302 | Error creando la dirección |
3303 | El cliente indicado no existe |
3304 | El usuario logado no tiene acceso al cliente indicado |
3305 | El código del país indicado no es válido |
3306 | Se ha especificado provincia pero no el país |
3307 | El código de provincia indicado no es válido |
3308 | El tipo de localización no es válido |
Ejemplos
Llamada (Método POST)
https://servidor:8443/calibry-rest-api/rest/cif/client/{clientId}/location/
https://servidor:8443/calibry-rest-api/rest/cif/client/1/location
Headers:
Authorization
Content-Type = application/json
Body:
{
"additionalData": "",
"addressLine1": "Calle río Ebro 1",
"addressLine2": "",
"city": "Madrid",
"countryId": 63,
"county": "",
"locationTypes": ["BI","SH"],
"mainLocation": false,
"name": "Dirección envíos y facturación",
"stateId": 28,
"zipCode": "28001"
}
Respuestas
Correcta:
[
{
"locationId": 2,
"additionalData": "",
"addressLine1": "Calle río Ebro 1",
"addressLine2": "",
"city": "Madrid",
"countryId": 63,
"county": "",
"locationTypes": ["BI","SH"],
"mainLocation": false,
"name": "Dirección envíos y facturación",
"stateId": 28,
"zipCode": "28001"
}
]
Error:
{"code":"3306"}