Cancel Orders

Endpoint

POST /api/v1/orders/cancel

Description

This endpoint allows you to cancel one or more orders. It requires a valid Bearer Token for authentication.

Request Headers

Authorization: Bearer <token> (required)

Request Body

Content-Type: application/json
Schema: handlers.CancelOrdersRequest
- data: Array of objects containing:
  - order_id: string (required) - The ID of the order to be canceled.

Responses

200 OK
- Schema: types.SuccessResponse
- Description: The request was successful, and the orders were canceled.
- Data: Contains arrays of succeed_orders and failed_orders.
400 Bad Request
- Schema: types.ErrorResponse
- Description: The request was malformed or invalid.
401 Unauthorized
- Schema: types.ErrorResponse
- Description: Authentication failed due to invalid or missing token.
500 Internal Server Error
- Schema: types.ErrorResponse
- Description: An error occurred on the server.

Example Request

{
  "data": [
    {
      "order_id": "12345"
    },
    {
      "order_id": "67890"
    }
  ]
}

Example Response

Success

{
  "success": true,
  "data": {
    "succeed_orders": [
      {
        "order_id": "12345",
        "status": "canceled"
      }
    ],
    "failed_orders": [
      {
        "order_id": "67890",
        "error": "Order not found"
      }
    ]
  }
}

Error

{
  "success": false,
  "error_code": "E0441122",
  "error_message": "internal server error"
}