Get SKU from barcode

Retrieve SKU Associated with a Barcode

This API allows the retrieval of the SKU associated with a specific barcode ({BARCODE}). If a SKU is found, the API returns the product's item code, dimensions, and a flag (moved) indicating whether this SKU has been recorded in any inventory movement documents.

Actors

API Client: The system or user initiating the request.

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

Preconditions

A valid BARCODE must be provided in the request.

The barcode should be present in the system to yield associated SKU information; otherwise, a 404 error will be returned.

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 GET request with a valid BARCODE.

The API checks for a SKU associated with the barcode.

If the SKU exists, the API returns the item code, dimensions, barcode type, and moved status.

{
    "sku": {
        "item_code": "0233",
        "dimension_group2": "0",
        "barcode_type": "EAN13",
        "dimension_level1": "5",
        "dimension_level2": "1",
        "moved": true
    }
}

moved SKU, Barcodes in Documents

If moved is true this means that SKU is referenced in documents.
Deleting barcodes or sku 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.

Alternate Flows

Barcode Not Found (404)

If the specified barcode is not found, the API returns a 404 error with a message indicating that the barcode is unrecognized.

Response:

{
  "message": "Barcode not found: {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 ********************

Responses

🟢200Success

application/json

Body

Example

{
    "sku": {
        "item_code": "CAMICIA_ROSSA",
        "dimension_group1": "1",
        "dimension_group2": "1",
        "barcode_type": "EAN13",
        "dimension_level1": "1",
        "dimension_level2": "Y4",
        "moved": false
    }
}

🟢200Success - ARTICOLO_GENERICO

🟠401Authentication failed

🟠403Operation not allowed

🟠422Unique constraint error

Get SKU from barcode

Retrieve SKU Associated with a Barcode

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js

Request

Request Code Samples

Responses

Get SKU from barcode

Retrieve SKU Associated with a Barcode#

Actors#

Preconditions#

Main Success Scenario#

Alternate Flows#

Sequence Diagram#

Code Examples in Node.js#

Request

Request Code Samples

Responses

Retrieve SKU Associated with a Barcode

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js