Operación alta_pricelist

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.

• La empresa exista y el usuario tenga permisos sobre esa 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.

  • description : descripción para la nueva lista de precios, hasta 100 caracteres.

  • default_currency_id : identificador que corresponde a la moneda de la lista de precios. Por ejemplo, 3 Pesos, 1 Dólares, 2 Euros.

• Parámetros opcionales:
  • idPricelistADuplicar :  completar con el id de una lista de precios existente si se quiere duplicar o copiar la lista.

Solicitud

{
	"auth": {
		"usuario": "USR_API", //Ingresar el usuario dado de alta en dev.colppy.com
		"password": "PWD_USR_API" //Contraseña en MD5 de usuario de dev.colppy.com
	},
	"service": {
		"provision": "PriceList",
		"operacion": "alta_pricelist"
	},
	"parameters": {
		"sesion": {
			"usuario": "USR_COLPPY", //Ingresar el usuario que tiene acceso a la empresa en Colppy
			"claveSesion": "PWD_USR_COLPPY" // Ingresar la clave devuelta por la operación iniciar_sesion
		},
		"idEmpresa": 131168995,
		"description": "Lista de Precios en Pesos",
		"default_currency_id": 3
	}
}

Respuesta

{
    "service": {
        "provision": "PriceList",
        "operacion": "alta_pricelist",
        "version": "1_0_0_0",
        "response_date": "2020-06-21 20:39:05"
    },
    "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": {
                "company_id": 131168995,
                "description": "Lista de Precios en Pesos",
                "default_currency_id": 3,
                "updated_at": "2020-06-21 20:39:04",
                "created_at": "2020-06-21 20:39:04",
                "id": 14615
            }
        }
    }
}

Mensajes de Error

Si hay un problema con la solicitud/request, en el result, pueden venir los siguientes estados:

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

Mensajes de Validación

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

• "La empresa 123456 no pertenece al usuario USR_COLPPY." Este error indica que falta completar el idEmpresa o que la empresa no pertenece al usuario.

• "El campo default currency id es obligatorio <br /> La moneda seleccionada no corresponde a esta empresa." Este error indica que no se completó el campo default_currency_id o que la moneda no es un id de moneda válido.
• "El campo Nombre es obligatorio." Este error indica que el campo description es obligatorio.
• "El elemento description ya está en uso." Este error indica que ya existe una lista de precios con esa descripción.