Create a New Product

An external system needs to create a new product in the Four Way Shop.
Product creation is a multi-step process that depends on the prior configuration of several master data entities (dimensions, brand, attributes, etc.).

The system will return the internal identifier (prog_id) and the product code (item_code) once the product is successfully created.

Important

Product creation is not an isolated operation. It requires that all dependent master data entities are already configured and available in the tenant.

Use Case Description

This use case describes the end-to-end process that an external system must follow to correctly create a product in Four Way Shop, including:

Dependency setup (master data)

Product creation

Dimension and barcode activation

Price assignment

Image association

Actors

API Client: The system or user initiating the request.

Four Way Shop API: The backend system that processes the request.

Preconditions

The tenant must be properly configured with:

Dimension Types

Hierarchy Types

The following master data must already exist:

Dimensions

Brands

Countries (Made In)

Seasons

Size Groups

Attributes

Hierarchies

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

Read this

Product structure

Dimension group vs Dimension grouping

Product dimensions

Product pricing

Product Images

All referenced codes (e.g., brand_code, season_code) must be valid.

APIs Used

Master Data APIs

Brands

→ Get All Brands

→ Insert brand

Seasons

→ Get All Seasons

→ Insert season

Dimensions Groups

→ Insert dimension group

Dimensions

→ Insert dimension

Attributes Types

→ Get All Attribute Types

Attributes

→ Insert attribute

Hierarchies

→ Insert hierarchy

Product APIs

Create Product → Product structure

Assign Barcodes → Insert barcode

Autogenerate barcode

It is possible to generate barcodes directly through Four Way Shop by enabling product dimensions, please follow this use case.
Activate product dimension and add barcodes to SKUs

Pricing APIs

Price Lists → Defining Product Pricing

Media APIs

Product Images → Product Images

Main Success Scenario

Verify Master Data
Ensure all required entities exist.

Create Dimensions
Call POST /api/v1/dimensions/{DIMENSION_TYPE}/{DIMENSION_GROUP}/

Create Product
Call POST /api/v1/products

Assign Barcodes
Call POST /api/v1/products/{ITEM_CODE}/barcodes

Assign Prices
Use pricing APIs

Upload Product Image
Use media APIs

Example Success Response

{
  "product": {
    "prog_id": 120394,
    "item_code": "TSHIRT-SS25-001"
  }
}

Alternate Flows

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

Error Unauthorized Example

Missing Master Data

Error Example

Dimensions Creation Failure

Error Example

Duplicate Product Code

Error Example

Barcode Already Assigned

Error Example

Callback Response

{
  "status": "SUCCESS",
  "product": {
    "prog_id": 120394,
    "item_code": "TSHIRT-SS25-001"
  }
}

Create a New Product