Cataloging a Dimension

Use Case: Cataloging a Dimension

Cataloging dimensions in our system is essential for managing product variants efficiently. This use case outlines the steps a user must follow to catalog a new dimension, from defining dimension types to associating them with products.

Prerequisites

Before you begin, make sure you understand how system dimensions are managed Product dimensions
Ensure that the tenant creation phase has been completed and the dimension types have been established. Dimension types are immutable post-creation.
The external system must have the necessary permissions and access to the document creation service, please refer to Authentication.

Steps

Step 1: Define Dimension Types

During the tenant creation phase, dimension types such as SIZE and COLOR are defined. These provide the foundation for all subsequent dimension-related activities.

Step 2: Create Dimensional Groups

Dimensional groups categorize related dimensions. You can create these groups via the user interface or API.

Refer to our Insert dimension group API for more details.

Step 3: Define Dimensions

Once dimensional groups are established, define individual dimensions within each group. Each dimension must be linked to a specific group and type.

Refer to our Insert dimension API for more details.

Step 4: Add New Product and Associate Dimensional Group

Create a new product and associate it with a dimensional group.

Refer to our Insert product for more details.

Example Workflow

Define Dimension Types

For example, SIZE and COLOR

Create Dimensional Groups

For example, "European Sizes" and "American Sizes". Call Insert dimension group

Define Dimensions

For example, "Small", "Medium", "Large" for "European Sizes". Call Insert dimension

Add New Product and Associate Dimensional Group

For example, create a product Shirt with "European Sizes". Call Insert product. Assign "European Sizes" to a product.

Activate/Deactivate Dimensions

Depending on the product, activate or deactivate specific dimensions such as "Medium" or "Large". Call Activate dimensions on products.

This example illustrates a typical error handling flow when a client attempts to create a dimension in our system. The process highlights how the system responds to missing data and guides the client through the necessary steps to resolve the issue.

Cataloging a Dimension

Use Case: Cataloging a Dimension#

Prerequisites#

Steps#

Step 1: Define Dimension Types#

Step 2: Create Dimensional Groups#

Step 3: Define Dimensions#

Step 4: Add New Product and Associate Dimensional Group#

Example Workflow#