API: GET /inventoryItems/{itemId}

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

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

}

Recepción de vehículos

Cotizaciones

Facturación