...
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.Se puede consultar todos los productos creados hasta el momento mediante el método getProducts
Parámetro
Valor
Nombre servicio
updateProduct
Tipo método
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
getProducts | |
Tipo método | POST |
URL | https://gorgeous-dust-0seusmuxapkp.vapor-farm-b1.com/api/auth/ |
getProducts | |
Content type | application/json |
...
Parámetro
...
Tipo
...
Longitud
...
Obligatorio
...
Descripción
...
code_product
...
string
...
150
...
si
...
Identificación interna del producto
...
id
...
integer
...
Si
...
id del producto
...
convertion_factor_product
...
float
...
no
...
Factor de conversión equivalente a la unidad de medida ingresado
...
description_product
...
text
...
no
...
Descripción del producto creado
...
group_product
...
string
...
80
...
no
...
Grupo al cual pertenece un producto
...
businessUnit_id
...
integer
...
no
...
Id de la unidad de medida
...
subheading_id
...
integer
...
no
...
Id de la subpartida
Para realizar la actualización, como se ve en la tabla anterior, el campo id, es el requerido, por lo demás se puede actualizar solo el campo que nos interesa.
En el siguiente ejemplo, se actualizará el nombre del producto Acetaminofén por 10.
Ejemplo:
Cuerpo de la petición
{
"id": 430,
"code_product": "ACT-10",
"description_product":"Acetaminofén por 10"
}
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": "Acetaminofén por 10",
"convertion_factor_product": "2",
"group_product": "Analgésicos",
"tracking": null,
"status_product": 1
}
}
}
3.4 Consultar productos
Se puede consultar todos los productos creados hasta el momento mediante el método getProducts
...
Parámetro
...
Valor
...
Nombre servicio
...
getProducts
...
Tipo método
...
GET
...
URL
...
https://gorgeous-dust-0seusmuxapkp.vapor-farm-b1.com/api/auth/getProducts
...
Content type
...
application/json
GET/getProducts
Respuesta:
{
"status": {
"code": 200,
"message": "Procesado con éxito",
"data": {
"current_page": 1,
"data": [
{
"id": 354,
"code_product": "BH-080",
"description_product": "Parlantes",
de búsqueda
Parámetro | Descripción |
|---|---|
search | Parámetro de búsqueda, puede buscar por descripción del producto, código de producto y subpartida. |
POST/getProducts
Respuesta:
| Bloque de código |
|---|
{ "status": { "code": 200, "message": "Procesado con éxito", "data": { "current_page": 1, "data": [ { "code_product": "0MTT1943", "typeProduct_id": "Insumos", "description_product": "0MTT1943 RETREFLECTIV SENSOR RF BOS18KF-PA-1QDC02", "convertion_factor_product": " |
...
1", |
...
"group_product": |
...
"REPUESTO", "subheading_id": |
...
"8422900000", "nit_qualified": " |
...
8020193394", |
...
"name_qualified": |
...
"ADAMA ANDINA B.V SUCURSAL COLOMBIA.", "businessUnit_id": "U", "unit_measurement": "Unidad o artículo 1", |
...
"nickname_qualified": |
...
null, "status_product": 1, |
...
"decimal_values_precision": "4 |
...
", "tracking": null }, { "code_product": "LH194321", "typeProduct_id": "Insumos", "description_product": |
...
"LH194321 PARAXONE 200 SL UPL BIDON X 1 LT", "convertion_factor_product": " |
...
1.08", "group_product": " |
...
UPL", |
...
"subheading_id": |
...
"3808931900", "nit_qualified": " |
...
8020193394", |
...
"name_qualified": |
...
"ADAMA ANDINA B.V SUCURSAL COLOMBIA.", "businessUnit_id": |
...
"U", "unit_measurement": |
...
"Unidad o artículo 1", "nickname_qualified": |
...
null, "status_product": 1, |
...
"decimal_values_precision": "4 |
...
", "tracking": null } ], "first_page_url": " |
...
http:// |
...
127.0.0.1:8000/api/auth/products/getProducts?page= |
...
1", "from": 1, |
...
"last_page": 1, |
...
"last_page_url": " |
...
http:// |
...
127.0.0.1:8000/api/auth/products/getProducts?page= |
...
1", "links": |
...
[ { "url": null, |
...
"label": " |
...
« Anterior", |
...
"active": |
...
false }, { "url": " |
...
http:// |
...
127.0.0.1:8000/api/auth/products/getProducts?page= |
...
1", "label": "1", |
...
"active": |
...
true }, { "url": null, |
...
"label": "Siguiente |
...
»", "active": |
...
false } ], "next_page_url": null, |
...
"path": " |
...
http:// |
...
127.0.0.1:8000/api/auth/products/ |
...
getProducts", "per_page": 25, |
...
"prev_page_url": null, |
...
"to": 2, |
...
"total": |
...
2 } } } |