Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

Version 1 Next »

Comprobaciones

Para poder ejecutar la operación, se debe comprobar que:

  • La sesión sea válida. La sesión es válida si está activa, lo que implica que se inició sesión con un usuario existente en Colppy.

  • El usuario tenga permisos sobre la empresa.

  • Se deben completar los parámetros:

    • idEmpresa : número entero que corresponde al id de la empresa para la cual impactará la operación.

    • idPriceList : (opcional) número entero que corresponde al id de la lista de precios que se va a listar. 

Operación para leer una Lista de Precios

Solicitud leer_pricelist (con idPriceList)
{
    "auth": {
        "usuario": "ColppyAPI",
        "password": "9410c05b7bfadea3ab7b573180862222"
    },
   	"service": {
		"provision": "PriceList",
		"operacion": "leer_pricelist"
	},
	"parameters": {
	  	"sesion":{
			"usuario": "demopmf@colppy.com",
			"claveSesion": "b7a653479bedd740627b5bc68949da3e"
	  		
	  	},
		"idEmpresa":131168995,
        "idPriceList" : 14613		
	}
}

Respuesta exitosa para leer una Lista de Precios 

Respuesta leer_pricelist (con idPriceList) 
{
    "service": {
        "provision": "PriceList",
        "operacion": "leer_pricelist",
        "version": "1_0_0_0",
        "response_date": "2020-11-17 18:51:02"
    },
    "result": {
        "estado": 0,
        "mensaje": "La operaci�n se realiz� correctamente"
    },
    "response": {
        "success": true,
        "message": "La operación se realizó con éxito.",
        "data": {
            "success": true,
            "code": 200,
            "message": "OK",
            "data": {
                "id": 14613,
                "company_id": 131168995,
                "description": "Lista 1",
                "default_currency_id": 3,
                "is_disabled": 0,
                "created_at": "2020-06-19 17:52:16",
                "updated_at": "2020-06-19 17:52:17",
                "deleted_at": null,
                "pesos": true
            }
        }
    }
}


Operación para leer todas las Listas de Precios

Solicitud leer_pricelist (todas)
{
    "auth": {
        "usuario": "USUARIO_API", //Ingresar el usuario dado de alta en dev.colppy.com
        "password": "USUARIO_API_PASSWORD" //Contraseña en MD5 de usuario de dev.colppy.com
    },
   	"service": {
		"provision": "PriceList",
		"operacion": "leer_pricelist"
	},
	"parameters": {
	  	"sesion":{
			"usuario":  "USUARIO_EMPRESA", //Ingresar el usuario que tiene acceso a la empresa en Colppy
            "claveSesion": "USUARIO_SESION_EMPRESA" //Ingresar la clave devuelta por la operación iniciar_sesion
	  		
	  	},
		"idEmpresa":131168995	
	
	}
}

Respuesta de exitosa para leer todas las Listas de Precios

Respuesta leer_pricelist (todas) 
{
    "service": {
        "provision": "PriceList",
        "operacion": "leer_pricelist",
        "version": "1_0_0_0",
        "response_date": "2020-11-17 18:47:12"
    },
    "result": {
        "estado": 0,
        "mensaje": "La operaci�n se realiz� correctamente"
    },
    "response": {
        "success": true,
        "message": "La operación se realizó con éxito.",
        "data": {
            "success": true,
            "code": 200,
            "message": "OK",
            "data": {
                "current_page": 1,
                "data": [
                    {
                        "id": 14613,
                        "company_id": 131168995,
                        "description": "Lista 1",
                        "default_currency_id": 3,
                        "is_disabled": 0,
                        "created_at": "2020-06-19 17:52:16",
                        "updated_at": "2020-06-19 17:52:17",
                        "deleted_at": null,
                        "iso": "ARS"
                    },
                    {
                        "id": 14614,
                        "company_id": 131168995,
                        "description": "Lista de precios en Pesos 1",
                        "default_currency_id": 3,
                        "is_disabled": 0,
                        "created_at": "2020-06-21 20:36:37",
                        "updated_at": "2020-06-22 01:43:07",
                        "deleted_at": null,
                        "iso": "ARS"
                    },
                    {
                        "id": 14615,
                        "company_id": 131168995,
                        "description": "Lista de precios en Pesos 2",
                        "default_currency_id": 3,
                        "is_disabled": 0,
                        "created_at": "2020-06-21 20:39:04",
                        "updated_at": "2020-06-22 01:43:23",
                        "deleted_at": null,
                        "iso": "ARS"
                    },
                    {
                        "id": 14616,
                        "company_id": 131168995,
                        "description": "Lista de precios en Pesos 3",
                        "default_currency_id": 3,
                        "is_disabled": 0,
                        "created_at": "2020-06-22 01:05:21",
                        "updated_at": "2020-06-22 01:43:51",
                        "deleted_at": null,
                        "iso": "ARS"
                    },
                    {
                        "id": 14617,
                        "company_id": 131168995,
                        "description": "Lista de precios en Pesos 4",
                        "default_currency_id": 3,
                        "is_disabled": 0,
                        "created_at": "2020-06-22 01:19:02",
                        "updated_at": "2020-06-22 01:43:57",
                        "deleted_at": null,
                        "iso": "ARS"
                    }
                ],
                "from": 1,
                "last_page": 1,
                "next_page_url": null,
                "path": "https://benjamin-test.colppy.com//api/v1/pricelist",
                "per_page": "50",
                "prev_page_url": null,
                "to": 5,
                "total": 5
            }
        }
    }
}

Errores posibles

Si hay un problema con la solicitud orequest, la respuesta o result puede devolver los siguientes códigos de error:

  • "estado" : 501, "mensaje" : 
    "Los datos enviados no corresponden a un valor JSON válido"

Si se pudo ejecutar la petición, pero hay problemas con los datos, el response va a indicar "success" : false, y los siguientes mensajes:

  • "La empresa 13116899 no pertenece al usuario USUARIO_EMPRESA". 
    Este error indica que falta completar el idEmpresa o que la empresa no pertenece al usuario.
  • "La lista de precios no corresponde a la empresa seleccionada. <br /> El id seleccionado no existe en la lista de precios." 
    Este error indica que el idPriceList no pertenece a la empresa.


  • No labels