Activate product variants and add barcodes to SKUs

Use Case Description

The objective of this use case is to catalog the active variants of a product along with the barcodes that uniquely identify each SKU (Stock Keeping Unit). Each SKU represents a specific combination of dimensions, such as size and color, which describe a unique version of a product. For example, if a product, MAGLIA123, has size and color as dimensions, and uses "EU Sizes" and "Pastel Colors" as dimension groups, an SKU could be MAGLIA123-XL-RED. Each SKU can be linked to one or more barcodes. However, not every product has every dimension combination, as variants are defined by the supplier's catalog.

To achieve this, the process will involve:

Creating the product.

Activating desired variants (dimensions).

Associating barcodes to the SKU for precise identification.

Actors

API Client: External system or user interacting with the API to census the product and SKUs.

4ws.Trade: 4ws.trade suite that manages products, dimensions, and barcodes.

Supplier: Defines available dimensions for each product.

Preconditions

The product to be cataloged has dimensions (e.g., size, color) defined in the system.

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

APIs Used

Insert product: Creates a new product.

Insert active dimensions: Activates desired dimensions for a product.

Insert barcode: Associates barcodes to the product SKU.

If you want to leave the barcode generation to the 4ws.trade suite, you can also invoke the APIs Generate missing barcodes or Generate missing barcode for SKU

Main Success Scenario

Create the Product
Using Insert product, the client creates a product (e.g., MAGLIA123).

Activate Desired Variants
For each dimension type (e.g., size, color), the client activates the required variants using Insert active dimensions.

Example Call:

Associate Barcodes to the SKU
For each SKU generated by the product dimensions, the client associates barcodes using Insert barcode.

Example Call:

Alternate Flows

Error in Barcode Submission
If the submitted barcode already exists for another SKU, the API will respond with an error. The client should verify barcode uniqueness before resubmitting.

Inactivation of a Variant
If a variant is no longer offered, it should be deactivated by updating the product dimensions API to remove the specified dimension.

Sequence Diagram

Best Practices

Please refer to Best Practices for Error Handling in External System for best practices on implementation.

Activate product variants and add barcodes to SKUs