Generate missing barcodes

Generate Missing Barcodes for SKUs

This API enables the automatic generation of barcodes for all SKUs of a specified product {ITEM_CODE} that currently lack barcodes.

Products and dimensions

For more detail about Products ad dimensions please refeare to use case Product dimensions.

The barcode type is specified in the request body.
Upon successful execution, the API returns the list of SKUs for which barcodes have been generated, along with the corresponding EAN13 codes.

Barcode type

Currently, only EAN13 is supported for barcode generation.

Actors

API Client: The system or user initiating the request.

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

Preconditions

The ITEM_CODE should be valid and correspond to an existing product in the system.

The barcode type must be specified in the request body, and only EAN13 is currently supported.

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

Main Success Scenario

The client sends a POST request with a valid ITEM_CODE and specifies barcode_type in the request body.

The API checks each SKU associated with the product code for missing barcodes.

For SKUs without barcodes, the API generates EAN13 barcodes and returns a success message with the list of generated barcodes.

TIP

To generate a barcode for a specific SKU, please utilize the Generate missing barcode for SKU service.

Alternate Flows

Invalid Product Code or Dimensions (404)

If the ITEM_CODE or any required dimension group is not found, the API returns a 404 error with a descriptive message.

Response:

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

NOTE

Barcodes generated are in the specify format with a system-configured prefix.

The API does not guarantee consecutive numbering of barcode numbers.

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

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

Example

{
    "success": true,
    "insertedBarcodes": [
        {
            "barcode": "2000021035010",
            "dimension_level_1": "4",
            "dimension_level_2": "080"
        },
        {
            "barcode": "2000021035027",
            "dimension_level_1": "4",
            "dimension_level_2": "020"
        },
        {
            "barcode": "2000021035034",
            "dimension_level_1": "8",
            "dimension_level_2": "080"
        },
        {
            "barcode": "2000021035041",
            "dimension_level_1": "8",
            "dimension_level_2": "020"
        },
        {
            "barcode": "2000021035058",
            "dimension_level_1": "10",
            "dimension_level_2": "080"
        },
        {
            "barcode": "2000021035065",
            "dimension_level_1": "10",
            "dimension_level_2": "020"
        }
    ]
}

🟠422error - barcode exists

🟠403Operation not allowed

🟠401Authentication failed

🟠422Unique constraint error

Generate missing barcodes