If you are a developer and you want to build an Android or iOS app for your Magento website, you may want to know about the list of APIs you need to call to make the functions of the app.
Magento provides us with 2 types of APIs, they are REST API and Graphql API. You can choose which you prefer (or are familiar with).
In this post, I will show you the list of the REST APIs Magento publish which we can use to integrate into the mobile app. This list of APIs is what we are using to build a default mobile app for a Magento website. You can download the app and use it for your Magento website instantly or build your own app with the API list below:
Store
| GET /store/storeViews |
| GET /store/storeGroups |
| GET /store/websites |
| GET /store/storeConfigs |
Directory
| GET /store/storeConfigs |
| GET /directory/countries |
| GET /directory/countries/\(id) |
Customer
| POST /customers |
| POST /integration/customer/token |
| GET /customers/me |
| GET /customers/me/shippingAddress |
| GET /customers/me/billingAddress |
| PUT /customers/[id] |
| DELETE /addresses/[id] |
| PUT /customers/password |
| PUT /customers/me/password |
| POST /customers/isEmailAvailable |
| POST /customers/confirm |
Catalog
| GET /products/ |
| GET /products/[sku] |
| GET /products/[sku]/links/related |
| GET /categories/ |
| GET /categories/list |
| GET /categories/[id]/products |
| GET /products/attributes/[code]/options |
| GET /products/layerData/[id] |
| GET /products/attributes/[code]/options |
| GET /products/[sku]/media/ |
| GET /categories/[id] |
| GET /products/attribute-sets/sets/list |
| GET /bundle-products/[sku]/children |
| GET search?searchCriteria[requestName]=<container_name>&searchCriteria[filter_groups][0][filters][0][field]=<filter_name>&searchCriteria[filter_groups][0][filters][0][value]=<search_value> |
| GET rest/V1/products?searchCriteria[page_size]=10&searchCriteria[sortOrders][0][field]=price&searchCriteria[sortOrders][0][direction]=DESC |
Order
| GET /orders/[id] |
| GET /orders |
Attributes
GET /attributeMetadata/customer
Quote
| POST /carts/mine |
| POST /guest-carts |
| POST /carts/mine/items |
| POST /guest-carts/[cart_id]/items |
| POST /carts/mine/coupons/[coupon_code] |
| POST /guest-carts/[cart_id]/coupons/\(code) |
| DELETE /carts/mine/coupons |
| DELETE /guest-carts/[cart_id]/coupons |
| GET /carts/mine/items |
| GET /guest-carts/[cart_id]/items |
| DELETE /carts/mine/items/\(id) |
| DELETE /guest-carts/[cart_id]/items/\(id) |
| GET /carts/mine/totals |
| GET /guest-carts/[cart_id]/totals |
| GET /carts/mine |
| GET /guest-carts/[cart_id] |
| GET /carts/mine/coupons |
| GET /guest-carts/[cart_id]/coupons |
Checkout
| GET /carts/mine/payment-information |
| GET /guest-carts/[cart_id]/payment-information |
| POST /carts/mine/shipping-information |
| POST /guest-carts/cart_id/shipping-information |
| POST /carts/mine/estimate-shipping-methods |
| POST /guest-carts/[cart_id]/estimate-shipping-methods |
| PUT /carts/mine/order |
| PUT /guest-carts/[cart_id]/order |
| POST /carts/mine/billing-address |
| POST /guest-carts/[cart_id]/billing-address |
CMS
| GET /V1/cmsPage/{pageId} |
| GET /V1/cmsBlock/{blockId} |
These are all the APIs that Magento provides for you to use to build a default mobile app for your store. With this list of APIs, you can make a mobile app with all the basic functions that a Magento E-commerce app serves.
Besides that, you may want to custom the home page, or you want to add the Wishlist to the app, … You need to customize your Magento website to provide those external APIs.
Our default Magento mobile app is flexible to add more features and functions.
If you are trying our product, you can contact us to request customizations for your website and the app to fit your needs.