my-magento 2.1.0

Python Magento 2 REST API Wrapper

A Python package that wraps and extends the Magento 2 REST API

Explore the docs »

About MyMagento

What’s MyMagento?

MyMagento is a highly interconnected package that wraps and extends the Magento 2 REST API, providing a more intuitive and user-friendly interface to access and update your store.

MyMagento simplifies interaction with the Magento 2 REST API

If you’ve worked with the Magento 2 API, you’ll know that not all endpoints are created equally.

MyMagento aims to streamline your workflow by simplifying a variety of commonly needed API operations.

Main Components

The Client

• Handles all API interactions

• Supports multiple store views

• Provides access to all other package components

The SearchQuery and Subclasses

• execute() a predefined or custom search query on any endpoint

• Simplified creation of basic and advanced searches using REST endpoints

The Model Subclasses

• Wrap all API responses in the package

• Provide additional endpoint-specific methods to retrieve and update data

Available Endpoints

The following endpoints are currently wrapped with a Model and SearchQuery subclass

Endpoint	Client Attribute	SearchQuery Subclass	Model Subclass
orders	Client.orders	OrderSearch		Order
orders/items	Client.order_items	OrderItemSearch		OrderItem
invoices	Client.invoices	InvoiceSearch		Invoice
products	Client.products	ProductSearch		Product
products/attributes	Client.product_attributes	ProductAttributeSearch		ProductAttribute
categories	Client.categories	CategorySearch		Category

…

Installation

Installing MyMagento

To install using pip:

pip install my-magento

Please note that MyMagento requires Python >= 3.10

Documentation

Full documentation can be found on ReadTheDocs

…

QuickStart: Login with MyMagento

💡 Tip
See logging-in for full details on generating an access token

Setting the Login Credentials

The credentials of your Magento 2 admin account are used to initialize and authenticate() a Client

>> domain = 'website.com'
>> username ='username'
>> password = 'password'

If you’re using a local installation of Magento, your domain should look like this:

>> domain = '127.0.0.1/path/to/magento'

Getting a Client

MyMagento uses the Client in one of two ways

Method 1: Initialize a Client

from magento import Client

>>> api = Client(domain, username, password)

|[ MyMagento | website_username ]|:  Authenticating username on website.com...
|[ MyMagento | website_username ]|:  Logged in to username

Method 2: Initialize a Client with get_api()

The get_api() method uses the same keyword arguments as the Client, but will try using environment variable values if the domain, username, or password are missing

import magento

>>> api = magento.get_api()

|[ MyMagento | website_username ]|:  Authenticating username on website.com...
|[ MyMagento | website_username ]|:  Logged in to username

Now let’s start interacting with the api