How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Magento

magento Orders API

Sales order management including order retrieval, status updates, comment posting, cancellation, and order item management.

Documentation Provider Profile APIs.io OpenAPI GitHub

magento Orders API is one of 16 APIs that Magento publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Order. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 4 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version 2.4.

Requests are made against a single base URL, https://{store_domain}/rest/{store_code}.

5 operations 4 paths 7 schemas 2 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.4
Base URL
https://your-store.example.com/rest
Authentication
HTTP Bearer
Contact
Adobe Commerce Developer Support
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

magento Orders API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer token obtained from the /V1/integration/admin/token or /V1/integration/customer/token endpoint. Include in the Authorization header as "Bearer {token}".

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Orders 5

Sales order management including order retrieval, status updates, comment posting, cancellation, and order item management.

GET
/V1/orders
List orders
listOrders 4 params → 200400401
POST
/V1/orders
Create an order
createOrder body → 200400401
GET
/V1/orders/{orderId}
Get order by ID
getOrder 1 param → 200401404
POST
/V1/orders/{orderId}/cancel
Cancel an order
cancelOrder 1 param → 200400401404
POST
/V1/orders/{orderId}/comments
Add a comment to an order
addOrderComment 1 param body → 200400401404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Order (18 properties), OrderItem (10 properties), Address (10 properties), OrderSearchResults (3 properties). Each schema is shown below with its type and property counts.

Order
object
A sales order in Adobe Commerce.
18 properties
OrderRequest
object
Request body for creating a sales order directly via the API.
1 property 1 required
OrderSearchResults
object
Paginated search results containing a list of orders.
3 properties
Address
object
A postal address used for billing or shipping.
10 properties
OrderCommentRequest
object
Request body for adding a status history comment to an order.
1 property 1 required
OrderItem
object
A line item within a sales order.
10 properties
Error
object
Standard error response returned for 4xx and 5xx responses.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

magento-orders-api-openapi.yml Raw ↑

Other APIs Magento publishes across the network.

Magento GraphQL API
AE Profile APIs.io
Magento SOAP API
AE Profile APIs.io
Adobe Commerce Webhooks
AE Profile APIs.io
Adobe Commerce Admin UI SDK
AE Profile APIs.io
Adobe Commerce Eventing
AE Profile APIs.io
magento Authentication API
AE Profile APIs.io
magento Carts API
AE Profile APIs.io
magento Categories API
AE Profile APIs.io
magento Customers API
AE Profile APIs.io
magento Inventory API
AE Profile APIs.io
magento Invoices API
AE Profile APIs.io
magento Products API
AE Profile APIs.io
#Order
← Back to M APIs
API Details
ID
magento:magento-orders-api
Base URL
https://your-store.example.com/rest
Docs
https://developer.adobe.com/commerce/webapi/rest/
Provider
Magento
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=magento-orders-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/magento-orders-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of magento Orders API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.