Magento 2 API Documentation

This is the complete API documentation for connecting to the Magento 2 API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet Magento 2: connect business data and workflows through MindCloud's Universal API. Keep reading to get started.

Quickstart

Before you run your first Magento 2 request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one Magento 2 connection — create or choose one in Connections. Note its connectionId.

Every Magento 2 action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/magento2/latest/actions/{actionSlug}

You need a MindCloud API Key and a Magento 2 connection. Then call an action such as Get Store Configs:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/magento2/latest/actions/get-store-configs" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authenticate with a MindCloud API Key plus a connectionId for your Magento 2 account. See Magento 2 API Authentication for the full flow and how to get your connection credentials.

Magento 2 actions

All 16 published actions for this Magento 2 version. Each page documents the endpoint, arguments, and response controls.

• PUTBetter Baseball update in_netsuite in orders
• POSTCreate a Shipment
• GETGet Credit Memos
• GETGet Customer By Id
• GETGet Invoices
• GETGet Order
• GETGet Orders
• GETGet Products
• GETGet Store Configs
• POSTPost Comment To Order
• POSTPost Inventory Source Items
• POSTPost Source Items
• PUTPut Or Post Credit Memo
• PUTPut Order
• GETSearch Customers
• PUTUpdate Product Stock Item

Related apps

More Commerce apps on the Universal API, behind the same REST shape. Or browse all apps.

StripeShopifySquareXeroThinkificWhopGumroadEcwid