API: GET /orders

Obtiene el listado de las Órdenes de Reparación

GET

/orders

Al llamado de este recurso se deben obtener datos relacionados a las Órdenes de Reparación 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.

16
vin

(query)

Número de identificación vehícular.

vin
dateFrom

(query)

Fecha de inicio que se usará para filtrar la información.

2021-08-25
dateTo

(query)

Fecha de fin que se usará para filtrar la información.

2021-08-30
arrived

(query)

Estatus de las citas u Órdenes de Reparación que hace referencia a si el cliente ya se presentó o no a la agencia o taller. Si no se incluye, se devuelven todas las citas u Órdenes de Reparación.

true
Cuerpo de solicitud
Sin datos
Respuestas
Code 200

Solicitud completada de forma satisfactoria.

				
					{
  "success": false,
  "message": null,
  "data": [
    {
      "appointmentId": "639503",
      "orderId": null,
      "status": "Pending",
      "clientId": "738949",
      "firstName": "Ricardo",
      "lastName": "Gamboa Torres",
      "address": "Av de los Insurgente 6400, Colonia del Valle, CDMX, CP 03100",
      "mainPhone": "5534456006",
      "secondaryPhone": null,
      "mobile": "5584982090",
      "email": "rgamboatorres@gmail.com",
      "serviceAdvisorId": "28494",
      "vin": "3KPC24B54KE019325",
      "licensePlate": "UHN5647",
      "brand": "Honda",
      "model": "Accord",
      "year": "2019",
      "date": "2021-09-21T12:30:00.000Z",
      "promisedDate": null,
      "confirmed": true,
      "socialName": null,
      "comments": "Cliente pide descuento en servicio",
      "preOrderId": null,
      "orderTypeId": "1",
      "orderType": "MANTENIMIENTO",
      "serviceType": "20000 km",
      "isService": true,
      "isRepair": false,
      "isDiagnostic": false,
      "mainType": "Service",
      "secondType": null,
      "thirdType": null,
      "appointmentPersonId": "014"
    },
    {
      "appointmentId": "639123",
      "orderId": null,
      "status": "No Show",
      "clientId": "918239",
      "firstName": "Carlos",
      "lastName": "Estrada García",
      "address": "Av de los Laureles 1234, Colonia del Valle, CDMX, CP 03110",
      "mainPhone": "5533982928",
      "secondaryPhone": null,
      "mobile": "5533982928",
      "email": "carlosega@gmail.com",
      "serviceAdvisorId": "124",
      "vin": "3KPC24BPO91819325",
      "licensePlate": "UMN1982",
      "brand": "Honda",
      "model": "CR-V",
      "year": "2018",
      "date": "2021-09-21T12:00:00.000Z",
      "promisedDate": null,
      "confirmed": false,
      "socialName": null,
      "comments": null,
      "preOrderId": null,
      "orderTypeId": "1",
      "orderType": "DIAGNÓSTICO",
      "serviceType": "Revisión de Frenos",
      "isService": false,
      "isRepair": false,
      "isDiagnostic": true,
      "mainType": "diagnostic",
      "secondType": null,
      "thirdType": null,
      "appointmentPersonId": "011"
    },
    {
      "appointmentId": "640010",
      "orderId": null,
      "status": "Arrive",
      "clientId": "8726182",
      "firstName": "Angel",
      "lastName": "Viveros Ruiz",
      "address": "Av Central 8172, Colonia del Prado, CDMX, CP 03100",
      "mainPhone": "3388117722",
      "secondaryPhone": null,
      "mobile": "3388117722",
      "email": "angelviruz@gmail.com",
      "serviceAdvisorId": "124",
      "vin": "3KPC24BPO918MKSJAS",
      "licensePlate": "JKV9019",
      "brand": "Honda",
      "model": "Civic",
      "year": "2020",
      "date": "2021-09-21T11:30:00.000Z",
      "promisedDate": null,
      "confirmed": true,
      "socialName": null,
      "comments": null,
      "preOrderId": null,
      "orderTypeId": "1",
      "orderType": "MANTENIMIENTO",
      "serviceType": "10000 km",
      "isService": true,
      "isRepair": false,
      "isDiagnostic": false,
      "mainType": "service",
      "secondType": null,
      "thirdType": null,
      "appointmentPersonId": "014"
    }
  ]
}
{
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*[

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

serviceTypestring
example: Mantenimiento

Describe el tipo de servicio en la Orden de Reparación

status*string
example: Lavado, Revisión de calidad

Algunos DMS o ERP incluyen otros estatus adicionales

total*string
example: Lavado, Revisión de calidad

La factura total de la Orden de Reparación, es decir, el costo total del servicio que será pagado por el cliente.

openDatestring($date)
pattern: yyyy-MM-ddThh:mm:ss.000Z

Fecha cuando la Orden de Reparación es abierta.

closeDatestring($date)
pattern: yyyy-MM-ddThh:mm:ss.000Z

Fecha cuando la Orden de Reparación es cerrada

checkinstring($date)
pattern: yyyy-MM-ddThh:mm:ss.000Z

Fecha de ingreso del vehículo

checkoutstring($date)
pattern: yyyy-MM-ddThh:mm:ss.000Z

Fecha de salida del vehículo

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

customerPartsstring

Costo total en refacciones de la Orden de Reparación

customerLaborstring

Costo total en mano de obra de la Orden de Reparación.

customerMiscstring

Costo total de los articulos diversos (misceláneos) en la factura de la Orden de Reparación

totsCoststring

Costo total de trabajos en otro taller en la factura de la Orden de Reparación.

gogCoststring

Costo de gasolina, aceite y grasa

totalBeforeTaxesstring

Costo total sin impuestos

invoiceDatestring

Fecha de factura

insuranceData
technicianIdstring

Identificador único del Técnico, conocido como el ID del empleado o ID del DMS o ERP

towerNumberstring

Número del cono u objeto puesto sobre cada vehículo en el que se trabaja

utsSoldstring

Unidades de tiempo vendidas (UTS)

commentsstring

Comentarios realizados por el Asesor de Servicio

laborHoursstring

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

addressstring

Direccion del cliente

citystring

Ciudad en la dirección del cliente

statestring

Estado en la dirección del cliente

zipstring

Codigo postal de la dirección del cliente

mainPhone*string

Teléfono fijo del cliente

mobilestring

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.

				
					{
  "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. 

				
					{
  "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”. 

				
					{
  "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]
}
Linkedin Facebook

Compañía

Nosotros

Productos

ClearMechanic One Solution
Auto Prospección
ClearMechanic
Planeador de Taller

Uso de información

Aviso de privacidad
Términos y condiciones
Solicitar eliminar cuenta

© 2024 ClearCheck y sus afiliados.