Cotizaciones - ClearMechanic

Agrega cotización a una Orden de Reparación existente.

POST

/orders/{orderId}/estimates

Al llamado de este recurso se deben agregar los Puntos de Inspección seleccionados en CMOS junto con su cotización a una Orden de Reparación ya existente.

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

Formato del cuerpo que se debe enviar desde el cliente para la creación de Puntos de Inspección en una cotización de una Orden de Reparación existente.

Ejemplo
Esquema

				
					{
  "orderNumber": "RO12345",
  "inspectionItems": [
    {
      "inspectionItemName": "Correa Transmisión Serpentina",
      "cmosInspectionItenId": "192859128",
      "externalInspectionItemId": "1928375182",
      "quantity": 1,
      "partUnitPrice": 500,
      "availability": 20,
      "LaborHours": 1,
      "LaborHourPrice": 200,
      "comments": null,
      "approvalStatus": "Pending",
      "subItems": null
    },
    {
      "inspectionItemName": "Retrovisor Delantero Derecho",
      "cmosInspectionItemId": "192856491",
      "externalInspectionItemId": "1928331692",
      "quantity": null,
      "partUnitPrice": null,
      "availability": null,
      "LaborHours": null,
      "LaborHourPrice": null,
      "comments": null,
      "approvalStatus": "Pending",
      "subItems": null
    },
    {
      "inspectionItemName": "Sistema de Refrigeración",
      "cmosInspectionItemId": "192856491",
      "externalInspectionItemId": "1928331692",
      "quantity": null,
      "partUnitPrice": null,
      "availability": null,
      "LaborHours": null,
      "LaborHourPrice": null,
      "comments": null,
      "approvalStatus": "Pending",
      "subItems": [
        {
          "subItemName": "Manguera",
          "externalPartId": "154653",
          "quantity": null,
          "partUnitPrice": null,
          "availability": null,
          "LaborHours": null,
          "LaborHourPrice": null,
          "comments": "Comentario"
        },
        {
          "subItemName": "Líquido Refrigerante",
          "externalPartId": "351391",
          "quantity": null,
          "partUnitPrice": null,
          "availability": null,
          "LaborHours": null,
          "LaborHourPrice": null,
          "comments": "Aceite de buena marca."
        }
      ]
    },
    {
      "inspectionItemName": "Servicio 15,000km",
      "cmosInspectionItemId": "123456789",
      "externalInspectionItemId": "987654321",
      "quantity": null,
      "partUnitPrice": null,
      "availability": null,
      "LaborHours": null,
      "LaborHourPrice": null,
      "comments": "Servicio de 15,000 km",
      "approvalStatus": "Approved",
      "subItems": [
        {
          "subItemName": "Aceite",
          "externalPartId": "159753",
          "quantity": 1,
          "partUnitPrice": 200,
          "availability": 25,
          "LaborHours": null,
          "LaborHourPrice": null,
          "comments": "Comentario"
        },
        {
          "subItemName": "Filtro",
          "externalPartId": "357951",
          "quantity": 1,
          "partUnitPrice": 400,
          "availability": 34,
          "LaborHours": null,
          "LaborHourPrice": null,
          "comments": "Aceite de buena marca."
        },
        {
          "subItemName": "Mano de obra",
          "externalPartId": "456735",
          "quantity": 1,
          "partUnitPrice": 500,
          "availability": null,
          "LaborHours": null,
          "LaborHourPrice": null,
          "comments": "Mano de obra de cambio de aceite."
        }
      ]
    },
    {
      "inspectionItemName": "Espejo Retrovisor",
      "cmosInspectionItemId": "12349876",
      "externalInspectionItemId": "102837529",
      "quantity": null,
      "partUnitPrice": null,
      "availability": null,
      "LaborHours": null,
      "LaborHourPrice": null,
      "comments": "",
      "approvalStatus": "Rejected",
      "subItems": [
        {
          "subItemName": "Espejo",
          "externalPartId": "159753",
          "quantity": 2,
          "partUnitPrice": 500,
          "availability": 25,
          "LaborHours": null,
          "LaborHourPrice": null,
          "comments": "Comentario"
        },
        {
          "subItemName": "Mano de obra",
          "externalPartId": "456735",
          "quantity": null,
          "partUnitPrice": null,
          "availability": null,
          "LaborHours": 2,
          "LaborHourPrice": 150,
          "comments": "Mano de obra de cambio de aceite."
        }
      ]
    },
    {
      "inspectionItemName": "Cambio Balatas traseras",
      "cmosInspectionItemId": "72817291",
      "externalInspectionItemId": "123499882",
      "quantity": null,
      "partUnitPrice": null,
      "availability": null,
      "LaborHours": null,
      "LaborHourPrice": null,
      "comments": "",
      "approvalStatus": "Pending",
      "subItems": [
        {
          "subItemName": "Balatas traseras",
          "externalPartId": "159753",
          "quantity": 2,
          "partUnitPrice": 1000,
          "availability": 20,
          "LaborHours": 2,
          "LaborHourPrice": 500,
          "comments": "Balatas Alcon"
        }
      ]
    },
    {
      "inspectionItemName": "Llanta trasera izquierda",
      "cmosInspectionItemId": "192839288",
      "externalInspectionItemId": "222233434",
      "quantity": 1,
      "partUnitPrice": 2500,
      "availability": null,
      "LaborHours": null,
      "LaborHourPrice": null,
      "comments": "",
      "approvalStatus": "Approved",
      "subItems": [
        {
          "subItemName": "Mano de Obra",
          "externalPartId": "159753",
          "quantity": null,
          "partUnitPrice": null,
          "availability": null,
          "LaborHours": 0.5,
          "LaborHourPrice": 500,
          "comments": "Balatas Alcon"
        }
      ]
    }
  ]
}

