API: POST /orders

Creación de Órdenes de Reparación en el Software Tercero de la agencia o taller

POST

/orders

Al llamado de este recurso se debe crear una Orden de Reparación en el DMS o ERP de acuerdo a los valores proporcionados a través del cuerpo de solicitud

Parámetros

organizationId

REQUERIDO

(header)

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

Cuerpo de solicitud

Formato del cuerpo que se debe envíar desde el cliente para la creación de una orden en el DMS o ERP.

Ejemplo
Esquema

				
					{
  "vin": "JHLRD77874C026456",
  "organizationId": "01",
  "serviceAdvisorId": "37494",
  "promisedDate": "2021-09-21T17:30:00.000Z",
  "kilometers": "20314",
  "orderType": "Mantenimiento",
  "cone": "30",
  "appointmentId": null
}

{

vin*	string Número de Identificación del Vehículo relacionado a la orden que se creará en el DMS o ERP
organizationId*	string Identificador único de la agencia o taller relacionada a la orden que se creará en el DMS o ERP
serviceAdvisorId	string nullable: true Identificador único del Asesor de Servicio asignado a la orden que se creará en el DMS o ERP
promisedDate*	string Fecha y hora promesa de entrega del vehículo relacionado a la orden que se creará en el DMS o ERP
kilometers*	string Kilometraje actual del vehículo relacionado a la orden que se creará en el DMS o ERP
orderType*	string Tipo de la orden que se creará en el DMS o ERP
cone*	string Número de cono que se asigna al vehículo relacionado a la orden que se creará en el DMS o ERP
appointmentId	string nullable: true Identificador único de la cita relacionada a la orden que se creará en el DMS o ERP

}

Respuestas

Code 200

Respuesta que se debe proporcionar cuando una Orden de Reparación fue creada de forma exitosa.

Ejemplo
Esquema

				
					{
  "success": true,
  "message": "Order successfully created",
  "data": {
    "orderId": "1ABC1-0912-AK123",
    "orderNumber": "AK123",
    "serviceAdvisorId": "37494",
    "orderDate": "2021-01-21T08:30:00.000Z",
    "orderType": "MANTENIMIENTO",
    "serviceType": "service",
    "status": "ABIERTA",
    "promisedDate": "2021-09-21T17:30:00.000Z",
    "total": 3500,
    "openDate": "2021-01-21T08:30:00.000Z",
    "closedDate": "",
    "checkin": "2021-01-21T09:00:00.000Z",
    "checkout": "",
    "vin": "JHLRD77874C026456",
    "brand": "Chevrolet",
    "model": "Spark",
    "year": "2018",
    "licensePlate": "TYU7833",
    "kilometers": "20314",
    "customerParts": null,
    "customerLabor": null,
    "customerMisc": null,
    "totsCost": null,
    "gogCost": null,
    "totalBeforeTaxes": null,
    "invoiceDate": null,
    "insuranceData": {
      "insuranceVehiclesData": "",
      "insurancePolicyNumber": "",
      "insuranceCompany": ""
    },
    "technicianId": "A123",
    "towerNumber": "030",
    "utsSold": "100",
    "comments": "Servicio de los 20,000 km.",
    "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"
  }
}

{

vin*	string Número de Identificación del Vehículo relacionado a la orden que se creará en el DMS o ERP
organizationId*	string Identificador único de la agencia o taller relacionada a la orden que se creará en el DMS o ERP
serviceAdvisorId	string nullable: true Identificador único del Asesor de Servicio asignado a la orden que se creará en el DMS o ERP
promisedDate*	string Fecha y hora promesa de entrega del vehículo relacionado a la orden que se creará en el DMS o ERP
kilometers*	string Kilometraje actual del vehículo relacionado a la orden que se creará en el DMS o ERP
orderType*	string Tipo de la orden que se creará en el DMS o ERP
cone*	string Número de cono que se asigna al vehículo relacionado a la orden que se creará en el DMS o ERP
appointmentId	string nullable: true Identificador único de la cita relacionada a la orden que se creará en el DMS o ERP

}

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 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