REST API
The Order Management extension exposes its Order Editor, Order Grid, and Order Tag features through the standard Magento REST API, so you can manage orders, tags, and tag groups programmatically or integrate them with external systems.
All endpoints require a Magento access token (integration or admin token) with access to the corresponding ACL resource. For general authentication and request/response details, refer to the Magento REST API developer guide.
Order Editor - /V1/order-editor
Requires the Order Editor ACL resource (System -> Permissions -> User Roles -> Sales -> Operations -> Orders -> Actions -> Order Editor).
| Method | Endpoint | Description |
|---|---|---|
| GET | /V1/order-editor/order/:orderId/section/:sectionCode | Load a single order editor section |
| PUT | /V1/order-editor/order/:orderId/information | Save the Information section |
| PUT | /V1/order-editor/order/:orderId/account | Save the Account section |
| PUT | /V1/order-editor/order/:orderId/payment | Save the Payment section |
| PUT | /V1/order-editor/order/:orderId/shipping | Save the Shipping section |
| PUT | /V1/order-editor/order/:orderId/shipping-address | Save the Shipping Address section |
| PUT | /V1/order-editor/order/:orderId/customer-email | Save the Customer Email section |
| PUT | /V1/order-editor/order/:orderId/coupon | Save the Coupon section |
| PUT | /V1/order-editor/order/:orderId/items | Save the Items Ordered section |
| POST | /V1/order-editor/order/:orderId/items/preview | Preview item changes before saving (same as clicking Preview) |
| POST | /V1/order-editor/items/resolve | Resolve product URLs for items whose SKU has changed since the order was placed |
Deleting invoices requires the separate Delete Invoice ACL resource:
| Method | Endpoint | Description |
|---|---|---|
| DELETE | /V1/order-editor/invoice/:invoiceId | Delete a single invoice |
| POST | /V1/order-editor/invoices/delete | Delete multiple invoices |
Order Grid - /V1/order-grid
Each endpoint requires its own matching ACL resource (Delete Order, Mass Invoice, Mass Shipment, Mass Split Order, or Mass Merge Orders).
| Method | Endpoint | Description |
|---|---|---|
| DELETE | /V1/order-grid/order/:orderId | Delete a single order |
| POST | /V1/order-grid/orders/delete | Delete multiple orders |
| POST | /V1/order-grid/orders/invoice | Invoice multiple orders |
| POST | /V1/order-grid/orders/shipment | Ship multiple orders |
| POST | /V1/order-grid/order/:orderId/split | Split an order |
| POST | /V1/order-grid/orders/merge | Merge multiple orders |
Order Tag - /V1/order-tag
Requires the Order Tag (or, for groups, Order Tag Group) ACL resource.
| Method | Endpoint | Description |
|---|---|---|
| GET | /V1/order-tag/tags | List tags |
| GET | /V1/order-tag/tag/:tagId | Get a single tag |
| POST | /V1/order-tag/tag | Create a tag |
| PUT | /V1/order-tag/tag/:tagId | Update a tag |
| DELETE | /V1/order-tag/tag/:tagId | Delete a tag |
| GET | /V1/order-tag/groups | List tag groups |
| GET | /V1/order-tag/group/:groupId | Get a single tag group |
| POST | /V1/order-tag/group | Create a tag group |
| PUT | /V1/order-tag/group/:groupId | Update a tag group |
| DELETE | /V1/order-tag/group/:groupId | Delete a tag group |
| POST | /V1/order-tag/order/:orderId/tag/:tagId/assign | Assign a tag to an order |
| POST | /V1/order-tag/order/:orderId/tag/:tagId/unassign | Unassign a tag from an order |
| POST | /V1/order-tag/tag/:tagId/mass-assign | Assign a tag to multiple orders at once |
| POST | /V1/order-tag/tag/:tagId/reindex | Rebuild automatic-tag assignments for a given tag |