Skip to main content
Skip table of contents

Creación de clientes

Esta función permite crear un cliente.

Parámetros de Entrada

Parámetro

Tipo

Descripción

complete

Boolean

Indica si el resultado de la operación es el objeto Cliente completo. Este parámetro va en la URL.

name CAMPO OBLIGATORIO

String

Nombre.

phone

String

Teléfono.

email

String

Dirección de correo.

identificationDocumentId

String

Número documento de identidad.

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.

stateName

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.

countryCode

String

Código de país (Ver Anexo de códigos).

customerBlocked

Boolean

Indica si el cliente está bloqueado.

Parámetros de Salida

Parámetro

Tipo

Descripción

id

String

Identificador del cliente.

Códigos Error

Código

Descripción

1000

Error genérico.

3001

Error creando el cliente.

3002

Faltan parámetros obligatorios.

3007

El nombre del cliente ya existe.

Ejemplos

Llamada (Método POST)

JSON
https://servidor:8443/calibry-rest-api/rest/cif/client
https://servidor:8443/calibry-rest-api/rest/cif/client?complete=true

Headers:
    Authorization
    Content-Type = application/json
    
Body:
{ 
    "name": "MiCliente S.L.", 
    "phone": "912345678", 
    "email": "contact@micliente.com", 
    "identificationDocumentId": "AK123456789", 
    "identificationDocumentTypeId": "1", 
    "observations": "-", 
    "externalCode": "-", 
    "extraField1": "-", 
    "extraField2": "-", 
    "extraField3": "-", 
    "city": "-", 
    "stateName": "", 
    "stateId": "", 
    "zipCode": "-", 
    "addressLine1": "-", 
    "addressLine2": "", 
    "addressName": "-", 
    "additionalData": "-", 
    "countryCode": "ES",
    "customerBlocked":false
}

Respuestas

Correcta:

JSON
{"id":"23"}

Si se devuelve el objeto Cliente completo:

JSON
{
    "id": "23",
    "name": "MiCliente S.L.",
    "phone": "912345678",
    "email": "contact@micliente.com",
    "identificationDocumentId": "AK123456789",
    "observations": "-",
    "identificationDocumentTypeId": "1",
    "externalCode": "-",
    "extraField1": "-",
    "extraField2": "-",
    "extraField3": "-",
    "city": "-",
    "stateName": "",
    "stateId": "",
    "zipCode": "-",
    "addressLine1": "-",
    "addressLine2": "",
    "addressName": "-",
    "additionalData": "-",
    "countryCode": "ES",
    "updatedDate": 1607533360000,
    "customerBlocked":false
}

Error:

JSON
{"code":"3002"}
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.