delete product assortment

Delete Store's Assortment

This API allows a retail system to remove a specific product from the assortment of a designated store. Once removed, the product will no longer be available for search and selection in the store's Mobile Shop POS application.

Actors

API Client: The system or user initiating the request.

4ws.trade: The backend system that processes the request.

Preconditions

The external system must have the necessary permissions and access to the document creation service, please refer to Authentication.

The product identified by ITEM_CODE must exist within the system catalog.

The ENTITY_CODE (store code) must be valid and associated with the product.

Main Success Scenario

The API client sends a DELETE request with a specified ENTITY_CODE to remove the product from that store’s assortment.

If successful, the API confirms the removal with a response that includes a success status.

Alternate Flows

Product Not Found: If the specified product does not exist, the API returns an error message:

{
  "message": "Product not found with item_code: {{item_code}}"
}

Sequence Diagram

Best Practices

Please refer to Best Practices for Error Handling in External System for best practices on implementation.

Code Examples in Node.js

Example Node.js code for removing a product from a store’s assortment:

delete product assortment

Delete Store's Assortment

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js

Request

Request Code Samples

Responses

delete product assortment

Delete Store's Assortment#

Actors#

Preconditions#

Main Success Scenario#

Alternate Flows#

Sequence Diagram#

Code Examples in Node.js#

Request

Request Code Samples

Responses

Delete Store's Assortment

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js