API: GET /customers/{customerId}

Obtiene el detalle de un cliente en específico

GET

/customers/{customerId}

Al llamado de este recurso se deben obtener datos relacionados al cliente de acuerdo a los valores proporcionados a través de los parámetros de la llamada.

Parámetros

organizationId

REQUERIDO

(header)

Identificador único de la agencia, taller o inventario de la cual se quiere obtener la información.

customerId

REQUERIDO

(path)

Identificador único del cliente final.

12345

Cuerpo de solicitud

Sin datos

Respuestas

Code 200

Solicitud completada de forma satisfactoria.

Ejemplo
Esquema

				
					{
  "success": true,
  "message": null,
  "data": {
    "clientId": "12345",
    "firstName": "Carlos",
    "lastName": "Castañeda Robles",
    "address": "Calle andada #1538, Colonia del monte, Zapopan, Jal, CP 45440",
    "mainPhone": "31264857",
    "secondaryPhone": "3316487948",
    "mobile": "3315487512",
    "email": "carlos.casta12@gmail.com",
    "socialName": "Carlos Castañeda",
    "RFC": "CAMC900212EI2",
    "fiscalAddress": "Calle andada #1538, Colonia del monte, Zapopan, Jal, CP 45440",
    "fiscalEmail": "carlos.casta12@gmail.com",
    "contactable": true
  }
}

{

success*

boolean

Valor que indica que el llamado al recurso fue exitoso. / Field that tells if a request was successful.

message*

string
nullable: true

Proporciona una pequeña descripción cuando ocurre un error al llamado del recurso, por lo regular el valor de este parametro es nulo si no ocurre algún error. / Error message description, can be null if it was a successful request.

data*

{

description:	Representa el cliente que cumplan con los criterios proporcionados en culquiera de los parámetros
clientId*	string Identificador único del cliente
firstName*	string Nombre del cliente
lastName*	string Apellido del cliente
address*	string Dirección del cliente
mainPhone*	string Teléfono fijo del cliente
mobile*	string Teléfono celular del cliente
email*	string Correo electrónico del cliente
socialName*	string Razón Social del cliente
RFC*	string RFC del cliente
fiscalAddress*	string Dirección fiscal del cliente
fiscalEmail*	string Correo electrónico de facturación
contactable*	boolean Indica si el cliente desa ser contactado o no.

}

Code 400

Error de solicitud incorrecta, se recomienda proporcionar más detalle a través del atributo “mensaje”, indicando si faltan parámetros para realizar la búsqueda.

Ejemplo
Esquema

				
					{
  "success": false,
  "message": "El servidor no puede entender la solicitud debido a un error de sintaxis del lado del cliente, faltan los parámetros: xxxxx, yyyyy, zzzzz. / There is a client side syntax error. The following paramters are missing: xxxxx, yyyyy, zzzzz.",
  "data": []
}

{

success*	boolean Valor que indica que el llamado al recurso no fue exitoso. / Field that tells if the request was successful.
message*	string Proporciona una pequeña descripción del error que hubo al momento de la ejecución del recurso. / Provides an error description.
data*	[ minItems: 0 maxItems: 0 Arreglo que no contiene datos debido a que hubo un error al momento de la ejecución del recurso. / Empty array due to a failed request. string]

}

Code 404

No se encontró una coincidencia con los parámetros de búsqueda.

Ejemplo
Esquema

				
					{
  "success": false,
  "message": "No se encontraron datos que cumplan con los criterios proporcionados a través de los parámetros. / There was no match for the resource you're looking for.",
  "data": []
}

{

success*	boolean Valor que indica que el llamado al recurso no fue exitoso. / Field that tells if the request was successful.
message*	string Proporciona una pequeña descripción del error que hubo al momento de la ejecución del recurso. / Provides an error description.
data*	[ minItems: 0 maxItems: 0 Arreglo que no contiene datos debido a que hubo un error al momento de la ejecución del recurso. / Empty array due to a failed request. string]

}

Code 500

Error de servidor interno, se recomienda proporcionar más detalle a través del atributo “mensaje”.

Ejemplo
Esquema

				
					{
  "success": false,
  "message": "El servidor se ha encontrado con una situación que no sabe cómo manejar, intentelo más tarde. / The server can't handle your request at the moment, please try again later.",
  "data": []
}

{

success*	boolean Valor que indica que el llamado al recurso no fue exitoso. / Field that tells if the request was successful.
message*	string Proporciona una pequeña descripción del error que hubo al momento de la ejecución del recurso. / Provides an error description.
data*	[ minItems: 0 maxItems: 0 Arreglo que no contiene datos debido a que hubo un error al momento de la ejecución del recurso. / Empty array due to a failed request. string]

}

Recepción de vehículos

Cotizaciones

Facturación