magento Orders API
Sales order management including order retrieval, status updates, comment posting, cancellation, and order item management.
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 Orders. 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.1.0, at version 2.4.
Requests are made against a single base URL, https://{store_domain}/rest/{store_code}.
Metadata
The identity and technical contract details declared by the specification.
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.
Sales order management including order retrieval, status updates, comment posting, cancellation, and order item management.
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.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from magento 12
Other APIs magento publishes across the network.