{ "info": { "author": "Sharoon Thomas, Openlabs Technologies", "author_email": "info@fulfil.io", "bugtrack_url": null, "classifiers": [ "Development Status :: 6 - Mature", "Environment :: Web Environment", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python :: 2", "Programming Language :: Python :: 3", "Topic :: Internet :: WWW/HTTP :: Dynamic Content", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "Magento Python API\n==================\n\nPython library to connect to Magento Webservices.\n\nUsage\n-----\n\n.. code-block:: python\n\n import magento\n\n url = 'http://domain.com/'\n apiuser = 'user'\n apipass = 'password'\n\n # Create an instance of API\n client = magento.API(url, apiuser, apipass)\n\n # A filter expression as dictionary. \n order_filter = {'created_at':{'from':'2011-09-15 00:00:00'}}\n products = client.product.list(order_filter)\n\n # Get a list of product types\n product_types = client.product_types.list()\n \n # Get a specific product\n sku = 'prod1'\n product = client.product.info(sku)\n\n # Add comment to an order\n order_increment_id = '100000001 '\n status = 'canceled'\n client.order.addcomment(order_increment_id, status)\n\n\nAll available APIs\n-------------------\n\n* Cart (`client.cart`)\n* CartCoupon (`client.cart_coupon`)\n* CartCustomer (`client.cart_customer`)\n* CartPayment (`client.cart_payment`)\n* CartProduct (`client.cart_product`)\n* CartShipping (`client.cart_shipping`)\n* Category (`client.category`)\n* CategoryAttribute (`client.category_attribute`)\n* Country (`client.country`)\n* CreditMemo (`client.credit_memo`)\n* Customer (`client.customer`)\n* CustomerAddress (`client.customer_address`)\n* CustomerGroup (`client.customer_group`)\n* Inventory (`client.inventory`)\n* Invoice (`client.invoice`)\n* Magento (`client.magento`)\n* Order (`client.order`)\n* Product (`client.product`)\n* ProductAttribute (`client.product_attribute`)\n* ProductAttributeSet (`client.product_attribute_set`)\n* ProductConfigurable (`client.product_configurable`)\n* ProductImages (`client.product_images`)\n* ProductLinks (`client.product_links`)\n* ProductTierPrice (`client.product_tier_price`)\n* ProductTypes (`client.product_types`)\n* Region (`client.region`)\n* Shipment (`client.shipment`)\n* Store (`client.store`)\n\nOld deprecated example\n----------------------\n\nThe API was originally written with the requirement to call APIs\nindividually with all the credentials. This led to very verbose code and a\nlot of repitition. While the behavior has not been deprecated, it is\nrecommended to write all new code with the pattern shown in the above\nexample.\n\n.. code-block:: python\n\n import magento\n\n url = 'http://domain.com/'\n apiuser = 'user'\n apipass = 'password'\n\n with magento.Order(url, apiuser, apipass) as order_api:\n order_increment_id = '100000001 '\n status = 'canceled'\n order_api.addcomment(order_increment_id, status)\n\n with magento.Store(url, apiuser, apipass) as store_api:\n store_id = '1'\n store_view_info = store_api.info(store_id)\n store_views = store_api.list()\n\n with magento.Magento(url, apiuser, apipass) as magento_api:\n magento_info = magento_api.info()\n\n\nCalling custom classes from your own API extensions\n---------------------------------------------------\n\nYou can ddirectly invoke the underlying `call` method\nto make calls directly.\n\n.. code-block:: python\n\n result = client.call('custom_model.list', [])\n\n\nAlternatively, you can also build sub classes of API to have\na more pythonic structure. The subclasses are automatically\nregistered with API when classes are created. \n\nTo ensure that they are registered before you create the first API\ninstance, always have all your imports on the top of your magento module.\n\n.. code-block:: python\n\n class CustomModel(API):\n def list(self):\n return self.call('custom_model.list', [])\n\nwhich would be automatically registered as `custom_model` by the API\nmetaclass. So you can now use\n\n.. code-block:: python\n\n import magento\n from my_custom_module import CustomModel\n\n url = 'http://domain.com/'\n apiuser = 'user'\n apipass = 'password'\n\n # Create an instance of API\n client = magento.API(url, apiuser, apipass)\n \n client.custom_model.list()\n\n\nLicense\n-------\n\nBSD 3-Clause\n\nSee LICENSE for more details", "description_content_type": "", "docs_url": "https://pythonhosted.org/magento/", "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/fulfilio/magento/", "keywords": "", "license": "BSD 3-Clause", "maintainer": "", "maintainer_email": "", "name": "magento", "package_url": "https://pypi.org/project/magento/", "platform": "any", "project_url": "https://pypi.org/project/magento/", "project_urls": { "Homepage": "https://github.com/fulfilio/magento/" }, "release_url": "https://pypi.org/project/magento/3.1/", "requires_dist": null, "requires_python": "", "summary": "Magento Core API Client", "version": "3.1" }, "last_serial": 4853680, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "789c640a99926babd0695ad012ba2417", "sha256": "17767b0d93bb694b35e66c4ec15c3f02c94ec1464ba322de9b903f630cd02ac4" }, "downloads": -1, "filename": "magento-0.1.0-py2.6.egg", "has_sig": false, "md5_digest": "789c640a99926babd0695ad012ba2417", "packagetype": "bdist_egg", "python_version": "2.6", "requires_python": null, "size": 16047, "upload_time": "2010-09-20T13:19:04", "url": "https://files.pythonhosted.org/packages/0d/a6/fc343dd6f1410016b456aa2680aae2bdc096757dd55f7e03a6e78316c38a/magento-0.1.0-py2.6.egg" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "81f4b28e49ef83bc0df284f3c1658c30", "sha256": "f59bed3c45653e3e307b3c3bd281702b39da9c1e116236191e0f96f31d4c1330" }, "downloads": -1, "filename": "magento-0.1.1.tar.gz", "has_sig": false, "md5_digest": "81f4b28e49ef83bc0df284f3c1658c30", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6085, "upload_time": "2010-09-22T11:41:10", "url": "https://files.pythonhosted.org/packages/5e/08/a5bd75d83f33fb9e1613b2ceb6442205bf43a81aa6b961f903d129a43bbf/magento-0.1.1.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "1b302f3533db819728a82967857c7e31", "sha256": "f8187d9ee0c97eb5b3e9aa75b8c73d76eef34519f23cd9cb1556b8b01b0efac2" }, "downloads": -1, "filename": "magento-0.1.4.tar.gz", "has_sig": false, "md5_digest": "1b302f3533db819728a82967857c7e31", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8767, "upload_time": "2012-06-21T15:59:33", "url": "https://files.pythonhosted.org/packages/be/31/96c635cffd1e7616ee2d3bf282f44d37ae1dc36646d765a84dc8927eea4d/magento-0.1.4.tar.gz" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "6f91ce85bb0820db9d8b765750b230d9", "sha256": "40326a885523eae90159ec742ec216fb0019812ae666ced0a48db3c55685fb9e" }, "downloads": -1, "filename": "magento-0.2.tar.gz", "has_sig": false, "md5_digest": "6f91ce85bb0820db9d8b765750b230d9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10932, "upload_time": "2013-04-25T17:23:48", "url": "https://files.pythonhosted.org/packages/cf/d8/2d7a4d564c342617b06495698925f14d850c2ce9d61dceb10f2577428663/magento-0.2.tar.gz" } ], "0.3": [ { "comment_text": "", "digests": { "md5": "e8292dfe2e3e21a993b5b9e60a64efdb", "sha256": "09b3751a21c3bcb31b91594ea84d4f3484899c677747b690e138f31a99937331" }, "downloads": -1, "filename": "magento-0.3.tar.gz", "has_sig": false, "md5_digest": "e8292dfe2e3e21a993b5b9e60a64efdb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11110, "upload_time": "2013-05-02T10:36:07", "url": "https://files.pythonhosted.org/packages/5a/31/8f8a0a97f192b92358fa74f6f7c7041494cf6b5b73a1e99d25c64fe5d672/magento-0.3.tar.gz" } ], "0.4": [ { "comment_text": "", "digests": { "md5": "fc66d8641a0c2f66d7a8396ec80aa036", "sha256": "7fa5eebde829382bbe9bffbcc1fa60bc664b147ef33f1c14d9217d1526ee021a" }, "downloads": -1, "filename": "magento-0.4.tar.gz", "has_sig": false, "md5_digest": "fc66d8641a0c2f66d7a8396ec80aa036", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10152, "upload_time": "2013-07-22T15:01:05", "url": "https://files.pythonhosted.org/packages/aa/0b/5c8c329ce12c15553015b5a5a6388ead33d4c301081d28e98090bcc966dc/magento-0.4.tar.gz" } ], "0.6dev": [ { "comment_text": "", "digests": { "md5": "ab62e8ca32fa1b5e83a915568cf8c399", "sha256": "bf447243b2bb9952a79fdbbe536bdc2c1885fd9125668349b182ed950ee59c89" }, "downloads": -1, "filename": "magento-0.6dev.tar.gz", "has_sig": false, "md5_digest": "ab62e8ca32fa1b5e83a915568cf8c399", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13286, "upload_time": "2015-05-18T09:45:40", "url": "https://files.pythonhosted.org/packages/01/d0/1bc189babfba05ee7b8cb4f0017fd5672ea12bc6482541ff398a7a7a8593/magento-0.6dev.tar.gz" } ], "1.0": [ { "comment_text": "", "digests": { "md5": "39f56a03a2b094b6e220978ddf9e4737", "sha256": "f637f7044c7a96e91abb4354cf755a9d9e59adb97c3dab682c3d4d089f821d83" }, "downloads": -1, "filename": "magento-1.0.tar.gz", "has_sig": false, "md5_digest": "39f56a03a2b094b6e220978ddf9e4737", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13285, "upload_time": "2015-05-22T10:36:18", "url": "https://files.pythonhosted.org/packages/1b/bc/e0131cd4ea7b0c231f519611ffaa3f15ae6f09acc745fbb17f1d8f4ace56/magento-1.0.tar.gz" } ], "1.1": [ { "comment_text": "", "digests": { "md5": "1ea59e12b0055a75d3ed1f6e89c56b26", "sha256": "be5a4fe74e675e4b008d329240444eacecb6cb4a600ac0254bd4e27ae1fc39bf" }, "downloads": -1, "filename": "magento-1.1.tar.gz", "has_sig": false, "md5_digest": "1ea59e12b0055a75d3ed1f6e89c56b26", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13461, "upload_time": "2015-10-03T10:51:56", "url": "https://files.pythonhosted.org/packages/03/4a/96a02398d717fe161c59e0d80e0ad73450cd19d3538a7202e1f51b7b268c/magento-1.1.tar.gz" } ], "1.2": [ { "comment_text": "", "digests": { "md5": "ff55bc70da541220f7003d8eefa9e90d", "sha256": "2741765a3dd06d3939bd42990bc2a35fc8576daf7e49239a170a8bde5ae14124" }, "downloads": -1, "filename": "magento-1.2.tar.gz", "has_sig": false, "md5_digest": "ff55bc70da541220f7003d8eefa9e90d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13585, "upload_time": "2015-10-14T14:50:32", "url": "https://files.pythonhosted.org/packages/a6/ba/baa3ac9c024b062dd235792e423720cf106a8d745210c36e187bbe9c7fbe/magento-1.2.tar.gz" } ], "1.3": [ { "comment_text": "", "digests": { "md5": "45360ec10b62929b527ca5fcbdadf2d3", "sha256": "a2f2bffdf850afbdb83f46150adbb1288d1615684c5e1b35934b257d3303efe7" }, "downloads": -1, "filename": "magento-1.3.tar.gz", "has_sig": false, "md5_digest": "45360ec10b62929b527ca5fcbdadf2d3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13637, "upload_time": "2015-10-20T21:30:43", "url": "https://files.pythonhosted.org/packages/c2/0e/b8b59072c430b7abb9f0af94c97ac2509a02eccf243f36fc4da5b57d22a5/magento-1.3.tar.gz" } ], "2.0": [ { "comment_text": "", "digests": { "md5": "cb1fc3453bbef6a6399383d6106dae14", "sha256": "6e58dcff3f45cfba212fdf84b00380ae3785d30b57971b4ade841952325f1923" }, "downloads": -1, "filename": "magento-2.0.tar.gz", "has_sig": false, "md5_digest": "cb1fc3453bbef6a6399383d6106dae14", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13901, "upload_time": "2016-07-25T06:47:46", "url": "https://files.pythonhosted.org/packages/5e/53/13a24b0dd37e2341f94095ca58f3b7c119834e13feb4a266e85d84eb0501/magento-2.0.tar.gz" } ], "2.1": [ { "comment_text": "", "digests": { "md5": "399da7e539d14afb75e5914322824d18", "sha256": "16124c9de28ea5264a965d7619f77fb25ebe8a1516c94aaf070991446878cc70" }, "downloads": -1, "filename": "magento-2.1.tar.gz", "has_sig": false, "md5_digest": "399da7e539d14afb75e5914322824d18", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13886, "upload_time": "2016-07-25T06:54:00", "url": "https://files.pythonhosted.org/packages/fc/f2/38c7da74ced9a4793f58bc7e250f8616fbd531f70302fdfc01f824539fec/magento-2.1.tar.gz" } ], "2.2": [ { "comment_text": "", "digests": { "md5": "6651fb74464bdd4a65ebefdceedd4845", "sha256": "77464d391b537951a9fc1bac0569dd03369ef18762e6f6ac09ff998b23ebb7e8" }, "downloads": -1, "filename": "magento-2.2.tar.gz", "has_sig": false, "md5_digest": "6651fb74464bdd4a65ebefdceedd4845", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14331, "upload_time": "2016-08-17T18:14:06", "url": "https://files.pythonhosted.org/packages/5a/01/60df94e3d891ad098fb0e3aba6e3ccc9ac650c6db8f45cbde4f8955eae1b/magento-2.2.tar.gz" } ], "3.0": [ { "comment_text": "", "digests": { "md5": "31ef8c56b73fb17bcf53ec797eaa85cd", "sha256": "22d93dffec065b634e64441468c0f4c2cd5e49db65f6357e80ab58fa98d0f2a4" }, "downloads": -1, "filename": "magento-3.0.tar.gz", "has_sig": false, "md5_digest": "31ef8c56b73fb17bcf53ec797eaa85cd", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14926, "upload_time": "2017-08-17T06:07:18", "url": "https://files.pythonhosted.org/packages/8e/81/b52c7970434c79088e0ae343da4ddcb76041306959ff78795b08f2b423e1/magento-3.0.tar.gz" } ], "3.1": [ { "comment_text": "", "digests": { "md5": "a21ebbd611deeea38c2346bd9c727679", "sha256": "1b96306a3c0bd544995e89977864c1bda07507c6995b08776e22a0825449794d" }, "downloads": -1, "filename": "magento-3.1.tar.gz", "has_sig": false, "md5_digest": "a21ebbd611deeea38c2346bd9c727679", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15826, "upload_time": "2019-02-22T09:34:17", "url": "https://files.pythonhosted.org/packages/63/04/d4143b7a7dfb0a54b864de91634c4bf89e757f8cf1ce5d1b1f33dbf86cb2/magento-3.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "a21ebbd611deeea38c2346bd9c727679", "sha256": "1b96306a3c0bd544995e89977864c1bda07507c6995b08776e22a0825449794d" }, "downloads": -1, "filename": "magento-3.1.tar.gz", "has_sig": false, "md5_digest": "a21ebbd611deeea38c2346bd9c727679", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15826, "upload_time": "2019-02-22T09:34:17", "url": "https://files.pythonhosted.org/packages/63/04/d4143b7a7dfb0a54b864de91634c4bf89e757f8cf1ce5d1b1f33dbf86cb2/magento-3.1.tar.gz" } ] }