BFF API - SOM GUI API Specification

Endpoints

Orders

Overview

The Orders API handles order-related operations, including retrieving order lists, fetching order details, retrieving order payloads, updating payloads, and retrieving available actions and statuses. It provides functionality for managing orders throughout their lifecycle.

Get Orders

GET /orders

• Description: Retrieves a paginated list of orders based on various filters such as order ID, external order ID, status, and submitted date range.
• Authentication: Required (Bearer Token)
• Parameters:
  • orderId (query, string) - Filter by order ID.
  • externalOrderId (query, string) - Filter by external order ID.
  • status (query, enum) - Filter by order status.
  • submittedDateFrom (query, date-time) - Start date for filtering orders.
  • submittedDateTo (query, date-time) - End date for filtering orders.
  • params (query, object) - Additional filter parameters.
• Responses:
  • 200 OK: Returns a list of orders with metadata.
  • 400 Bad Request: Invalid request parameters.
  • 401 Unauthorized: Missing or invalid authentication.
  • 500 Internal Server Error: Unexpected server error.

Get Order Query Parameters

GET /orders/queryParams

• Description: Retrieves available query parameters for filtering orders.
• Authentication: Required (Bearer Token)
• Responses:
  • 200 OK: Returns available query parameters.
  • 400 Bad Request: Invalid request parameters.
  • 401 Unauthorized: Missing or invalid authentication.
  • 500 Internal Server Error: Unexpected server error.

Get Order Cancellation Options

GET /orders/cancellationOptions

• Description: Retrieves available cancellation options for orders.
• Authentication: Required (Bearer Token)
• Responses:
  • 200 OK: Returns available cancellation options.
  • 400 Bad Request: Invalid request parameters.
  • 401 Unauthorized: Missing or invalid authentication.
  • 500 Internal Server Error: Unexpected server error.

Get Available Order Statuses

GET /orders/availableStatuses

• Description: Retrieves available order statuses.
• Authentication: Required (Bearer Token)
• Responses:
  • 200 OK: Returns available order statuses.
  • 400 Bad Request: Invalid request parameters.
  • 401 Unauthorized: Missing or invalid authentication.
  • 500 Internal Server Error: Unexpected server error.

Get Order Details

GET /orders/{id}

• Description: Retrieves details of a specific order by its ID.
• Authentication: Required (Bearer Token)
• Path Parameters:
  • id (path, string) - Order ID.
• Responses:
  • 200 OK: Returns order details.
  • 400 Bad Request: Invalid request parameters.
  • 401 Unauthorized: Missing or invalid authentication.
  • 404 Not Found: Order not found.
  • 500 Internal Server Error: Unexpected server error.

Get Order Payload

GET /orders/{id}/payload

• Description: Retrieves the payload of a specific order.
• Authentication: Required (Bearer Token)
• Path Parameters:
  • id (path, string) - Order ID.
• Responses:
  • 200 OK: Returns the order payload.
  • 400 Bad Request: Invalid request parameters.
  • 401 Unauthorized: Missing or invalid authentication.
  • 404 Not Found: Order not found.
  • 500 Internal Server Error: Unexpected server error.

Get Service Order Payload

GET /orders/{id}/servicePayload

• Description: Retrieves the service order representation (service order payload) for a specific order.
• Authentication: Required (Bearer Token)
• Path Parameters:
  • id (path, string) - Order ID.
• Responses:
  • 200 OK: Returns the order payload.
  • 400 Bad Request: Invalid request parameters.
  • 401 Unauthorized: Missing or invalid authentication.
  • 404 Not Found: Order not found.
  • 500 Internal Server Error: Unexpected server error.

Update Order Payload

PUT /orders/{id}/payload

• Description: Updates the payload of a specific order.
• Authentication: Required (Bearer Token)
• Path Parameters:
  • id (path, string) - Order ID.
• Request Body:
  • JSON payload containing the updated order payload.
• Responses:
  • 204 No Content: Update action accepted.
  • 400 Bad Request: Invalid request payload.
  • 401 Unauthorized: Missing or invalid authentication.
  • 404 Not Found: Order not found.
  • 500 Internal Server Error: Unexpected server error.

Update Service Order Payload

PUT /orders/{id}/servicePayload

• Description: Updates the service payload of a specific order.
• Authentication: Required (Bearer Token)
• Path Parameters:
  • id (path, string) - Order ID.
• Request Body:
  • JSON payload containing the updated order service payload.
• Responses:
  • 204 No Content: Update action accepted.
  • 400 Bad Request: Invalid request payload.
  • 401 Unauthorized: Missing or invalid authentication.
  • 404 Not Found: Order not found.
  • 500 Internal Server Error: Unexpected server error.

Get Available Order Actions

GET /orders/{id}/availableActions

• Description: Retrieves the available actions for a specific order.
• Authentication: Required (Bearer Token)
• Path Parameters:
  • id (path, string) - Order ID.
• Responses:
  • 200 OK: Returns a list of available actions for the order.
  • 400 Bad Request: Invalid request parameters.
  • 401 Unauthorized: Missing or invalid authentication.
  • 404 Not Found: Order not found.
  • 500 Internal Server Error: Unexpected server error.

Update Order's Future Date

PUT /orders/{id}/futureDate

• Description: Updates the future date of a specific order.
• Authentication: Required (Bearer Token)
• Path Parameters:
  • id (path, string) - Order ID.
• Request Body:
  • JSON payload containing the future date in ISO Date Time Format
• Responses:
  • 204 No Content: Update action accepted.
  • 400 Bad Request: Invalid request payload.
  • 401 Unauthorized: Missing or invalid authentication.
  • 404 Not Found: Order not found.
  • 500 Internal Server Error: Unexpected server error.

Pause Order

PUT /orders/{id}/pause

• Description: Pause the order.
• Authentication: Required (Bearer Token)
• Path Parameters:
  • id (path, string) - Order ID.
• Responses:
  • 202 Accepted: Update action accepted.
  • 400 Bad Request: Invalid request payload.
  • 401 Unauthorized: Missing or invalid authentication.
  • 404 Not Found: Order not found.
  • 500 Internal Server Error: Unexpected server error.

Resume Order

PUT /orders/{id}/resume

• Description: Resume the order.
• Authentication: Required (Bearer Token)
• Path Parameters:
  • id (path, string) - Order ID.
• Responses:
  • 202 Accepted: Update action accepted.
  • 400 Bad Request: Invalid request payload.
  • 401 Unauthorized: Missing or invalid authentication.
  • 404 Not Found: Order not found.
  • 500 Internal Server Error: Unexpected server error.