BFF API - SOM GUI API Specification

Endpoints

Orders

Overview

The Orders API provides access to order fulfillment plans. This allows users to retrieve detailed fulfillment plans associated with specific orders.

Get Fulfillment Plans by Order ID

GET /orders/{id}/fulfillmentPlans

• Description: Retrieves fulfillment plans for a given order based on its ID.
• Authentication: Required (Bearer Token)
• Parameters:
  • id (path, string, required): The unique identifier of the order.
• Responses:
  • 200 OK: Returns fulfillment plans for the specified 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.

Security

• The API uses Bearer Token Authentication (JWT).
• A valid authentication token must be included in the request header to access the endpoints.

Response Components

• FulfillmentPlans: Contains fulfillment plan details, including steps and statuses.
• Error Handling: Standard error responses include BadRequestError, UnauthorizedError, NotFoundError, and InternalError.

This document describes all relevant endpoints for retrieving fulfillment plans within the Orders API.