Delete active dimensions

Delete a Dimension for a Product

This API allows for the deletion of a specific dimension associated with a product, by specifying the dimension group and the level of the dimension. The ignore_movements query parameter can be set to manage dependencies with other entities or processes.

Variants and Barcodes

The service checks if the dimension to be detached from the product belongs to one or more SKUs (product variants) linked to barcodes. In this case, it is not possible to remove the dimension. Follow these steps:

Retrieve SKU's Barcode

If you do not know the barcodes associated with SKUs that involve the dimension to be detached, invoke the service Get SKU's barcodes, specifying only the parameter ITEM_CODE, for example, for the product MOD124.

This will return all barcodes with the SKUs of the product:

{
  "barcodes": [
    {
      "barcode": "9780201379624",
      "barcode_type": "EAN13",
      "dimension_level1": "XL",
      "dimension_level2": "RED"
    }
  ],
  "moreRows": true
}

Remove Barcode

With the list of barcodes containing the dimension to be removed dimension_level_*, proceed to remove them using the service Delete barcode.
If the barcode is moved, meaning it is contained in a sales or inventory document, an HTTP 423 error will be returned with the response:

{
  "message": "This SKU has been already moved"
}

In this case, ONLY IF NECESSARY, it is possible to ignore the movements by specify ignore_movements=true.

Remove Variant

After removing all barcodes linked to the SKU, proceed to detach the dimension using Delete active dimensions.

Actors

API Client: The system or user initiating the request.

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

Languages

The API can handle descriptions in multiple languages, such as description_it, description_en, etc., if necessary for international usage.

Preconditions

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

A valid ITEM_CODE, DIMENSION_TYPE, and DIMENSION_LEVEL must be provided in the request.

The dimension must exist within the specified group for it to be successfully deleted.

If ignore_movements=false, the system will not delete dimensions with associated dependencies (such as inventory movements) and may return an error if these dependencies exist.

Main Success Scenario

The client sends a DELETE request with the specified ITEM_CODE, DIMENSION_TYPE, and DIMENSION_LEVEL, as well as the query parameter ignore_movements=false.

If the dimension is successfully deleted, the API responds with a success message.

{
  "success": true
}

Alternate Flows

Dimension Not Found

If the specified dimension or group does not exist, the API returns a 404 error.

Response:

{
  "message": "Dimension group or dimension level not found"
}

Constraint Violation

If deleting the dimension violates a unique constraint, the API returns an error message.

Response:

{
  "message": "Unique constraint error"
}

Movements Present

If there are associated movements and ignore_movements=false, the API will prevent deletion, indicating that dependencies must be addressed.

Response:

{
  "message": "Cannot delete dimension; associated movements exist"
}

Sequence Diagram

Best Practices

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

Delete active dimensions

Delete a Dimension for a Product

Actors

Languages

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js

Request

Request Code Samples

Responses

Delete active dimensions

Delete a Dimension for a Product#

Actors#

Languages#

Preconditions#

Main Success Scenario#

Alternate Flows#

Sequence Diagram#

Code Examples in Node.js#

Request

Request Code Samples

Responses

Delete a Dimension for a Product

Actors

Languages

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js