Apikey

Ultima actualización: Octubre 23, 2024

General

Este método muestra las existencias de productos, en base al valor de búsqudeda que se indique.

Para realizar los procesos es necesario enviar los datos necesarios para cada uno al sitio de servicios web. Los datos para el envío son los siguentes:

Metodo: POST
Url: http://localhost/wservices/ *
Content-Type: application/json
*La URL puede variar

Metodos

Existencia

Este método devuelve un listado de existencias de los productos de acuerdo a la coincidencia del valor de búsqueda que se envía.

En el campo search se coloca una cadena para hacer la búsqueda de existencia, de igual forma puedes filtrar por sucursal y almacen, puedes agregarle el campo solo_existencia que de manera predeterminada es verdadero, si colocas falso traera todos los productos sin importar si cuentan con existencia o no. La consulta se realiza por:

  • Clave
  • Calve corta
  • Código de barras
  • Descripción
  • Descripción corta
y se excluyen los registros con estado BA = Baja

Obtener existencia
{
    "apikey": "a4175ffe0381c37e756132c41a8b05d8",
    "provider": "Producto",
    "action": "Existencia",
    "data": {
    	"filtros":{
            "search":"0000000003",
            "sucursal":"",
            "almacen":"",
            "solo_existencia":true
        }
    }
}
Respuesta del servicio

Si el cliente se pudo procesar con existo se te devolvera una respuesta como la siguiente:

{
    "type": "info",
    "code": "200",
    "message": "Consulta realizada correctamente",
    "data": {
        "productos": [
            {
                "clave": "0000000003",
                "clave_corta": "000003",
                "descripcion": "SILICON LIQUIDO BARRILITO 100MG",
                "descripcion_corta": "SILICON LIQUIDO BARRILITO 100M",
                "codigo_barras": "7501214908371",
                "precio": "22",
                "imagen": "images/?dbid=a4175ffe0381c37e756132c41a8b05d8&objeto=PRODUCTO&id=0000&clave=0000000003",
                "existencia": [
                    {
                        "sucursal": {
                            "clave": "0001",
                            "descripcion": "Papeleria"
                        },
                        "almacen": {
                            "clave": "0001",
                            "descripcion": "ALMACEN GENERAL"
                        },
                        "talla": {
                            "clave": "00",
                            "descripcion": "SIN TALLA"
                        },
                        "color": {
                            "clave": "00",
                            "descripcion": "SIN COLOR"
                        },
                        "cantidad_1": 58,
                        "unidad_1": "PZ",
                        "cantidad_2": 58,
                        "unidad_2": "PZ",
                        "precio": 22
                    },
                    {
                        "sucursal": {
                            "clave": "0001",
                            "descripcion": "Papeleria"
                        },
                        "almacen": {
                            "clave": "0002",
                            "descripcion": "Bodega 2"
                        },
                        "talla": {
                            "clave": "00",
                            "descripcion": "SIN TALLA"
                        },
                        "color": {
                            "clave": "00",
                            "descripcion": "SIN COLOR"
                        },
                        "cantidad_1": 30,
                        "unidad_1": "PZ",
                        "cantidad_2": 30,
                        "unidad_2": "PZ",
                        "precio": 22
                    },
                    {
                        "sucursal": {
                            "clave": "0001",
                            "descripcion": "Papeleria"
                        },
                        "almacen": {
                            "clave": "TRAN",
                            "descripcion": "EN TRANSITO"
                        },
                        "talla": {
                            "clave": "00",
                            "descripcion": "SIN TALLA"
                        },
                        "color": {
                            "clave": "00",
                            "descripcion": "SIN COLOR"
                        },
                        "cantidad_1": 2,
                        "unidad_1": "PZ",
                        "cantidad_2": 2,
                        "unidad_2": "PZ",
                        "precio": 22
                    }
                ]
            }
        ]
    }
}

En el campo Existencia se desglosa la existencia del producto por sucursal y almacén o almacenes si fuera el caso. Considerar la configuración de la variable <PKT_MOSTRAR_PRODUCTOS_SIN_EXISTENCIA>.

