Get SKU's barcodes

Retrieve All Barcodes for a Product SKU

This API allows retrieval of all barcodes associated with a specific product SKU. The SKU consists of the product code ({ITEM_CODE}) and up to five dimension levels (DIMENSION_LEVEL1 to DIMENSION_LEVEL5), which represent various product variants.

The API supports pagination to navigate through large lists of barcodes.

Paginated Responses

The service is paginated to handle large sets of data efficiently.
For detailed information on how to handle pagination, refer to our Paginated Responses

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 service, please refer to Authentication.

A valid ITEM_CODE must be provided.

At least one DIMENSION_LEVEL must be specified if the product SKU is variant-specific.

Pagination parameters cursor and nextCursor must be correctly configured in the request.

Main Success Scenario

If the request is successful, the system will return an HTTP 200 response with the paginated list of product barcodes and a nextCursor indicating whether there are more product barcodes to retrieve. If nextCursor is setted, the external system must be call again, this service, setting cursor as nextCursor value.

Response Example

Retrieve All Barcodes of a Product

You can retrieve all barcodes of a product by querying this service. In this case, only the product code needs to be provided.

The response will include all barcodes and SKUs of the product.

Filter Specific Barcodes of a Product

If for example you want to retrieve only the barcodes associated with size 0-3, in addition to the product code, you can specify the desired size.

Alternatively, retrieve all barcodes and SKUs associated with size 0-3 and color Red:

Alternate Flows

Authentication Error: If the client does not provide valid credentials, an error response is returned.

Error Example

No Barcodes Found
If no barcodes are found for the specified SKU, the response contains an empty barcodes array, and moreRows=false.

Error Example

SKU Not Found (404)
If the specified SKU or dimension group does not exist, the API returns a 404 error.

Error Example

Invalid Dimension Level
If an invalid dimension level is specified, the API returns a 400 error indicating a validation error.

Error Example

Cursor & PageSize Used Together: Cursor and PageSize parameters in the request: If you specify a Cursor you cannot specify the page size. This information will already be contained within the cursor.

Error Example

Pagination Error: If invalid cursor parameters are provided, an error response is returned.

Rate Limiting: If the API rate limits are exceeded, the client must respect the retry interval indicated in the response headers Rate Limits.

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

Responses

🟢200success

application/json

Body

Example

{
    "barcodes": [
        {
            "barcode": "9780201379624",
            "barcode_type": "EAN13",
            "dimension_level1": "XL",
            "dimension_level2": "RED"
        }
    ],
    "nextCursor": "eyJwYWdlIjoyLCJwYWdlU2l6ZSI6MTB2"
}

🟢200success - more rows

🟠404fail - item not found

🟠401Authentication failed

🟠403Operation not allowed

🟠422Unique constraint error

Get SKU's barcodes

Retrieve All Barcodes for a Product SKU#

Actors#

Preconditions#

Main Success Scenario#

Retrieve All Barcodes of a Product#

Filter Specific Barcodes of a Product#

Alternate Flows#

Sequence Diagram#

Code Examples in Node.js#

Request

Request Code Samples

Responses

Retrieve All Barcodes for a Product SKU

Actors

Preconditions

Main Success Scenario

Retrieve All Barcodes of a Product

Filter Specific Barcodes of a Product

Alternate Flows

Sequence Diagram

Code Examples in Node.js