Parámetro | Valor |
|---|---|
Nombre servicio | createProduct |
Tipo método | POST |
URL | https://gorgeous-dust-0seusmuxapkp.vapor-farm-b1.com/api/auth/products/createProduct |
Content type | application/json |
Post/createProduct
Servicio utilizado para la creación de productos que permite la identificación de los mismos en los formularios de ingreso.
Parámetros de consulta
Parámetro Post | Tipo | Longitud | Obligatorio | Descripción |
|---|---|---|---|---|
code_product | string | 150 | Si | Identificación interna del producto |
code_subheading | string | 80 | Si | Código de la subpartida |
convertion_factor_product | float | Si | Factor de conversión equivalente a la unidad de medida ingresado | |
description_product | text | Si | Descripción del producto creado | |
group_product | string | 80 | Si | Grupo al cual pertenece un producto |
businessUnit_id | integer | Si | Id de la unidad de medida | |
subheading_id | integer | Si | Id de la subpartida |
Importante: Para conocer el id interno de la subpartida y de la unidad de medida creada, se debe consumir los servicios getSubheadingProduct y getUnitQualifiedUser. De los cuales explicaremos más adelante.
Ejemplo:
Cuerpo de la petición
{
"subheading_id": 1, "businessUnit_id":67, "code_product":"ACT-10", "description_product":"Actaminofen por 10", "convertion_factor_product":"2", "group_product":"Analgésicos"
}
Respuesta
{
"status": {
"code": 200,
"message": "Procesado con éxito",
"data": {
"id": 430,
"qualifiedUser_id": 214,
"subheading_id": 1,
"businessUnit_id": 67,
"code_product": "ACT-10",
"description_product": "Actaminofen por 10",
"convertion_factor_product": "2",
"group_product": "Analgésicos",
"tracking": null,
"status_product": 1
}
}
}
3.1 Consultar id de la unidad de medida
Para conocer el id con que se relaciona la unidad de medida creada, hay que consultar el servicio getUnitQualifiedUser
Parámetro | Valor |
|---|---|
Nombre servicio | getUnitQualifiedUser/{#code_unit_measuement} |
Tipo método | GET |
URL | https://gorgeous-dust-0seusmuxapkp.vapor-farm-b1.com/api/auth/getUnitQualifiedUser/{#code_unit_measuement} |
Content type | application/json |
GET/getUnitQualifiedUser/{#code_unit_measuement}
Se envía el parámetro por medio de la URL, en este caso el código de la unidad de medida que queremos consultar.
Ejemplo:
Se creó la unidad de medida T10, para conocer el id interno, invocamos el endpoint getUnitQualifiedUser, y por parámetro se le pasa el código de la unidad de medida, es importante enviar dicho código tal cual como fue creado inicialmente.
https://gorgeous-dust-0seusmuxapkp.vapor-farm-b1.com/api/auth/getUnitQualifiedUser/T10
Respuesta:
{
"status": {
"code": 200,
"message": "Procesado con éxito",
"data": {
"id": 10
}
}
}
Si la unidad no se identifica, se obtendrá el siguiente resultado
{
"status": {
"code": 400,
"message": "No existe la unidad de medida para el usuario calificado."
}
}
3.2 Consultar subpartidas
Para conocer el id interno de la subpartida, utilizaremos el método getSubheadingProduct el cual, por parámetro le enviaremos la subpartida que queremos consultar y retornará el id y la unidad comercial que le corresponde.
Parámetro | Valor |
|---|---|
Nombre servicio | getSubheadingProduct/{#subpartida} |
Tipo método | GET |
URL | https://gorgeous-dust-0seusmuxapkp.vapor-farm-b1.com/api/auth/getSubheadingProduct /{#subpartida} |
Content type | application/json |
GET/getSubheadingProduct/{#subpartida}
Se envía el parámetro por medio de la URL, en este caso el código de la subpartida que queremos consultar.
Respuesta:
El servicio retorna dos variables que son, el id interno de la subpartida y la unidad comercial que la relaciona.
{
"status": {
"code": 200,
"message": "Procesado con éxito",
"data": {
"id": 152,
"code_businessUnit": "KG"
}
}
}
3.3 Actualizar productos
Para actualizar productos se utilizará el servicio updateProduct