API documentation
Method list
Test your request
Changelog


deleteOrderStatus
Deletes an order status. All orders currently in the deleted status are moved to the specified target status. The primary (default) status cannot be deleted.


Input parameters
status_idintID of the status to delete.
target_status_idintID of the status to which items with the deleted status will be migrated. Must be different from status_id.



Output data
The method returns the data in JSON format.
statusvarchar(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



Sample
Input data:
Output data:
A sample request in PHP: