Method list

Test your request

Changelog

Creates a new order status or updates an existing one if status_id is provided. A new status is appended at the end of the status list within its group.

status_id	int	Status ID. Provide to update an existing status. Leave empty or omit when creating a new status.
name	varchar(30)	Status name (basic) displayed to the seller in the panel.
short_name	varchar(17)	Shortened status name displayed in places with limited width (e.g., all-orders table).
name_for_customer	varchar(250)	Full status name displayed to the customer on the order page. If empty, the status is not shown in the order status history on the customer-facing page.
color	varchar(7)	Status color in hex format (e.g., "#FF0000").
type	int	Status type for analytics. 0: Other, 1: Unpaid, 2: In progress, 3: Sent, 4: Delivered, 5: Cancelled, 6: Return. Default: 0.
group_id	int	Status group ID. The list of group IDs can be retrieved using getOrderStatusList or by first creating groups with addOrderStatusGroup. If omitted on create, the status is placed in the main (default) group. On update, if not provided, the existing group assignment is kept.
comments	varchar(255)	Internal comment visible only on the statuses settings page.

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_id	int	ID of the created or updated status.

Input data:
{ "name": "Ready to ship", "short_name": "Ready", "name_for_customer": "Your order is being prepared for shipment", "color": "#008000", "type": 2, "group_id": 5, "comments": "For courier orders only" } Output data:
{ "status": "SUCCESS", "status_id": 12345 } A sample request in PHP:
<?php $methodParams = '{ "name": "Ready to ship", "short_name": "Ready", "name_for_customer": "Your order is being prepared for shipment", "color": "#008000", "type": 2, "group_id": 5, "comments": "For courier orders only" }'; $apiParams = [ "method" => "addOrderStatus", "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);