Implement Update Order Status API

[italopessoa]

Feature Request: Implement API Endpoint for Order Status Updates

Problem:

Currently, there is no API endpoint available to update the status of an order. This makes it difficult for external systems and integrations to manage the lifecycle of orders and keep their records up to date.

Proposed Solution:

Create an API endpoint that accepts an order ID and a new status as parameters and updates the status of that order accordingly. The supported order statuses should be configurable and may include:

• Received
• InPreparation
• Done
• Complete
• Canceled

Benefits:

• Enables external systems and integrations to seamlessly update order statuses.
• Improves the efficiency of order management and fulfillment processes.
• Provides a consistent and reliable way to manage order status updates.

Additional Considerations:

• The endpoint should be secure and require appropriate authentication.
• The response should be in a JSON format.
• The endpoint should be documented and made available to developers.

Example Usage:

PUT /api/orders/{order_id}
{
  "status": "Shipped"
}

Response:

{
  "order_id": 123,
  "status": "Shipped"
}

[italopessoa]

graph LR
    subgraph Presentation Layer
        API_Endpoint["Order Status Endpoint"]
    end
    subgraph Application Layer
        OrderController["Order Controller"]
        OrderStatusUseCase["Order Status Use Case"]
    end
    subgraph Domain Layer
        OrderRepository["Order Repository"]
        Order["Order"]
    end
    subgraph Infrastructure Layer
        Database["Database"]
    end
    API_Endpoint --> OrderController
    OrderController --> OrderStatusUseCase
    OrderStatusUseCase --> OrderRepository
    OrderRepository --> Database
    OrderStatusUseCase --> Order

Explanation:

• Presentation Layer: This layer contains the API endpoint responsible for receiving requests for order status updates.
• Application Layer: This layer handles the logic of the application, including:
  • OrderController: Acts as an intermediary between the endpoint and the use case. It receives the request, validates it, and calls the use case to fetch the order status.
  • OrderStatusUseCase: Encapsulates the business logic for retrieving order status information. It interacts with the Order Repository to fetch the order and its status.
• Domain Layer: This layer represents the core business logic of the application:
  • Order Repository: An interface responsible for interacting with the data storage mechanism (database). It defines methods for fetching orders based on their ID.
  • Order: A domain object representing an order with its attributes, including status.
• Infrastructure Layer: This layer provides access to external systems and resources:
  • Database: The database where order data is stored.

Flow:

1. A client sends a request to the API endpoint /order/{orderId}/status.
2. The API endpoint forwards the request to the Order Controller.
3. The Order Controller validates the request and calls the Order Status Use Case.
4. The Order Status Use Case interacts with the Order Repository to retrieve the order with the specified ID from the database.
5. The Order Repository interacts with the database to fetch the order data.
6. The Order Status Use Case extracts the order status from the retrieved order.
7. The Order Status Use Case returns the order status to the Order Controller.
8. The Order Controller returns the order status to the API endpoint.
9. The API endpoint returns the order status to the client.

Benefits of Clean Architecture:

• Separation of Concerns: Each layer is responsible for specific functionalities, making the code more organized and maintainable.
• Testability: Each layer can be tested independently, as it doesn't rely on other layers.
• Flexibility: The implementation of the different layers can be easily changed without affecting the overall architecture.

Note: This is a basic representation of the architecture. The actual implementation might involve additional components and layers depending on the complexity of the application.