Method list

Test your request

Changelog

Returns order statuses created by the user in the order manager.





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
statuses	array	An array of statuses containing the fields listed below.
| - id	int	Status ID.
| - name	text	Status name.
| - color	text	Status color (hex, e.g. #1C8752).
| - group_id	int	Status group ID. The group details can be retrieved with getOrderStatusGroups method.
| - is_primary	int	Whether this is the primary (default) status (0 or 1).
| - name_for_customer	text	Full status name displayed to the customer on the order status page.

Input data:
{} Output data:
{ "status": "SUCCESS", "statuses": [ { "id": 1051, "name": "New orders", "color": "#0000FF", "group_id": 1, "is_primary": 1, "name_for_customer": "Order accepted" }, { "id": 1052, "name": "Dispatched", "color": "#808080", "group_id": 1, "is_primary": 0, "name_for_customer": "The parcel has been shipped" } ] } A sample request in PHP:
<?php $methodParams = '{}'; $apiParams = [ "method" => "getOrderStatusList", "parameters" => $methodParams ]; $curl = curl_init("https://api.baselinker.com/connector.php"); curl_setopt($curl, CURLOPT_POST, 1); curl_setopt($curl, CURLOPT_HTTPHEADER, ["X-BLToken: xxx"]); curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($apiParams)); $response = curl_exec($curl);