MyMagento🛒

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

https://static.pepy.tech/personalized-badge/my-magento?period=total&units=none&left_color=grey&right_color=blue&left_text=Downloads

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 search query on any endpoint Intuitive interface for Building Custom Search Queries All predefined methods retrieve data using only 1-2 API requests

🧠 The `Model` Subclasses
Wrap all API responses in the package Provide additional endpoint-specific methods to retrieve and update data

...

Available Endpoints

MyMagento is compatible with every API endpoint

Endpoints are wrapped with a Model and SearchQuery subclass as follows:

Endpoint	Client Shortcut	`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`
`customers`	`Client.customers`	`CustomerSearch`	`Customer`
`endpoint`	`Client.search('endpoint')`	`SearchQuery`	`APIResponse`

...

⚙ 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

MyMagento uses the Client class to handle all interactions with the API.

💡 Tip
See Get a Magento 2 REST API Token With MyMagento for full details on generating an access token

Setting the Login Credentials

To generate an ACCESS_TOKEN you'll need to authenticate() your USER_CREDENTIALS.

Creating a Client requires a domain, username, and password at minimum.

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

If you're using a local installation of Magento you'll need to set local=True. Your domain should look like this:

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

...

Getting a `Client`

Option 1: Initialize a `Client` Directly

from magento import Client

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

Option 2: Call `get_api()`

import magento

>>> api = magento.get_api(**kwargs)

get_api() takes the same keyword arguments as the Client

If the domain, username, or password are missing, it will attempt to use the following environment variables:

import os

os.environ['MAGENTO_DOMAIN'] = domain
os.environ['MAGENTO_USERNAME']= username
os.environ['MAGENTO_PASSWORD']= password

...

Getting an `ACCESS_TOKEN`

Unless you specify login=False, the Client will automatically call authenticate() once initialized:

>> api.authenticate()

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

Performing a `search()`

The Client.search() method lets you execute() a query on any API endpoint

It creates a SearchQuery for the endpoint, allowing you to retrieve data about

An individual item (ex. by_id())
A list of items (ex. by_list())
Any search criteria you desire (see Building Custom Search Queries)

...

Example: `search()` an endpoint `by_id()`

# Query the "invoices" endpoint (also: api.invoices)
>>> api.search("invoices").by_id(1)

<Magento Invoice: "#000000001"> for <Magento Order: "#000000001" placed on 2022-11-01 03:27:33>

Example: `search()` an endpoint `by_list()`

# Retrieve invoices from a list of invoice ids
>>> ids = list(range(1,101))
>>> api.invoices.by_list("entity_id", ids)

[<Magento Invoice: "#000000001"> for <Magento Order: "#000000001" placed on 2022-11-01 03:27:33>, ...]

...

Search Results: The `Model` Classes

The result of any SearchQuery will be parsed and wrapped by a Model class in the magento.models subpackage.

These classes make the API response data easier to work with.

They also provide endpoint-specific methods to update store data and search for related items.

Example: Retrieving every `Order` containing a `Product`

Let's retrieve a Product using by_sku()

>>> product = api.products.by_sku("24-MB01")

We can search for orders containing this product in multiple ways:

# Using the Product itself
>>> product.get_orders()

[<Magento Order: "#000000003" placed on 2022-12-21 08:09:33>, ... ]

# Using an OrderSearch
>>> api.orders.by_product(product)
>>> api.orders.by_product_id(product.id)
>>> api.orders.by_sku(product.sku)

[<Magento Order: "#000000003" placed on 2022-12-21 08:09:33>, ... ]

Example: Retrieving all `Product`s and `Invoice`s for a `Category`

>>> category = api.categories.by_name("Watches")
>>> category.get_products()
>>> category.get_invoices()

[<Magento Product: 24-MG04>, <Magento Product: 24-MG01>, <Magento Product: 24-MG03>, ... ]
[<Magento Invoice: "#000000004"> for <Magento Order: "#000000004" placed on 2022-11-14 03:27:33>, ... ]

Example: Updating the Thumbnail `MediaEntry` of a `Product`

 # Update product thumbnail label on specific store view
>>> product.thumbnail.set_alt_text("bonjour", scope="FR")
>>> print(product.thumbnail)

 <MediaEntry 3417 for <Magento Product: 24-MB01>: bonjour>

...

💡 Tip: Set the Store Scope

If you have multiple store views, a store_code can be specified when retrieving/updating data

The Client.scope is used by default - simply change it to switch store views
Passing the scope keyword argument to Client.url_for(), Model.refresh(), and some Model update methods will temporarily override the Client scope

...

Building Custom Search Queries

In addition to the predefined methods, you can also build your own queries

Simply add_criteria(), restrict_fields(), and execute() the search
The since() and until() methods allow you to further filter your query by date

📋 Example: Retrieve Orders Over $50 Placed Since the Start of 2023
>>> api.orders.add_criteria( ... field="grand_total", ... value="50", ... condition="gt" ... ).since("2023-01-01").execute() [<Magento Order: "#000000012" placed on 2023-01-02 05:19:55>, ...]

...

Making Authorized Requests

The Client can be used to generate the url_for() any API endpoint, including a store scope.

You can use this URL to make an authorized get(), post(), put(), or delete() request.

Example: Making a `get()` Request

# Request the data for credit memo with id 7
>>> url = api.url_for('creditmemo/7')
>>> response = api.get(url)
>>> print(response.json())

{'adjustment': 1.5, 'adjustment_negative': 0, 'adjustment_positive': 1.5, 'base_adjustment': 1.5,  ... }

📝 Note

A search() is simpler than making get() requests, as the result will be wrapped by APIResponse or other Model

# Retrieve credit memo with id 7 using a search
>>> memo = api.search("creditmemo").by_id(7)
>>> print(memo.data)
>>> print(memo)

{'adjustment': 1.5, 'adjustment_negative': 0, 'adjustment_positive': 1.5, 'base_adjustment': 1.5,  ... }
<magento.models.model.APIResponse object at 0x000001BA42FD0FD1>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.rst

README.rst

MyMagento🛒

About MyMagento

MyMagento simplifies interaction with the Magento 2 REST API

Main Components

Available Endpoints

⚙ Installing MyMagento

📚 Documentation

QuickStart: Login with MyMagento

Setting the Login Credentials

Getting a `Client`

Option 1: Initialize a `Client` Directly

Option 2: Call `get_api()`

Getting an `ACCESS_TOKEN`

Performing a `search()`

Example: `search()` an endpoint `by_id()`

Example: `search()` an endpoint `by_list()`

Search Results: The `Model` Classes

Example: Retrieving every `Order` containing a `Product`

Example: Retrieving all `Product`s and `Invoice`s for a `Category`

Example: Updating the Thumbnail `MediaEntry` of a `Product`

Building Custom Search Queries

Making Authorized Requests

Example: Making a `get()` Request

Files

README.rst

Latest commit

History

README.rst

File metadata and controls

MyMagento🛒

About MyMagento

MyMagento simplifies interaction with the Magento 2 REST API

Main Components

Available Endpoints

⚙ Installing MyMagento

📚 Documentation

QuickStart: Login with MyMagento

Setting the Login Credentials

Getting a Client

Option 1: Initialize a Client Directly

Option 2: Call get_api()

Getting an ACCESS_TOKEN

Performing a search()

Example: search() an endpoint by_id()

Example: search() an endpoint by_list()

Search Results: The Model Classes

Example: Retrieving every Order containing a Product

Example: Retrieving all Products and Invoices for a Category

Example: Updating the Thumbnail MediaEntry of a Product

Building Custom Search Queries

Making Authorized Requests

Example: Making a get() Request

Getting a `Client`

Option 1: Initialize a `Client` Directly

Option 2: Call `get_api()`

Getting an `ACCESS_TOKEN`

Performing a `search()`

Example: `search()` an endpoint `by_id()`

Example: `search()` an endpoint `by_list()`

Search Results: The `Model` Classes

Example: Retrieving every `Order` containing a `Product`

Example: Retrieving all `Product`s and `Invoice`s for a `Category`

Example: Updating the Thumbnail `MediaEntry` of a `Product`

Example: Making a `get()` Request