Description
Applies the Suspension on the specified Order.
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| order-id | Integer | Required | Order Id of the Order on which the Suspension is to be applied |
| reason | String | Required | The reason for the suspension. |
HTTP Method
POST
Example Test URL Request
https://test.httpapi.com/api/orders/suspend.json?auth-userid=0&api-key=key&order-id=0&reason=reason-for-suspension
Response
Returns a hash map containing the below details:
-
Domain Name (description)
-
Order ID of the Order to be suspended (entityid)
-
Action Type (actiontype)
-
Description of the Order Suspension Action (actiontypedesc)
-
Action ID of the Order Suspension Action (eaqid)
-
Order Suspension Action Status (actionstatus)
-
Description of the Order Suspension Action Status (actionstatusdesc)
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.