magento / magento/community-features

Improvement: REST-API - Add List of Order Status Node

Open
#74 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

API moved from magento2 Priority: P2
Dominant language
No language data
Stars
46
Forks
14
PR merge metrics
No merged PRs in 30d

Description

According to: [https://magento.stackexchange.com/questions/150492/magento-2-how-to-get-all-order-status](url) there isn't a possibility to get all Order Status that were available inside the Shop.

For ERP Systems which would change the status from "open" to "complete" or a custom status it is necessary to know how the internal name of the status is setup inside the Shop to update an order from status A to status B.

**For example:**

- Inside Shop A there is a custom status **"parts supplied"**, the _internal status_name_ of this custom status is set to **"custom_partssupplied"**.
- The Order was **read** with Status **"open"**.
- After work is done in the ERP-System, this custom status "parts supplied" should be applied to this Order
- Over REST-API there is a possibility to update "status" with a string -> namely the _internal status_name_ in this example **"custom_partssupplied"**

**Problem now is:**
- How to get the List of all status over REST-API without changing anything to the shop (changing php files)?

Most ERP-Systems using a proprietary connector, tool, php-toolbox to do this job, but that is against nature of an api: _use the api, don't work around the api._

**A Node to get all status from shop is needed to get this task done, but this Node is missing.**

**Original Report**: https://github.com/magento/magento2/issues/16324 by @DanielKarr87

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the REST API behavior described in this issue and review the linked Magento Stack Exchange answer and original report #16324. Identify the existing order-status API entry points and determine how a read-only node could expose all shop statuses, including internal status names. Done means ERP systems can retrieve the complete status list without changing shop files.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
api, backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.