Insert barcode

Insert Barcode for Specific SKU

This API allows the insertion of a barcode for a specific SKU identified by product {ITEM_CODE}, along with details such as the barcode type and dimension levels from dimension_level1 to dimension_level5. If the barcode is successfully inserted, the API returns the generated internal code (prog_id) and the barcode itself.

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

The provided dimensions (dimension_level1, dimension_level2, etc.) must uniquely identify the SKU for which the barcode is being added.

The barcode must be unique for each SKU; attempts to insert an already-existing barcode will result in an error.

Main Success Scenario

The client sends a POST request with a valid ITEM_CODE, barcode_type, dimensions, and the barcode itself.

The API verifies the SKU details and checks if the barcode is unique.

If validation is successful, the barcode is inserted, and the API returns a success response with the prog_id and barcode information.

Alternate Flows

Barcode Already Exists (400)

If the barcode already exists in the system, the API returns a 400 error indicating a unique constraint violation.

Response:

{
  "message": "Unique constraint error, this barcode 8050200058081 already exists"
}

Product or SKU Not Found (404)

If the ITEM_CODE or specified dimensions do not match any existing SKU, the API returns a 404 error.

Response:

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

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

Insert Barcode for Specific SKU#

Actors#

Preconditions#

Main Success Scenario#

Alternate Flows#

Sequence Diagram#

Code Examples in Node.js#

Request

Request Code Samples

Responses

Insert Barcode for Specific SKU

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js