getOrderStatusGroups
Returns the list of order status groups. Status groups are used to visually organize statuses in the panel sidebar.
Input parameters
Output data
The method returns the data in JSON format.
| status | varchar(30) | SUCCESS - request executed correctly ERROR - an error occurred during an API request. Error details will be described in 2 additional returned fields: error_message and error_code |
| status_groups | array | An array of status groups containing the fields listed below. |
| | - group_id | int | Status group ID. |
| | - name | text | Status group name. |
| | - is_main_group | int | Whether this is the main (default) group (0 or 1). |
Sample
Input data:Output data:
A sample request in PHP: