Cancel order
The Cancel order method is used to start the process of cancelling an order for a subscription for the current reseller or any of its downstream resellers. The standard logic of the platform is used (see Cancelling an Order).
An API token of a manager is required for authorization. To get an API token via the Operator Control Panel, see Viewing and updating Manager's information.
The manager's API token specified in an API request determines:
- The role and access level of the manager, which determine the availability of a method.
- The current reseller and downstream resellers accessible within a method.
POST {base_url}/api/v3/resellers/{reseller_id}/orders/{order_id}/cancel_operationArguments
Name | Parameter Type | Data type | Required/Optional | Description | ||||
|---|---|---|---|---|---|---|---|---|
| X-Api-Token | header | string | Required | API token of a manager that performs the operation (see Viewing and updating Manager's information) | ||||
| Content-Type | header | string | Required | Media type of the request. Specify the following: application/vnd.api+json | ||||
| Accept | header | string | Required | Supported media types of the answer. Specify the following: application/vnd.api+json | ||||
| base_url | path | string | Required | ActivePlatform URL | ||||
| reseller_id | path | integer | Required | ID of the current reseller or any of its downstream resellers (see Viewing and updating Reseller general information) | ||||
| order_id | path | integer | Required | ID of the order to cancel | ||||
Response model
If no errors are encountered, the method returns an empty response with the 200 OK status.
Request example
POST /api/v3/resellers/1/orders/10914/cancel_operation
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json