BFF API - SOM GUI API Specification

Endpoints

Fulfillment

Overview

The Fulfillment API handles fulfillment-related operations, including forcibly finishing a fulfillment step and rerunning a failed fulfillment step. It provides a way to manage the fulfillment lifecycle and ensure execution steps are completed as needed.

Force Finish Fulfillment Step

PUT /fulfillmentSteps/{stepId}/forceFinish

• Description: Forces the completion of a fulfillment step.
• Authentication: Required (Bearer Token)
• Parameters:
  • stepId (string, required): The unique identifier of the fulfillment step to be forcibly finished.
• Responses:
  • 204 No Content: Fulfillment step finished successfully.
  • 400 Bad Request: Error details returned.
  • 401 Unauthorized: Missing or invalid authentication.
  • 500 Internal Server Error: Unexpected server error.

Rerun Fulfillment Step

PUT /fulfillmentSteps/{stepId}/rerun

• Description: Re-executes a previously failed fulfillment step.
• Authentication: Required (Bearer Token)
• Parameters:
  • stepId (string, required): The unique identifier of the fulfillment step to be rerun.
• Responses:
  • 204 No Content: Fulfillment step rerun successfully.
  • 400 Bad Request: Error details returned.
  • 401 Unauthorized: Missing or invalid authentication.
  • 500 Internal Server Error: Unexpected server error.

Force Fulfillment Step Into Error

PUT /fulfillmentSteps/{stepId}/error

• Description: Force fulfillment step into error.
• Authentication: Required (Bearer Token)
• Parameters:
  • stepId (string, required): The unique identifier of the fulfillment step to be forced into error.
• Responses:
  • 204 No Content: Fulfillment step forced to error successfully.
  • 400 Bad Request: Error details returned.
  • 401 Unauthorized: Missing or invalid authentication.
  • 500 Internal Server Error: Unexpected server error.