{

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 los datos relacionados a la cotización de una Orden de Reparación./ Repair Order’s estimate information.

{

orderNumber*

string

Identificador único de la Orden de Reparación de la cual se obtendrá la cotización. / Repair Order unique identifier.

inspectionItems*

[

Representa los Puntos de Inspección que se van a cotizar en la Orden de Reparación. / Estimate information of the Repair Order’s inspection items.

{

inspectionItemName

string

Nombre del Punto de Inspección. / Inspection Item name.

cmosInspectionItemId

string

Identificador único del Punto de Inspección en la librería maestra de CMOS. / Inspection Item unique identifier in the CMOS master library.

externalInspectionItemId*

string

Identificador único del Punto de Inspección en el sistema de cotizaciones externo. / Inspection Item unique identifier in the external system master library.

quantity

number

Cantidad de artículos que se necesitan de este Punto de Inspección. / Required quantity of the Inspect Item.

partUnitPrice

number

Precio por unidad del artículo en el Punto de Inspección. / Price per unit of the Inspection Item.

availability

number

Cantidad disponible en el inventario del sistema de cotizaciones externo. / Availability in stock.

laborHours

number

Cantidad de horas cotizadas para trabajar en la mano de obra del Punto de Inspección. / Hours worked on the Inspection Item.

laborHourPrice

number

Precio por unidad de hora de mano de obra del Punto de Inspección. / Price per hour worked.

comments

string

Comentarios adicionales sobre el Punto de Inspección. Cada comentario adicional debe estar separado por una coma ‘,’/ Additional comments. Any additional comment should be separated by a comma ‘,’

approvalStatus

string
example: Approved Rejected Pending

Status en el que se encuentra el Punto de Inspección con respecto a la aprobación del cliente. Los estatus disponibles son ‘Pending’, ‘Approved’ y ‘Rejected’ / Status of the Inspection Item regarding the client decision, the posible statuses are: ‘Pending’, ‘Approved’, ‘Rejected’

subItems

[
nullable: true

Listado de los sub-puntos con los que cuenta el Punto de Inspección. Un Punto de Inspección puede o no tener sub-puntos. / Sub item list of the Inspection Item. An Inspection Item can have 0 or many sub-items.

{

subItemName*	string Nombre del sub punto. / Sub item name.
externalPartId*	string Identificador único del sub punto en el sistema de cotizaciones externo. / Sub item unique identifier on the external system.
quantity	number Cantidad disponible en el inventario del sistema de cotizaciones externo. / Required quantity of the sub item.
partUnitPrice	number Precio por unidad del artículo del sub punto. / Price per unit of the sub item
availability	number Cantidad disponible en el inventario del sistema de cotizaciones externo. / Availability on stock.
laborHours	number Cantidad de horas cotizadas para trabajar en la mano de obra del Punto de Inspección./ Hours worked on the sub item.
laborHourPrice	number Precio por unidad de hora de mano de obra del sub punto. / Price per hour.
comments	string Comentarios adicionales sobre el sub punto. Cada comentario adicional debe estar separado por una coma ‘,’/ Additional comments of the sub-item. Any additional comment should be separated by a comma ‘,’

}]

}

Respuestas

Code 201

Solicitud completada de forma satisfactoria.

Ejemplo
Esquema

				
					{
  "orderNumber": "RO12345",
  "inspectionItems": [
    {
      "inspectionItemName": "Correa Transmisión Serpentina",
      "cmosInspectionItenId": "192859128",
      "externalInspectionItemId": "1928375182",
      "quantity": 1,
      "partUnitPrice": 500,
      "availability": 20,
      "LaborHours": 1,
      "LaborHourPrice": 200,
      "comments": null,
      "approvalStatus": "Pending",
      "subItems": null
    },
    {
      "inspectionItemName": "Retrovisor Delantero Derecho",
      "cmosInspectionItemId": "192856491",
      "externalInspectionItemId": "1928331692",
      "quantity": null,
      "partUnitPrice": null,
      "availability": null,
      "LaborHours": null,
      "LaborHourPrice": null,
      "comments": null,
      "approvalStatus": "Pending",
      "subItems": null
    },
    {
      "inspectionItemName": "Sistema de Refrigeración",
      "cmosInspectionItemId": "192856491",
      "externalInspectionItemId": "1928331692",
      "quantity": null,
      "partUnitPrice": null,
      "availability": null,
      "LaborHours": null,
      "LaborHourPrice": null,
      "comments": null,
      "approvalStatus": "Pending",
      "subItems": [
        {
          "subItemName": "Manguera",
          "externalPartId": "154653",
          "quantity": null,
          "partUnitPrice": null,
          "availability": null,
          "LaborHours": null,
          "LaborHourPrice": null,
          "comments": "Comentario"
        },
        {
          "subItemName": "Líquido Refrigerante",
          "externalPartId": "351391",
          "quantity": null,
          "partUnitPrice": null,
          "availability": null,
          "LaborHours": null,
          "LaborHourPrice": null,
          "comments": "Aceite de buena marca."
        }
      ]
    },
    {
      "inspectionItemName": "Servicio 15,000km",
      "cmosInspectionItemId": "123456789",
      "externalInspectionItemId": "987654321",
      "quantity": null,
      "partUnitPrice": null,
      "availability": null,
      "LaborHours": null,
      "LaborHourPrice": null,
      "comments": "Servicio de 15,000 km",
      "approvalStatus": "Approved",
      "subItems": [
        {
          "subItemName": "Aceite",
          "externalPartId": "159753",
          "quantity": 1,
          "partUnitPrice": 200,
          "availability": 25,
          "LaborHours": null,
          "LaborHourPrice": null,
          "comments": "Comentario"
        },
        {
          "subItemName": "Filtro",
          "externalPartId": "357951",
          "quantity": 1,
          "partUnitPrice": 400,
          "availability": 34,
          "LaborHours": null,
          "LaborHourPrice": null,
          "comments": "Aceite de buena marca."
        },
        {
          "subItemName": "Mano de obra",
          "externalPartId": "456735",
          "quantity": 1,
          "partUnitPrice": 500,
          "availability": null,
          "LaborHours": null,
          "LaborHourPrice": null,
          "comments": "Mano de obra de cambio de aceite."
        }
      ]
    },
    {
      "inspectionItemName": "Espejo Retrovisor",
      "cmosInspectionItemId": "12349876",
      "externalInspectionItemId": "102837529",
      "quantity": null,
      "partUnitPrice": null,
      "availability": null,
      "LaborHours": null,
      "LaborHourPrice": null,
      "comments": "",
      "approvalStatus": "Rejected",
      "subItems": [
        {
          "subItemName": "Espejo",
          "externalPartId": "159753",
          "quantity": 2,
          "partUnitPrice": 500,
          "availability": 25,
          "LaborHours": null,
          "LaborHourPrice": null,
          "comments": "Comentario"
        },
        {
          "subItemName": "Mano de obra",
          "externalPartId": "456735",
          "quantity": null,
          "partUnitPrice": null,
          "availability": null,
          "LaborHours": 2,
          "LaborHourPrice": 150,
          "comments": "Mano de obra de cambio de aceite."
        }
      ]
    },
    {
      "inspectionItemName": "Cambio Balatas traseras",
      "cmosInspectionItemId": "72817291",
      "externalInspectionItemId": "123499882",
      "quantity": null,
      "partUnitPrice": null,
      "availability": null,
      "LaborHours": null,
      "LaborHourPrice": null,
      "comments": "",
      "approvalStatus": "Pending",
      "subItems": [
        {
          "subItemName": "Balatas traseras",
          "externalPartId": "159753",
          "quantity": 2,
          "partUnitPrice": 1000,
          "availability": 20,
          "LaborHours": 2,
          "LaborHourPrice": 500,
          "comments": "Balatas Alcon"
        }
      ]
    },
    {
      "inspectionItemName": "Llanta trasera izquierda",
      "cmosInspectionItemId": "192839288",
      "externalInspectionItemId": "222233434",
      "quantity": 1,
      "partUnitPrice": 2500,
      "availability": null,
      "LaborHours": null,
      "LaborHourPrice": null,
      "comments": "",
      "approvalStatus": "Approved",
      "subItems": [
        {
          "subItemName": "Mano de Obra",
          "externalPartId": "159753",
          "quantity": null,
          "partUnitPrice": null,
          "availability": null,
          "LaborHours": 0.5,
          "LaborHourPrice": 500,
          "comments": "Balatas Alcon"
        }
      ]
    }
  ]
}

{

success*

boolean

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

message*

string
nullable: true

data*

[

Representa los datos relacionados a la cotización de una Orden de Reparación./ Repair Order’s estimate information.

{

orderNumber*

string

Identificador único de la Orden de Reparación de la cual se obtendrá la cotización. / Repair Order unique identifier.

inspectionItems*

[

Representa los Puntos de Inspección que se van a cotizar en la Orden de Reparación. / Estimate information of the Repair Order’s inspection items.

{

inspectionItemName

string

Nombre del Punto de Inspección. / Inspection Item name.

cmosInspectionItemId

string

Identificador único del Punto de Inspección en la librería maestra de CMOS. / Inspection Item unique identifier in the CMOS master library.

externalInspectionItemId*

string

Identificador único del Punto de Inspección en el sistema de cotizaciones externo. / Inspection Item unique identifier in the external system master library.

quantity

number

Cantidad de artículos que se necesitan de este Punto de Inspección. / Required quantity of the Inspect Item.

partUnitPrice

number

Precio por unidad del artículo en el Punto de Inspección. / Price per unit of the Inspection Item.

availability

number

Cantidad disponible en el inventario del sistema de cotizaciones externo. / Availability in stock.

laborHours

number

Cantidad de horas cotizadas para trabajar en la mano de obra del Punto de Inspección. / Hours worked on the Inspection Item.

laborHourPrice

number

Precio por unidad de hora de mano de obra del Punto de Inspección. / Price per hour worked.

comments

string

approvalStatus

string
example: Approved Rejected Pending

subItems

[
nullable: true

{

subItemName*	string Nombre del sub punto. / Sub item name.
externalPartId*	string Identificador único del sub punto en el sistema de cotizaciones externo. / Sub item unique identifier on the external system.
quantity	number Cantidad disponible en el inventario del sistema de cotizaciones externo. / Required quantity of the sub item.
partUnitPrice	number Precio por unidad del artículo del sub punto. / Price per unit of the sub item
availability	number Cantidad disponible en el inventario del sistema de cotizaciones externo. / Availability on stock.
laborHours	number Cantidad de horas cotizadas para trabajar en la mano de obra del Punto de Inspección./ Hours worked on the sub item.
laborHourPrice	number Precio por unidad de hora de mano de obra del sub punto. / Price per hour.
comments	string Comentarios adicionales sobre el sub punto. Cada comentario adicional debe estar separado por una coma ‘,’/ Additional comments of the sub-item. Any additional comment should be separated by a comma ‘,’

}]

}

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]

}

Obtiene la cotización de una Orden de Reparación

GET

/orders/{orderId}/estimates

Al llamado de este recurso se deben obtener datos relacionados a la cotización de una Orden de Reparación.

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": {
    "orderNumber": "RO123456",
    "InspectionItems": [
      {
        "inspectionItemName": "Correa Transmisión Serpentina",
        "cmosInspectionItemId": "192859128",
        "externalInspectionItemId": "1928375182",
        "quantity": 1,
        "partUnitPrice": 500,
        "availability": 20,
        "laborHours": 1,
        "laborHourPrice": 200,
        "comments": null,
        "approvalStatus": "Pending",
        "subItems": null
      },
      {
        "inspectionItemName": "Servicio 15,000km",
        "cmosInspectionItemId": "123456789",
        "externalInspectionItemId": "987654321",
        "quantity": null,
        "partUnitPrice": null,
        "availability": null,
        "laborHours": null,
        "laborHourPrice": null,
        "comments": "Servicio de 15,000 km",
        "approvalStatus": "Approved",
        "subItems": [
          {
            "subItemName": "Aceite",
            "externalPartId": "159753",
            "quantity": 1,
            "partUnitPrice": 200,
            "availability": 25,
            "laborHours": null,
            "laborHourPrice": null,
            "comments": "Comentario"
          },
          {
            "subItemName": "Filtro",
            "externalPartId": "357951",
            "quantity": 1,
            "partUnitPrice": 400,
            "availability": 34,
            "laborHours": null,
            "laborHourPrice": null,
            "comments": "Aceite de buena marca."
          },
          {
            "subItemName": "Mano de obra",
            "externalPartId": "456735",
            "quantity": 1,
            "partUnitPrice": 500,
            "availability": null,
            "laborHours": null,
            "laborHourPrice": null,
            "comments": "Mano de obra de cambio de aceite."
          }
        ]
      },
      {
        "inspectionItemName": "Espejo Retrovisor",
        "cmosInspectionItemId": "12349876",
        "externalInspectionItemId": "102837529",
        "quantity": null,
        "partUnitPrice": null,
        "availability": null,
        "laborHours": null,
        "laborHourPrice": null,
        "comments": "",
        "approvalStatus": "Rejected",
        "subItems": [
          {
            "subItemName": "Espejo",
            "externalPartId": "159753",
            "quantity": 2,
            "partUnitPrice": 500,
            "availability": 25,
            "laborHours": null,
            "laborHourPrice": null,
            "comments": "Comentario"
          },
          {
            "subItemName": "Mano de obra",
            "externalPartId": "456735",
            "quantity": null,
            "laborHourPrice": null,
            "availability": null,
            "laborHours": 2,
            "labourUnitPrice": 150,
            "comments": "Mano de obra de cambio de aceite."
          }
        ]
      },
      {
        "inspectionItemName": "Cambio Balatas traseras",
        "cmosInspectionItemId": "72817291",
        "externalInspectionItemId": "123499882",
        "quantity": null,
        "partUnitPrice": null,
        "availability": null,
        "laborHours": null,
        "laborHourPrice": null,
        "comments": "",
        "approvalStatus": "Pending",
        "subItems": [
          {
            "subItemName": "Balatas traseras",
            "externalPartId": "159753",
            "quantity": 2,
            "partUnitPrice": 1000,
            "availability": 20,
            "laborHours": 2,
            "laborHourPrice": 500,
            "comments": "Balatas Alcon"
          }
        ]
      },
      {
        "inspectionItemName": "Llanta trasera izquierda",
        "cmosInspectionItemId": "192839288",
        "externalInspectionItemId": "222233434",
        "quantity": 1,
        "partUnitPrice": 2500,
        "availability": null,
        "laborHours": null,
        "laborHourPrice": null,
        "comments": "",
        "approvalStatus": "Approved",
        "subItems": [
          {
            "subItemName": "Mano de Obra",
            "externalPartId": "159753",
            "quantity": null,
            "partUnitPrice": null,
            "availability": null,
            "laborHours": 0.5,
            "laborHourPrice": 500,
            "comments": "Balatas Alcon"
          }
        ]
      }
    ]
  }
}

{

success*

boolean

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

message*

string
nullable: true

data*

[

Representa los datos relacionados a la cotización de una Orden de Reparación./ Repair Order’s estimate information.

{

orderNumber*

string

Identificador único de la Orden de Reparación de la cual se obtendrá la cotización. / Repair Order unique identifier.

inspectionItems*

[

Representa los Puntos de Inspección que se van a cotizar en la Orden de Reparación. / Estimate information of the Repair Order’s inspection items.

{

inspectionItemName

string

Nombre del Punto de Inspección. / Inspection Item name.

cmosInspectionItemId

string

Identificador único del Punto de Inspección en la librería maestra de CMOS. / Inspection Item unique identifier in the CMOS master library.

externalInspectionItemId*

string

Identificador único del Punto de Inspección en el sistema de cotizaciones externo. / Inspection Item unique identifier in the external system master library.

quantity

number

Cantidad de artículos que se necesitan de este Punto de Inspección. / Required quantity of the Inspect Item.

partUnitPrice

number

Precio por unidad del artículo en el Punto de Inspección. / Price per unit of the Inspection Item.

availability

number

Cantidad disponible en el inventario del sistema de cotizaciones externo. / Availability in stock.

laborHours

number

Cantidad de horas cotizadas para trabajar en la mano de obra del Punto de Inspección. / Hours worked on the Inspection Item.

laborHourPrice

number

Precio por unidad de hora de mano de obra del Punto de Inspección. / Price per hour worked.

comments

string

approvalStatus

string
example: Approved Rejected Pending

subItems

[
nullable: true

{

subItemName*	string Nombre del sub punto. / Sub item name.
externalPartId*	string Identificador único del sub punto en el sistema de cotizaciones externo. / Sub item unique identifier on the external system.
quantity	number Cantidad disponible en el inventario del sistema de cotizaciones externo. / Required quantity of the sub item.
partUnitPrice	number Precio por unidad del artículo del sub punto. / Price per unit of the sub item
availability	number Cantidad disponible en el inventario del sistema de cotizaciones externo. / Availability on stock.
laborHours	number Cantidad de horas cotizadas para trabajar en la mano de obra del Punto de Inspección./ Hours worked on the sub item.
laborHourPrice	number Precio por unidad de hora de mano de obra del sub punto. / Price per hour.
comments	string Comentarios adicionales sobre el sub punto. Cada comentario adicional debe estar separado por una coma ‘,’/ Additional comments of the sub-item. Any additional comment should be separated by a comma ‘,’

}]

}

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]

}

Actualiza la cotización de una Orden de Reparación ya existente.

PUT

/orders/{orderId}/estimates

Al llamado de este recurso se deben actualizar los Puntos de Inspección de una Orden de Reparación ya existente con la información que se modificó en CMOS.

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

Formato del cuerpo que se debe enviar desde el cliente para la creación de Puntos de Inspección en una cotización de una Orden de Reparación existente.

Ejemplo
Esquema

				
					{
  "orderNumber": "RO12345",
  "inspectionItems": [
    {
      "inspectionItemName": "Correa Transmisión Serpentina",
      "cmosInspectionItenId": "192859128",
      "externalInspectionItemId": "1928375182",
      "quantity": 1,
      "partUnitPrice": 500,
      "availability": 20,
      "LaborHours": 1,
      "LaborHourPrice": 200,
      "comments": null,
      "approvalStatus": "Pending",
      "subItems": null
    },
    {
      "inspectionItemName": "Retrovisor Delantero Derecho",
      "cmosInspectionItemId": "192856491",
      "externalInspectionItemId": "1928331692",
      "quantity": null,
      "partUnitPrice": null,
      "availability": null,
      "LaborHours": null,
      "LaborHourPrice": null,
      "comments": null,
      "approvalStatus": "Pending",
      "subItems": null
    },
    {
      "inspectionItemName": "Sistema de Refrigeración",
      "cmosInspectionItemId": "192856491",
      "externalInspectionItemId": "1928331692",
      "quantity": null,
      "partUnitPrice": null,
      "availability": null,
      "LaborHours": null,
      "LaborHourPrice": null,
      "comments": null,
      "approvalStatus": "Pending",
      "subItems": [
        {
          "subItemName": "Manguera",
          "externalPartId": "154653",
          "quantity": null,
          "partUnitPrice": null,
          "availability": null,
          "LaborHours": null,
          "LaborHourPrice": null,
          "comments": "Comentario"
        },
        {
          "subItemName": "Líquido Refrigerante",
          "externalPartId": "351391",
          "quantity": null,
          "partUnitPrice": null,
          "availability": null,
          "LaborHours": null,
          "LaborHourPrice": null,
          "comments": "Aceite de buena marca."
        }
      ]
    },
    {
      "inspectionItemName": "Servicio 15,000km",
      "cmosInspectionItemId": "123456789",
      "externalInspectionItemId": "987654321",
      "quantity": null,
      "partUnitPrice": null,
      "availability": null,
      "LaborHours": null,
      "LaborHourPrice": null,
      "comments": "Servicio de 15,000 km",
      "approvalStatus": "Approved",
      "subItems": [
        {
          "subItemName": "Aceite",
          "externalPartId": "159753",
          "quantity": 1,
          "partUnitPrice": 200,
          "availability": 25,
          "LaborHours": null,
          "LaborHourPrice": null,
          "comments": "Comentario"
        },
        {
          "subItemName": "Filtro",
          "externalPartId": "357951",
          "quantity": 1,
          "partUnitPrice": 400,
          "availability": 34,
          "LaborHours": null,
          "LaborHourPrice": null,
          "comments": "Aceite de buena marca."
        },
        {
          "subItemName": "Mano de obra",
          "externalPartId": "456735",
          "quantity": 1,
          "partUnitPrice": 500,
          "availability": null,
          "LaborHours": null,
          "LaborHourPrice": null,
          "comments": "Mano de obra de cambio de aceite."
        }
      ]
    },
    {
      "inspectionItemName": "Espejo Retrovisor",
      "cmosInspectionItemId": "12349876",
      "externalInspectionItemId": "102837529",
      "quantity": null,
      "partUnitPrice": null,
      "availability": null,
      "LaborHours": null,
      "LaborHourPrice": null,
      "comments": "",
      "approvalStatus": "Rejected",
      "subItems": [
        {
          "subItemName": "Espejo",
          "externalPartId": "159753",
          "quantity": 2,
          "partUnitPrice": 500,
          "availability": 25,
          "LaborHours": null,
          "LaborHourPrice": null,
          "comments": "Comentario"
        },
        {
          "subItemName": "Mano de obra",
          "externalPartId": "456735",
          "quantity": null,
          "partUnitPrice": null,
          "availability": null,
          "LaborHours": 2,
          "LaborHourPrice": 150,
          "comments": "Mano de obra de cambio de aceite."
        }
      ]
    },
    {
      "inspectionItemName": "Cambio Balatas traseras",
      "cmosInspectionItemId": "72817291",
      "externalInspectionItemId": "123499882",
      "quantity": null,
      "partUnitPrice": null,
      "availability": null,
      "LaborHours": null,
      "LaborHourPrice": null,
      "comments": "",
      "approvalStatus": "Pending",
      "subItems": [
        {
          "subItemName": "Balatas traseras",
          "externalPartId": "159753",
          "quantity": 2,
          "partUnitPrice": 1000,
          "availability": 20,
          "LaborHours": 2,
          "LaborHourPrice": 500,
          "comments": "Balatas Alcon"
        }
      ]
    },
    {
      "inspectionItemName": "Llanta trasera izquierda",
      "cmosInspectionItemId": "192839288",
      "externalInspectionItemId": "222233434",
      "quantity": 1,
      "partUnitPrice": 2500,
      "availability": null,
      "LaborHours": null,
      "LaborHourPrice": null,
      "comments": "",
      "approvalStatus": "Approved",
      "subItems": [
        {
          "subItemName": "Mano de Obra",
          "externalPartId": "159753",
          "quantity": null,
          "partUnitPrice": null,
          "availability": null,
          "LaborHours": 0.5,
          "LaborHourPrice": 500,
          "comments": "Balatas Alcon"
        }
      ]
    }
  ]
}

{

success*

boolean

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

message*

string
nullable: true

data*

[

Representa los datos relacionados a la cotización de una Orden de Reparación./ Repair Order’s estimate information.

{

orderNumber*

string

Identificador único de la Orden de Reparación de la cual se obtendrá la cotización. / Repair Order unique identifier.

inspectionItems*

[

Representa los Puntos de Inspección que se van a cotizar en la Orden de Reparación. / Estimate information of the Repair Order’s inspection items.

{

inspectionItemName

string

Nombre del Punto de Inspección. / Inspection Item name.

cmosInspectionItemId

string

Identificador único del Punto de Inspección en la librería maestra de CMOS. / Inspection Item unique identifier in the CMOS master library.

externalInspectionItemId*

string

Identificador único del Punto de Inspección en el sistema de cotizaciones externo. / Inspection Item unique identifier in the external system master library.

quantity

number

Cantidad de artículos que se necesitan de este Punto de Inspección. / Required quantity of the Inspect Item.

partUnitPrice

number

Precio por unidad del artículo en el Punto de Inspección. / Price per unit of the Inspection Item.

availability

number

Cantidad disponible en el inventario del sistema de cotizaciones externo. / Availability in stock.

laborHours

number

Cantidad de horas cotizadas para trabajar en la mano de obra del Punto de Inspección. / Hours worked on the Inspection Item.

laborHourPrice

number

Precio por unidad de hora de mano de obra del Punto de Inspección. / Price per hour worked.

comments

string

approvalStatus

string
example: Approved Rejected Pending

subItems

[
nullable: true

{

subItemName*	string Nombre del sub punto. / Sub item name.
externalPartId*	string Identificador único del sub punto en el sistema de cotizaciones externo. / Sub item unique identifier on the external system.
quantity	number Cantidad disponible en el inventario del sistema de cotizaciones externo. / Required quantity of the sub item.
partUnitPrice	number Precio por unidad del artículo del sub punto. / Price per unit of the sub item
availability	number Cantidad disponible en el inventario del sistema de cotizaciones externo. / Availability on stock.
laborHours	number Cantidad de horas cotizadas para trabajar en la mano de obra del Punto de Inspección./ Hours worked on the sub item.
laborHourPrice	number Precio por unidad de hora de mano de obra del sub punto. / Price per hour.
comments	string Comentarios adicionales sobre el sub punto. Cada comentario adicional debe estar separado por una coma ‘,’/ Additional comments of the sub-item. Any additional comment should be separated by a comma ‘,’

}]

}

Respuestas

Code 204

Se ha actualizado la cotización de forma satisfactoria.

Ejemplo
Esquema

				
					Se ha actualizado la cotización de forma satisfactoria. / Successful request.

{

success*

boolean

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

message*

string
nullable: true

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]

}

Obtiene el listado de objetos del sistema de inventarios de un software tercero.

GET

/inventoryItems

Parámetros

organizationId

REQUERIDO

(header)

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

keyword

(query)

Palabra clave para filtrar los artículos a cotizar.

Llantas

make

(query)

Marca del vehículo que se usará para filtrar los artículos.

Honda

model

(query)

Modelo del vehículo que se usará para filtrar los artículos.

Civic

year

(query)

Año del vehículo que se usará para filtrar los artículos.

2019

Cuerpo de solicitud

Sin datos

Respuestas

Code 200

Solicitud completada de forma satisfactoria. La respuesta debe devolver la lista de los objetos en el sistema de inventarios del software tercero.

Ejemplo
Esquema

				
					{
  "success": true,
  "message": null,
  "data": {
    "jobs": [
      {
        "jobName": "Replace Battery",
        "jobId": "J123",
        "parts": [
          {
            "partName": "Battery",
            "partId": "P123",
            "quantity": 1,
            "partUnitPrice": 1500,
            "availability": 20,
            "laborHours": null,
            "laborHourPrice": null,
            "comments": [
              "Battery is almost dead.",
              "Model 123"
            ]
          }
        ],
        "labors": [
          {
            "laborName": "Replace Battery",
            "laborId": "L123",
            "laborHours": 1,
            "labourHourPrice": 350,
            "comments": null
          }
        ]
      }
    ],
    "parts": [
      {
        "partName": "Brake Pads",
        "partId": "P456",
        "quantity": 1,
        "partUnitPrice": 3000,
        "availability": 2,
        "laborHours": 2,
        "laborHourPrice": 250,
        "comments": null
      },
      {
        "partName": "Windshield",
        "partId": "P159",
        "quantity": 1,
        "partUnitPrice": 2500,
        "availability": 5,
        "laborHours": null,
        "laborHourPrice": null,
        "comments": null
      }
    ],
    "labors": [
      {
        "laborName": "Replace Windshield",
        "laborId": "L456",
        "laborHours": 1,
        "labourHourPrice": 450,
        "comments": null
      }
    ]
  }
}

{

success*

boolean

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

message*

string
nullable: true

data*

{

description:

Representa los datos relacionados a los objetos del sistema de inventarios del software tercero./ Information related to the objects in the inventory system of the 3rd party software.

jobs*

[

Listado de trabajos disponibles en el sistema de inventarios del software tercero. / List of available jobs in the inventory system of the 3rd part software

{

description:

Trabajo con partes y/o mano de obra asignados. / Job with parts and/or labor assigned.

jobName*

string

Nombre del trabajo. / Job’s name.

jobId*

string

Identificador único del trabajo en el sistema de inventarios del software tercero. / Job’s unique identifier in the inventory system of the 3rd party software.

parts

[

Listado de partes relacionadas al trabajo. / Part list related to the job.

{

partName*	string Nombre de la parte. / Part’s name.
partId*	string Identificador único de la parte en el sistema de inventarios del software tercero. / Part’s unique identifier in the inventory system of the 3rd party software.
quantity	number Cantidad necesaria de la parte. / Required quantity of the part.
partUnitPrice*	number Precio por unidad de la parte. / Price per unit of the part.
availability*	number Cantidad disponible en el sistema de inventarios del software tercero. / Availability on stock.
laborHours	number Cantidad de horas cotizadas para trabajar en la mano de obra./ Hours worked.
laborHourPrice	number Precio por unidad de hora de mano de obra. / Price per hour.
comments	string Comentarios adicionales sobre la parte. / Additional comments of the part.

}]

labors

[

Listado de manos de obras que se aplicarán en el trabajo. / List of labors that will be made in the job.

{

laborName*	string Nombre de la mano de obra. / Labor name.
laborId*	string Identificador único de la mano de obra. / Labor’s unique identifier.
laborHours	number Cantidad de horas cotizadas para trabajar en la mano de obra./ Hours worked.
laborHourPrice*	number Precio por unidad de hora de mano de obra. / Price per hour.
comments	string Comentarios sobre la mano de obra./ Comments about the labor.

}]

parts*

[

Listado de partes en el sistema de inventarios del software tercero. / Part list in the inventory system of the 3rd party software.

{

partName*	string Nombre de la parte. / Part’s name.
partId*	string Identificador único de la parte en el sistema de inventarios del software tercero. / Part’s unique identifier in the inventory system of the 3rd party software.
quantity	number Cantidad necesaria de la parte. / Required quantity of the part.
partUnitPrice*	number Precio por unidad de la parte. / Price per unit of the part.
availability*	number Cantidad disponible en el sistema de inventarios del software tercero. / Availability on stock.
laborHours	number Cantidad de horas cotizadas para trabajar en la mano de obra./ Hours worked.
laborHourPrice	number Precio por unidad de hora de mano de obra. / Price per hour.
comments	string Comentarios adicionales sobre la parte. / Additional comments of the part.

}]

labors*

[

Listado de manos de obras que se aplicarán en el trabajo. / List of labors that will be made in the job.

{

laborName*	string Nombre de la mano de obra. / Labor name.
laborId*	string Identificador único de la mano de obra. / Labor’s unique identifier.
laborHours	number Cantidad de horas cotizadas para trabajar en la mano de obra./ Hours worked.
laborHourPrice*	number Precio por unidad de hora de mano de obra. / Price per hour.
comments	string Comentarios sobre la mano de obra./ Comments about the labor.

}]

}

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]

}

Obtiene el detalle de un objeto del sistema de inventarios de un software tercero

GET

/inventoryItems/{itemId}

Al llamado de este recurso se debe obtener el detalle del objeto (trabajo, parte o mano de obra) del sistema de inventarios de un software tercero para cotizar dentro de CMOS.

Parámetros

organizationId

REQUERIDO

(header)

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

itemId

REQUERIDO

(path)

Identificador único del objeto en el sistema de inventarios.

B123

Cuerpo de solicitud

Sin datos

Respuestas

Code 200

Solicitud completada de forma satisfactoria. La respuesta debe devolver el dealle del objeto en el sistema de inventarios del software tercero.

Ejemplo
Esquema

				
					{
  "success": true,
  "message": null,
  "data": {
    "jobName": "Replace Battery",
    "jobId": "J123",
    "parts": [
      {
        "partName": "Battery",
        "partId": "P123",
        "quantity": 1,
        "partUnitPrice": 1500,
        "availability": 20,
        "laborHours": null,
        "laborHourPrice": null,
        "comments": [
          "Battery is almost dead.",
          "Model 123"
        ]
      }
    ],
    "labors": [
      {
        "laborName": "Replace Battery",
        "laborId": "L123",
        "laborHours": 1,
        "labourHourPrice": 350,
        "comments": null
      }
    ]
  }
}

{

success*

boolean

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

message*

string
nullable: true

data*

{

description:

Representa los datos relacionados a los objetos del sistema de inventarios del software tercero./ Information related to the objects in the inventory system of the 3rd party software.

jobs*

[

Listado de trabajos disponibles en el sistema de inventarios del software tercero. / List of available jobs in the inventory system of the 3rd part software

{

description:

Trabajo con partes y/o mano de obra asignados. / Job with parts and/or labor assigned.

jobName*

string

Nombre del trabajo. / Job’s name.

jobId*

string

Identificador único del trabajo en el sistema de inventarios del software tercero. / Job’s unique identifier in the inventory system of the 3rd party software.

parts

[

Listado de partes relacionadas al trabajo. / Part list related to the job.

{

partName*	string Nombre de la parte. / Part’s name.
partId*	string Identificador único de la parte en el sistema de inventarios del software tercero. / Part’s unique identifier in the inventory system of the 3rd party software.
quantity	number Cantidad necesaria de la parte. / Required quantity of the part.
partUnitPrice*	number Precio por unidad de la parte. / Price per unit of the part.
availability*	number Cantidad disponible en el sistema de inventarios del software tercero. / Availability on stock.
laborHours	number Cantidad de horas cotizadas para trabajar en la mano de obra./ Hours worked.
laborHourPrice	number Precio por unidad de hora de mano de obra. / Price per hour.
comments	string Comentarios adicionales sobre la parte. / Additional comments of the part.

}]

labors

[

Listado de manos de obras que se aplicarán en el trabajo. / List of labors that will be made in the job.

{

laborName*	string Nombre de la mano de obra. / Labor name.
laborId*	string Identificador único de la mano de obra. / Labor’s unique identifier.
laborHours	number Cantidad de horas cotizadas para trabajar en la mano de obra./ Hours worked.
laborHourPrice*	number Precio por unidad de hora de mano de obra. / Price per hour.
comments	string Comentarios sobre la mano de obra./ Comments about the labor.

}]

parts*

[

Listado de partes en el sistema de inventarios del software tercero. / Part list in the inventory system of the 3rd party software.

{

partName*	string Nombre de la parte. / Part’s name.
partId*	string Identificador único de la parte en el sistema de inventarios del software tercero. / Part’s unique identifier in the inventory system of the 3rd party software.
quantity	number Cantidad necesaria de la parte. / Required quantity of the part.
partUnitPrice*	number Precio por unidad de la parte. / Price per unit of the part.
availability*	number Cantidad disponible en el sistema de inventarios del software tercero. / Availability on stock.
laborHours	number Cantidad de horas cotizadas para trabajar en la mano de obra./ Hours worked.
laborHourPrice	number Precio por unidad de hora de mano de obra. / Price per hour.
comments	string Comentarios adicionales sobre la parte. / Additional comments of the part.

}]

labors*

[

Listado de manos de obras que se aplicarán en el trabajo. / List of labors that will be made in the job.

{

laborName*	string Nombre de la mano de obra. / Labor name.
laborId*	string Identificador único de la mano de obra. / Labor’s unique identifier.
laborHours	number Cantidad de horas cotizadas para trabajar en la mano de obra./ Hours worked.
laborHourPrice*	number Precio por unidad de hora de mano de obra. / Price per hour.
comments	string Comentarios sobre la mano de obra./ Comments about the labor.

}]

}

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]

}

Categoría de documentos: Cotizaciones

Agrega cotización a una Orden de Reparación existente.

POST

/orders/{orderId}/estimates

(header)

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

(path)

Identificador único de una Orden de Reparación.

Formato del cuerpo que se debe enviar desde el cliente para la creación de Puntos de Inspección en una cotización de una Orden de Reparación existente.

Solicitud completada de forma satisfactoria.

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.

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

Obtiene la cotización de una Orden de Reparación

GET

/orders/{orderId}/estimates

(header)

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

(path)

Identificador único de una Orden de Reparación.

Solicitud completada de forma satisfactoria.

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.

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

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

Actualiza la cotización de una Orden de Reparación ya existente.

PUT

/orders/{orderId}/estimates

(header)

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

(path)

Identificador único de una Orden de Reparación.

Formato del cuerpo que se debe enviar desde el cliente para la creación de Puntos de Inspección en una cotización de una Orden de Reparación existente.

Se ha actualizado la cotización de forma satisfactoria.

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.

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

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

Obtiene el listado de objetos del sistema de inventarios de un software tercero.

GET

/inventoryItems

(header)

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

(query)

Palabra clave para filtrar los artículos a cotizar.

(query)

Marca del vehículo que se usará para filtrar los artículos.

(query)

Modelo del vehículo que se usará para filtrar los artículos.

(query)

Año del vehículo que se usará para filtrar los artículos.

Solicitud completada de forma satisfactoria. La respuesta debe devolver la lista de los objetos en el sistema de inventarios del software tercero.

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.

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

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

Obtiene el detalle de un objeto del sistema de inventarios de un software tercero

GET

/inventoryItems/{itemId}

(header)

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

(path)

Identificador único del objeto en el sistema de inventarios.

Solicitud completada de forma satisfactoria. La respuesta debe devolver el dealle del objeto en el sistema de inventarios del software tercero.

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.

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

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

Compañía

Productos

Uso de información