BFF API - SOM GUI API Specification
Endpoints
Historic Fulfillment Errors
Overview
The Historic Fulfillment Errors API provides access to historical records of fulfillment errors. It enables retrieval of past fulfillment errors based on various filter criteria such as order ID, error codes, date ranges, and user actions. This API helps in tracking and analyzing fulfillment-related issues to improve operational efficiency.
Get Historic Fulfillment Errors
GET /historicFulfillmentErrors
- Description: Retrieves a paginated list of historic fulfillment errors with optional filters.
- Authentication: Required (Bearer Token)
- Parameters:
orderId(query, string) - Filter by internal order ID.externalOrderId(query, string) - Filter by external order ID.stepId(query, string) - Filter by step ID related to the error.errorCode(query, string) - Filter by specific error code.internalErrorCode(query, string) - Filter by internal error code.errorDesc(query, string) - Filter by error description.internalErrorDesc(query, string) - Filter by internal error description.errorStartDate(query, date-time) - Filter by the start date of the error occurrence.errorEndDate(query, date-time) - Filter by the end date of the error occurrence.actionStartDate(query, date-time) - Filter by the start date of the user action related to the error.actionEndDate(query, date-time) - Filter by the end date of the user action related to the error.user(query, string) - Filter by the user who handled the error.userAction(query, string) - Filter by the type of user action taken.assignedUserId(query, string) - Filter by the ID of the assigned user.workItemName(query, string) - Filter by work item name associated with the error.
- Responses:
200 OK: Returns a paginated list of historic fulfillment errors.400 Bad Request: Invalid request parameters.401 Unauthorized: Missing or invalid authentication.500 Internal Server Error: Unexpected server error.