Si ocurrio algún error el servicio respondera con el código y detalle del error:

{
    "type": "error",
    "code": "404",
    "message": "Detalle del mensaje de error"
}

GetProductoExistencia

Este método devuelve un listado de existencias de los productos de acuerdo a la coincidencia del valor de búsqueda que se envía.

Puedes agregarle el campo con_existencia que de manera predeterminada es verdadero, si colocas falso traera todos los productos sin importar si cuentan con existencia o no. Se puede filtrar por los siguientes parametros:

  • categoria
  • departamento
  • marca
  • linea
  • familia
  • subfamilia
  • descripcion
  • estado
  • sucursal
  • almacen
y se excluyen los registros con estado BA = Baja

Obtener existencia
{
    "apikey":"YOUR_APIKEY",
    "provider":"producto",
    "action":"GetProductoExistencia",
    "data":{
        "registros":100
    }
}
Respuesta del servicio

Si el cliente se pudo procesar con existo se te devolvera una respuesta como la siguiente:

{
    "type": "info",
    "code": "200",
    "message": "Consulta realizada correctamente",
    "data": {
        "producto": [
            {
                "clave": "0000000006",
                "clave_corta": "000006",
                "descripcion": "Chamarra Niño",
                "descripcion_corta": "Chamarra Niño",
                "descripcion_ampliada": "",
                "codigo_barras": "9900000600006",
                "tipo": "01",
                "unidad": "PZ",
                "unidad_control_1": "PZ",
                "unidad_control_2": "PZ",
                "categoria": {
                    "clave": "0000",
                    "descripcion": "SIN CATEGORIA"
                },
                "departamento": {
                    "clave": "0003",
                    "descripcion": "Ropa"
                },
                "marca": {
                    "clave": "0000",
                    "descripcion": "SIN MARCA"
                },
                "linea": {
                    "clave": "0000",
                    "descripcion": "SIN LINEA"
                },
                "familia": {
                    "clave": "0000",
                    "descripcion": "SIN FAMILIA"
                },
                "subfamilia": {
                    "clave": "0000",
                    "descripcion": "SIN SUB-FAMILIA"
                },
                "existencia": [
                    {
                        "sucursal": {
                            "clave": "0001",
                            "descripcion": "Central Tzucacab"
                        },
                        "almacen": {
                            "clave": "0001",
                            "descripcion": "Almacen general"
                        },
                        "talla": {
                            "clave": "01",
                            "descripcion": "Chica"
                        },
                        "color": {
                            "clave": "01",
                            "descripcion": "Blanco"
                        },
                        "cantidad_1": 4,
                        "unidad_1": "PZ",
                        "cantidad_2": 4,
                        "unidad_2": "PZ"
                    },
                    {
                        "sucursal": {
                            "clave": "0001",
                            "descripcion": "Central Tzucacab"
                        },
                        "almacen": {
                            "clave": "0001",
                            "descripcion": "Almacen general"
                        },
                        "talla": {
                            "clave": "01",
                            "descripcion": "Chica"
                        },
                        "color": {
                            "clave": "02",
                            "descripcion": "Azul"
                        },
                        "cantidad_1": 7,
                        "unidad_1": "PZ",
                        "cantidad_2": 7,
                        "unidad_2": "PZ"
                    }
                ],
                "estatus": "AC"
            },
            {
                "clave": "0000000007",
                "clave_corta": "000007",
                "descripcion": "Chamarra niña",
                ...
            }
        ],
        "registros": 17
    }
}

En el campo Existencia se desglosa la existencia del producto por sucursal y almacén o almacenes si fuera el caso.

Si ocurrio algún error el servicio respondera con el código y detalle del error:

{
    "type": "error",
    "code": "404",
    "message": "Detalle del mensaje de error"
}

Otros

Por el momento no hay mas métodos disponibles, estos se estarán actualizando con el tiempo. Si consideras que hace falta algún método, envía un mensaje a dev@mproerp.com y se analizará la posibilidad de agregarlo al servicio web.