Delete dimension

Removing a Product Dimension from a Dimension Group

This API allows an external system to remove a specific dimension (e.g., size, color) from a dimension group (e.g., "EU Sizes"). The removal is permitted only if the dimension is not in use or associated with existing products or barcodes.

INFO

To learn more about how dimensions are managed, including defining dimension types, creating dimensional groups, and associating dimensions with products, please refer to our Product Dimensions

Languages

To understand how languages are managed, please refer to our Managing Languages Documentation.

Actors

API Client: The system or user initiating the request.

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

Preconditions

The dimension_type and dimension_group must already exist.

The dimension to be removed must not be linked to any product or SKU.

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

Main Success Scenario

If the request is successful, the system will return an HTTP 200 response, confirming the removal of the dimension and providing the internal program ID (prog_id).

Example Success Response:

{
  "dimension": {
    "prog_id": 78130146,
    "dimension": "nisi"
  }
}

Alternate Flows

Dimension Type Not Found:
If the dimension_type does not exist, the following error will be returned:

{
  "message": "dimension_type with {dimension_type} not found"
}

HTTP Status: 422 Unprocessable Entity

Dimension Group Not Found:
If the dimension_group does not exist, the following error will be returned:

{
  "message": "dimension_group with {dimension_group} not found"
}

HTTP Status: 422 Unprocessable Entity

Dimension Not Found:
If the dimension to be deleted does not exist within the specified dimension_group, the following error will be returned:

{
  "message": "dimension with {dimension} not found"
}

HTTP Status: 422 Unprocessable Entity

Dimension in Use:
If the dimension is associated with one or more products or barcodes, the deletion request will fail with an appropriate message.
HTTP Status: 409 Conflict

Sequence Diagram

Code Example in Node.js

This Node.js example demonstrates how to send a DELETE request to remove a product dimension from a group.

Dimension is associated with a product

If the dimension is associated with a product, the following sequence of API calls must be made before deletion

Remove the barcode: Call the endpoint Delete barcode specifying the BARCODE parameter to remove the associated barcode. Note that if the barcode has been moved, it cannot be removed.

Remove the product variant association: Call the endpoint Delete active dimensions to remove the association between the product and its variant.
:::

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

Here are the code examples in Node.js to execute the sequence of API calls required to safely delete a dimension.

Explanation:

deleteBarcode(barcode): This function deletes a barcode using the provided BARCODE parameter.

deleteProductVariant(itemCode, dimensionType, dimensionLevel): This function removes the association between a product and its variant.

deleteDimension(dimensionType, dimensionCode, dimensionValue): This function deletes the specified dimension.

deleteDimensionSafely(): This function orchestrates the entire process in the correct sequence to safely delete the dimension.

This code ensures that all dependencies are handled before the dimension is deleted, preventing errors related to active associations or SKUs.

Removing a Product Dimension from a Dimension Group

Languages

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Example in Node.js

Dimension is associated with a product

Sequence Diagram

Code Examples in Node.js

Request

Request Code Samples

Responses

Delete dimension

Removing a Product Dimension from a Dimension Group#

Languages#

Actors#

Preconditions#

Main Success Scenario#

Alternate Flows#

Sequence Diagram#

Code Example in Node.js#

Dimension is associated with a product#

Sequence Diagram#

Code Examples in Node.js#

Request

Request Code Samples

Responses

Removing a Product Dimension from a Dimension Group

Languages

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Example in Node.js

Dimension is associated with a product

Sequence Diagram

Code Examples in Node.js