Generate missing barcode for SKU

Generate Barcode for Specific SKU

This API allows the generation of a barcode for a specific SKU of a product {ITEM_CODE} that currently lacks one. The request requires specifying the barcode type (barcode_type) as well as one or more dimension levels (dimension_level1 to dimension_level5) to identify the SKU uniquely.

Upon success, the API returns the generated barcode for the specified SKU along with the dimension levels used to identify it.

Products and dimensions

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

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 ITEM_CODE must be valid and correspond to an existing product in the system.

The specified dimensions (dimension_level1, dimension_level2, etc.) must uniquely identify a SKU that lacks a barcode.

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

Main Success Scenario

The client sends a POST request with a valid ITEM_CODE, barcode_type, and specified dimension levels.

The API verifies that the SKU lacks a barcode and then generates an EAN13 barcode for it.

The API returns a success message with the generated barcode and SKU details.

{
  "success": true,
  "insertedBarcodes": [
    {
      "barcode": "1212121",
      "dimension_level1": "XL",
      "dimension_level2": "RED"
    }
  ]
}

Alternate Flows

Invalid Product Code or Dimensions (404)

If the ITEM_CODE or required dimensions are not found, the API returns a 404 error with a descriptive message.

Response:

{
  "message": "Product or SKU not found with specified dimensions"
}

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

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Body Params application/json

Example

{
    "barcode_type": "EAN13",
    "dimension_level1": "1",
    "dimension_level2": "Y4",
    "barcode": "8050200058081"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Generate missing barcode for SKU

Generate Barcode for Specific SKU#

Actors#

Preconditions#

Main Success Scenario#

Alternate Flows#

Sequence Diagram#

Code Examples in Node.js#

Request

Request Code Samples

Responses

Generate Barcode for Specific SKU

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js