Delete order
Description
Delete an order in the market, including from the profile history (the request completely deletes the order data from the database).
In the request, you need to use a token that is assigned a role with the appropriate access rules.
URL
Method: POST
https://example.com/api/v1.1/market/orders/delete
Request parameters
Parameter | Type | Example | Required | Description |
---|---|---|---|---|
token | string | "abcdefghijklmnqrstuvwxyz" | Yes | API token |
id | int | 1 | Not if external_id is passed | Internal order ID |
external_id | string | "A598t32D" | Not if id is passed | External order ID |
Request example
- JSON
- XML
{
"token": "abcdefghijklmnqrstuvwxyz",
"id": 1
}
{
"token": "abcdefghijklmnqrstuvwxyz",
"external_id": "A598t32D"
}
<xml>
<token>abcdefghijklmnqrstuvwxyz</token>
<id>1</id>
</xml>
<xml>
<token>abcdefghijklmnqrstuvwxyz</token>
<external_id>"A598t32D"</external_id>
</xml>
Response example
- JSON
- XML
{
"error": 0,
"error_text": ""
}
<xml>
<error>0</error>
<error_text></error_text>
</xml>
Response parameters
Parameter | Type | Description |
---|---|---|
error | int | Error code |
error_text | string | Error text |