Pause or Resume Smart Order

This API allows you to pause a running smart order and resume it later.

USE CASE

Pause a smart order temporarily without cancelling it, then resume it when you are ready.

Pause an order before modifying it, then resume it.

Details

Pause a running smart order. This temporarily stops order execution without cancelling it.
To modify a Smart Order, it must be paused first (pausing is not mandatory for Smart Limit order modification).
The order can be resumed later using the Resume API.
Both calls take only the flowId of the smart order.
Pause is rejected if the order is already executed, cancelled, rejected, already paused or in progress, or if it failed during creation, modification, resume, pause or deletion.
A Smart Limit order cannot be paused during market hours.
Resume works only on a paused order. It is rejected if the order is not paused, already running, in progress, executed or cancelled.
Resuming is mandatory after you modify an order.
Rate limits differ between the Standard and Prime plans. See Plans & rate limits.

Request Attributes

Attribute	Data Type	Required	Description
`flowId`	string	Yes	Unique identifier of the smart order to pause

Validations & Error Handling

Scenario	Error Message
Invalid flowId	"The provided smart order ID is invalid."
Internal error	"Error in Unmarshal"
Order already executed	"You are attempting to pause a smart order that has already been executed."
Order already cancelled	"You are attempting to pause a smart order that has already been cancelled."
Order already paused	"The smart order is already paused and cannot be paused again."
Order in progress	"The smart order cannot be paused as it is already in progress."
Limit order during market hours	"Pausing is not allowed during market hours for limit orders."
Order cancelled by system	"The pause attempt failed as the smart order cancelled by system"
Invalid pause request	"Smart order cannot be paused."
Failed during creation	"The smart order cannot be paused as it has failed during creation."
Failed during modification	"The smart order cannot be paused as it has failed during modification."
Failed during resume	"The smart order cannot be paused as it has failed during resume."
Failed during pause	"The smart order cannot be paused as it has failed during pause."
Failed during deletion	"The smart order cannot be paused as it has failed during deletion."
Rejected	"The smart order cannot be paused as it has been rejected."

Response Attributes

Attribute	Data Type	Description
`code`	int	Status code: `200` for success, negative values for errors
`message`	string	"Request sent successfully to pause smart order." or an error description
`s`	string	"ok" for success, "error" for failure

Request

from fyers_apiv3 import fyersModel

client_id = "AAAAAAAA-100"
access_token = ""

# Initialize the FyersModel instance with your clientid, access_token, and enable async mode_
fyers = fyersModel.FyersModel(client_id=client_id, is_async=False, token=access_token, log_path="") 

data ={
  "flowId": "356b4c5c-411b-46e9-9af3-edc2147c98ba"
}
pause_order = fyers.pause_smart_order(data=data)
print(pause_order)

Response structure:
{
  "code": 200,
  "message": "Request sent successfully to pause smart order",
  "s": "ok"
}

Details

Resume a paused Smart Order. This restarts the order for execution and is mandatory after modifying the order.
Rate limits differ between the Standard and Prime plans. See Plans & rate limits.

Request Attributes

Attribute	Data Type	Required	Description
`flowId`	string	Yes	Unique identifier of the smart order to resume

Validations & Error Handling

Scenario	Error Message
Invalid flowId	"The provided smart order ID is invalid."
Internal error	"Error in Unmarshal"
Order not paused	"The smart order must be paused before it can be resumed."
Order already executed	"The smart order has already been executed and cannot be resumed."
Order already cancelled	"A canceled smart order cannot be resumed."
Order already running	"The smart order is already resumed and cannot be resumed again."
Order in progress	"The smart order cannot be resumed as it is already in progress."
Order cancelled by system	"The resume attempt failed as the smart order cancelled by system"
Invalid resume request	"Smart order cannot be resumed."

Response Attributes

Attribute	Data Type	Description
`code`	int	Status code: `200` for success, negative for errors
`message`	string	"Request sent successfully to resume smart order." or error description
`s`	string	"ok" for success, "error" for failure

Request

from fyers_apiv3 import fyersModel

client_id = "AAAAAAAA-100"
access_token = ""

# Initialize the FyersModel instance with your clientid, access_token, and enable async mode_
fyers = fyersModel.FyersModel(client_id=client_id, is_async=False, token=access_token, log_path="") 

data = {
    "flowId": "356b4c5c-411b-46e9-9af3-edc2147c98ba"
}
resume_order = fyers.resume_smart_order(data=data)
print(resume_order)

Response structure:
{
  "code": 200,
  "message": "Request sent successfully to resume smart order",
  "s": "ok"
}