BFF API - SOM GUI API Specification

Endpoints

Fulfillment Errors

Overview

The Fulfillment Errors API manages error-related operations for fulfillment processes. It allows users to retrieve error details, complete error resolutions, retry failed fulfillment steps, assign users to errors, and retrieve a list of users eligible to resolve errors.

Get Fulfillment Errors

GET /fulfillmentErrors

• Description: Retrieves a paginated list of fulfillment errors with filtering options.
• Authentication: Required (Bearer Token)
• Query Parameters:
  • orderId (string): Filter by order ID.
  • externalOrderId (string): Filter by external order ID.
  • stepId (string): Filter by step ID.
  • errorCode (string): Filter by error code.
  • internalErrorCode (string): Filter by internal error code.
  • errorDesc (string): Filter by error description.
  • internalErrorDesc (string): Filter by internal error description.
  • errorStartDate (date-time): Filter by start date of the error.
  • errorEndDate (date-time): Filter by end date of the error.
  • assignedUserId (string): Filter by assigned user ID.
  • workItemName (string): Filter by work item name.
• Responses:
  • 200 OK: Returns a list of fulfillment errors.
  • 400 Bad Request: Invalid request parameters.
  • 401 Unauthorized: Missing or invalid authentication.
  • 500 Internal Server Error: Unexpected server error.

Complete Fulfillment Errors

POST /fulfillmentErrors/complete

• Description: Marks a list of fulfillment errors as completed.
• Authentication: Required (Bearer Token)
• Request Body:
  • A JSON array of errors to complete.
• Responses:
  • 200 OK: Returns the result of completion action.
  • 400 Bad Request: Invalid request payload.
  • 401 Unauthorized: Missing or invalid authentication.
  • 500 Internal Server Error: Unexpected server error.

Retry Fulfillment Errors

POST /fulfillmentErrors/retry

• Description: Retries failed fulfillment steps associated with errors.
• Authentication: Required (Bearer Token)
• Request Body:
  • A JSON array of errors to retry.
• Responses:
  • 200 OK: Returns the result of retry action.
  • 400 Bad Request: Invalid request payload.
  • 401 Unauthorized: Missing or invalid authentication.
  • 500 Internal Server Error: Unexpected server error.

Assign User to Fulfillment Error

POST /fulfillmentErrors/assign

• Description: Assigns a user to a specific fulfillment error.
• Authentication: Required (Bearer Token)
• Request Body:
  • userId (string): ID of the user to assign.
  • errorId (string): ID of the error to assign the user to.
• Responses:
  • 204 No Content: Assignment action successful.
  • 400 Bad Request: Invalid request payload.
  • 401 Unauthorized: Missing or invalid authentication.
  • 500 Internal Server Error: Unexpected server error.

Assign User to Multiple Fulfillment Errors

POST /fulfillmentErrors/assign/batch

• Description: Assigns a user to multiple fulfillment errors at once.
• Authentication: Required (Bearer Token)
• Request Body:
  • userId (string): ID of the user to assign.
  • errorIds (array of strings): List of error IDs to assign the user to.
• Responses:
  • 200 OK: Returns the result of the batch assignment action.
  • 400 Bad Request: Invalid request payload.
  • 401 Unauthorized: Missing or invalid authentication.
  • 500 Internal Server Error: Unexpected server error.

Get Users Able to Work on Errors

GET /fulfillmentErrors/users

• Description: Retrieves a list of users who are eligible to be assigned to fulfillment errors.
• Authentication: Required (Bearer Token)
• Responses:
  • 200 OK: Returns a list of eligible users.
  • 400 Bad Request: Invalid request parameters.
  • 401 Unauthorized: Missing or invalid authentication.
  • 404 Not Found: No eligible users found.
  • 500 Internal Server Error: Unexpected server error.