API: GET /orders/{orderId}

Obtiene el detalle de una Orden de Reparación en específico.

GET

/orders/{orderId}

Al llamado de este recurso se deben obtener datos relacionados a la Orden de Reparación de acuerdo al valor proporcionado a través del parámetro(path).

Parámetros

organizationId

REQUERIDO

(header)

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

orderId

REQUERIDO

(path)

Identificador único de una Orden de Reparación.

OR1234

Cuerpo de solicitud

Sin datos

Respuestas

Code 200

Solicitud completada de forma satisfactoria.

Ejemplo
Esquema

				
					{
  "success": true,
  "message": null,
  "data": {
    "orderId": "1ABC1-0912-AK123",
    "orderNumber": "AK123",
    "serviceAdvisorId": "37494",
    "orderDate": "2018-01-21T08:30:00.000Z",
    "orderType": "MANTENIMIENTO",
    "serviceType": "service",
    "status": "COMPLETADA",
    "promisedDate": "2018-01-21T11:00:00.000Z",
    "total": 3500,
    "openDate": "2018-01-21T08:30:00.000Z",
    "closedDate": "",
    "vin": "JHLRD77874C026456",
    "brand": "Chevrolet",
    "model": "Spark",
    "year": "2018",
    "licensePlate": "TYU7833",
    "kilometers": "20314",
    "customerParts": "2000",
    "customerLabor": "250",
    "customerMisc": "300",
    "totsCost": "300",
    "gogCost": "167.25",
    "totalBeforeTaxes": "3017.25",
    "invoiceDate": "2018-01-22T12:00:00:00.000Z",
    "insuranceData": {
      "insuranceVehiclesData": "",
      "insurancePolicyNumber": "",
      "insuranceCompany": ""
    },
    "technicianId": "A123",
    "towerNumber": "123",
    "utsSold": "100",
    "comments": "Tenía un golpe en el costado.",
    "clientId": "37438",
    "firstName": "Karina",
    "lastName": "Lopez",
    "address": "Av 100 metros 345 Gustavo A Madero CP 78800",
    "City": "Matehuala",
    "State": "San Luis Potosí",
    "zip": "78800",
    "mainPhone": "3315798465",
    "mobile": "3315798465",
    "email": "karina.lopez@gmail.com"
  }
}

{

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 conjunto de Órdenes de Reparación que cumplan con los criterios proporcionados en cualquiera de los parámetros
orderId*	string Identificador único de la orden en la base de datos
orderNumber*	string Número de orden en el sistema.
serviceAdvisorId*	string Identificador único del Asesor de Servicio
orderDate*	string($date-time) Fecha de la orden
orderType*	string example: Garantía Tipo de orden
serviceType	string example: Mantenimiento Describe el tipo de servicio en la Orden de Reparación
status*	string example: Abierta, Cerrada, Facturada Algunos DMS o ERP incluyen otros estatus adicionales
total*	string La factura total de la Orden de Reparación, es decir, el costo total del servicio que será pagado por el cliente.
openDate	string($date) pattern: yyyy-MM-ddThh:mm:ss.000Z Fecha cuando la Orden de Reparación es abierta.
closeDate	string($date) pattern: yyyy-MM-ddThh:mm:ss.000Z Fecha cuando la Orden de Reparación es cerrada
vin*	string Número de Indentificación del Vehículo
brand*	string Marca del vehículo relacionado a la orden
licensePlate*	string Placas del vehículo relacionado a la orden
model*	string Modelo del vehículo relacionado a la orden
year*	string Año del vehículo relacionado a la orden
kilometers*	string Kilometraje del vehículo
customerParts	string Costo total en refacciones de la Orden de Reparación
customerLabor	string Costo total en mano de obra de la Orden de Reparación.
customerMisc	string Costo total de los articulos diversos (misceláneos) en la factura de la Orden de Reparación
totsCost	string Costo total de trabajos en otro taller en la factura de la Orden de Reparación.
gogCost	string Costo de gasolina, aceite y grasa
totalBeforeTaxes	string Costo total sin impuestos
invoiceDate	string Fecha de factura
insuranceData
technicianId	string Identificador único del Técnico, conocido como el ID del empleado o ID del DMS o ERP
towerNumber	string Número del cono u objeto puesto sobre cada vehículo en el que se trabaja
utsSold	string Unidades de tiempo vendidas (UTS)
comments	string Comentarios realizados por el Asesor de Servicio
laborHours	string Horas de Mano de obra en la Orden de Reparación
promisedDate*	string($date) pattern: yyyy-MM-ddThh:mm:ss.000Z Fecha y hora promesa de la entrega del vehículo
clientId*	string Identificador único del cliente
firstName*	string Nombre del cliente
lastName*	string Apellido del cliente
address	string Direccion del cliente
city	string Ciudad en la dirección del cliente
state	string Estado en la dirección del cliente
zip	string Codigo postal de la 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

}

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