BFF API - SOM GUI API Specification

Endpoints

Batch Orders

Overview

The Batch Orders API allows users to manage multiple orders efficiently. It includes functionalities for canceling orders in bulk, retrieving order details, and tracking execution results. This API is designed for high-volume order processing scenarios.

Cancel Batch Orders

PUT /batch/orders/cancel

• Description: Cancels multiple orders in a single request.
• Authentication: Required (Bearer Token)
• Request Body:
  • Type: JSON array
  • Description: A list of order IDs to be canceled.
  • Schema: CancelOrderList
• Responses:
  • 200 OK: Returns an orders cancellation report (BatchCommandAggregateResult).
  • 400 Bad Request: Invalid request parameters.
  • 401 Unauthorized: Missing or invalid authentication.
  • 500 Internal Server Error: Unexpected server error.

Components

Security

• Bearer Authentication: This API requires a valid JWT token for authentication.

Common Responses

• UnauthorizedError (401): Access token is missing or invalid.
• BadRequestError (400): The request is malformed or missing required parameters.
• InternalError (500): An unexpected server error occurred.

Schema References

• CancelOrderList: A JSON object containing an array of order IDs and an optional cancellation option.
• BatchCommandAggregateResult: Represents the result of a batch command execution, summarizing successes and failures.

This API is optimized for managing large-scale order operations, ensuring efficient processing and error handling.