Skip to main content
DELETE
/
v1
/
orders
/
{order_id}
Cancel Order
curl --request DELETE \
  --url https://api.rivermarkets.com/v1/orders/{order_id} \
  --header 'x-api-key: <api-key>'
{
  "cancelled_river_order_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "failed_cancelled_reasons": {}
}

Authorizations

​
x-api-key
string
header
required

API key for programmatic access. Generate one at app.rivermarkets.com under Settings → API Keys.

Path Parameters

​
order_id
string<uuid>
required

Response

Successful Response

Schema for cancel order response

​
cancelled_river_order_ids
string<uuid>[]
required

List of cancelled river order identifiers

​
failed_cancelled_reasons
Failed Cancelled Reasons · object
required

Dictionary of failed to cancel river order identifiers and reasons