Delete barcode

API Documentation: Remove Specific Barcode

This API allows the removal of a specific barcode identified by {BARCODE}. The operation will succeed if the barcode is not associated with any inventory movements, unless forced by setting the parameter ignore_movements=true (If the ignore_movements parameter is not set, its default value is false).

WARNING

Exercise caution when using this operation, especially when barcodes are tied to operational documents and inventory management.

Retrieving Product Barcodes

To verify whether a barcode is linked to the suite, you can use two services:

Get SKU from barcode: Checks if a specific barcode exists on the product. (API Reference)

Get SKU's barcodes: Retrieves all barcodes associated with a specific product. (API Reference)

Restrictions on Barcode Removal

Barcodes that have been included in warehouse or sales documents cannot be removed. This restriction ensures data consistency since these barcodes have already been used to manage inventory movements. However, it is possible to force deletion by bypassing this check using the ignore_movements=false parameter.

Barcodes in Documents

Deleting barcodes that are referenced in documents is a critical operation. It disrupts the alignment between products, SKUs/barcodes, documents, inventory, and warehouse movements.

Impact on Documents and Inventory: After removal, affected documents and inventory will still reflect the removed barcode. This discrepancy is further complicated if the barcode is later assigned to another product.

Warehouse Movements: Historical warehouse movements will show operations related to both the previous and current product assignments for the barcode.

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 barcode specified in {BARCODE} must exist in the system.

Main Success Scenario

The client sends a DELETE request with a valid {BARCODE} and optional query parameter ignore_movements.

The API verifies that the barcode exists.

If ignore_movements=false and there are no inventory movements associated with the barcode, it is removed, and the API returns a success message.

If ignore_movements=true, the API will delete the barcode regardless of inventory movement status (not recommended).

Alternate Flows

Barcode Has Movement Constraints (409)

If ignore_movements=false and the barcode is associated with inventory movements, the API returns a 409 Conflict error.

Response:

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

Barcode Not Found (404)

If the {BARCODE} does not exist, the API returns a 404 Not Found error.

Response:

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

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

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

API Documentation: Remove Specific Barcode#

Retrieving Product Barcodes#

Restrictions on Barcode Removal#

Actors#

Preconditions#

Main Success Scenario#

Alternate Flows#

Sequence Diagram#

Code Examples in Node.js#

Request

Request Code Samples

Responses

API Documentation: Remove Specific Barcode

Retrieving Product Barcodes

Restrictions on Barcode Removal

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js