Workflows

createAttributePossibleValuesWorkflow

This documentation provides a reference to the createAttributePossibleValuesWorkflow. It belongs to the @mercurjs/b2c-core package. This workflow creates one or more possible values for an attribute. Source code

Examples

API Route

packages/modules/b2c-core/src/api/admin/attributes/[id]/values/route.ts

import { AuthenticatedMedusaRequest, MedusaResponse } from "@medusajs/framework";
import { createAttributePossibleValuesWorkflow } from "../../../../../workflows/attribute/workflows/create-attribute-possible-values";
import { CreateAttributeValueDTO } from "@mercurjs/framework";

export const POST = async (
  req: AuthenticatedMedusaRequest<Omit<CreateAttributeValueDTO, 'attribute_id'>>,
  res: MedusaResponse
) => {
  const attributeId = req.params.id;

  const { result } = await createAttributePossibleValuesWorkflow(req.scope).run({
    input: [
      {
        ...req.validatedBody,
        attribute_id: attributeId,
      },
    ],
  });

  res.json({ attribute_value: result[0] });
};

Steps

createAttributePossibleValuesStep: This step creates one or more attribute possible values.

Input

input

CreateAttributeValueDTO[]

required

The list of attribute values to create.

Show properties

value

string

required

The value of the attribute option (e.g. “Red”, “XL”).

rank

number

required

The rank or order of the value used for sorting.

attribute_id

string

required

The ID of the attribute this value belongs to.

metadata

Record<string, unknown>

Holds custom data in key-value pairs.

Output

AttributePossibleValueDTO[]

The created attribute possible values.

Show properties

string

The ID of the attribute value.

value

string

The value of the attribute option.

rank

number

The rank of the value.

attribute_id

string

The ID of the parent attribute.

metadata

Record<string, unknown>

Holds custom data in key-value pairs.

createAttributeValueWorkflow

This documentation provides a reference to the createAttributeValueWorkflow. It belongs to the @mercurjs/b2c-core package. This workflow creates an attribute value for a product and links it to the product. It handles the creation of the attribute value and the remote link between the product and the attribute value. It also includes validation to ensure the value is allowed for the attribute and that the product is associated with the attribute’s categories. Source code

Examples

API Route
Another Workflow

packages/modules/b2c-core/src/api/vendor/products/[id]/options/route.ts

import { AuthenticatedMedusaRequest, MedusaResponse } from "@medusajs/framework";
import { createAttributeValueWorkflow } from "../../../../../workflows/attribute/workflows/create-attribute-value";
import { CreateProductAttributeValueDTO } from "@mercurjs/framework";

export const POST = async (
  req: AuthenticatedMedusaRequest<Omit<CreateProductAttributeValueDTO, 'product_id'>>,
  res: MedusaResponse
) => {
  const productId = req.params.id;

  const { result } = await createAttributeValueWorkflow(req.scope).run({
    input: {
      ...req.validatedBody,
      product_id: productId,
    },
  });

  res.json({ attribute_value: result });
};

packages/modules/b2c-core/src/workflows/attribute/utils/products-created-handler.ts

import { createAttributeValueWorkflow } from "../workflows/create-attribute-value";

// ... inside productsCreatedHandler

await createAttributeValueWorkflow(container).run({
  input: {
    attribute_id: attributeId,
    product_id: product.id,
    value: attributeValue,
  },
});

Steps

validateAttributeValueStep: Validates that the value is allowed for the attribute and the product is compatible.
createAttributeValueStep: Creates the attribute value record.
createRemoteLinkStep: Links the created attribute value to the product.

Input

input

CreateProductAttributeValueDTO

required

The details of the attribute value to create and link.

Show properties

attribute_id

string

required

The ID of the attribute.

product_id

string

required

The ID of the product to assign the value to.

value

string

required

The value to assign (must be one of the possible values if defined).

Output

AttributeValueDTO

The created attribute value.

Show properties

string

The ID of the attribute value.

value

string

The assigned value.

attribute_id

string

The ID of the attribute.

createAttributesWorkflow

This documentation provides a reference to the createAttributesWorkflow. It belongs to the @mercurjs/b2c-core package. This workflow creates one or more attributes and optionally links them to product categories. Source code

Examples

API Route

packages/modules/b2c-core/src/api/admin/attributes/route.ts

import { AuthenticatedMedusaRequest, MedusaResponse } from "@medusajs/framework";
import { createAttributesWorkflow } from "../../../workflows/attribute/workflows/create-attributes";
import { CreateAttributeDTO } from "@mercurjs/framework";

export const POST = async (
  req: AuthenticatedMedusaRequest<CreateAttributeDTO>,
  res: MedusaResponse
) => {
  const { result } = await createAttributesWorkflow(req.scope).run({
    input: {
      attributes: [
        {
          ...req.validatedBody,
          product_category_ids: req.validatedBody.product_category_ids,
        },
      ],
    },
  });

  res.json({ attribute: result[0] });
};

Steps

createAttributesStep: Creates the attributes.
createRemoteLinkStep: Links the created attributes to the specified product categories.

Input

input

object

required

Show properties

attributes

CreateAttributeDTO[]

required

The list of attributes to create.

Show properties

name

string

required

The name of the attribute.

ui_component

string

required

The UI component type (e.g., ‘select’, ‘text’).

description

string

The description of the attribute.

handle

string

The handle for the attribute. Defaults to slugified name.

is_filterable

boolean

Whether the attribute can be used for filtering.

is_required

boolean

Whether the attribute is required.

product_category_ids

string[]

List of product category IDs to link this attribute to.

possible_values

CreateAttributeValueDTO[]

List of possible values for this attribute.

Output

AttributeDTO[]

The created attributes.

Show properties

string

The ID of the attribute.

name

string

The name of the attribute.

handle

string

The handle of the attribute.

deleteAttributeValueWorkflow

This documentation provides a reference to the deleteAttributeValueWorkflow. It belongs to the @mercurjs/b2c-core package. This workflow deletes one or more attribute values (the actual assigned values to products, not the definition possible values) and cleans up the links to products. Source code

Examples

API Route

packages/modules/b2c-core/src/api/vendor/products/[id]/options/[option_id]/route.ts

import { AuthenticatedMedusaRequest, MedusaResponse } from "@medusajs/framework";
import { deleteAttributeValueWorkflow } from "../../../../../../workflows/attribute/workflows/delete-attribute-value";

export const DELETE = async (
  req: AuthenticatedMedusaRequest,
  res: MedusaResponse
) => {
  const optionId = req.params.option_id;

  await deleteAttributeValueWorkflow(req.scope).run({
    input: optionId,
  });

  res.status(200).json({
    id: optionId,
    object: "attribute_value",
    deleted: true,
  });
};

Steps

useQueryGraphStep: Fetches the links between the attribute values and products to be dismissed.
deleteAttributeValueStep: Soft deletes the attribute values.
dismissRemoteLinkStep: Removes the links between the attribute values and products.

Input

input

string | string[]

required

The ID or IDs of the attribute values to delete.

Output

string[]

The IDs of the deleted attribute values.

deleteAttributeWorkflow

This documentation provides a reference to the deleteAttributeWorkflow. It belongs to the @mercurjs/b2c-core package. This workflow deletes an attribute definition. Source code

Examples

API Route

packages/modules/b2c-core/src/api/admin/attributes/[id]/route.ts

import { AuthenticatedMedusaRequest, MedusaResponse } from "@medusajs/framework";
import { deleteAttributeWorkflow } from "../../../../workflows/attribute/workflows/delete-attribute";

export const DELETE = async (
  req: AuthenticatedMedusaRequest,
  res: MedusaResponse
) => {
  const attributeId = req.params.id;

  await deleteAttributeWorkflow(req.scope).run({
    input: {
      id: attributeId,
    },
  });

  res.status(200).json({
    id: attributeId,
    object: "attribute",
    deleted: true,
  });
};

Steps

deleteAttributeStep: Deletes the attribute and its associated links.

Input

input

object

required

Show properties

string

required

The ID of the attribute to delete.

Output

void

The workflow does not return a value.

updateAttributePossibleValueWorkflow

This documentation provides a reference to the updateAttributePossibleValueWorkflow. It belongs to the @mercurjs/b2c-core package. This workflow updates a possible value definition of an attribute (e.g., changing “Blue” to “Navy”). Source code

Examples

API Route

packages/modules/b2c-core/src/api/admin/attributes/[id]/values/[value_id]/route.ts

import { AuthenticatedMedusaRequest, MedusaResponse } from "@medusajs/framework";
import { updateAttributePossibleValueWorkflow } from "../../../../../../workflows/attribute/workflows/update-attribute-possible-value";
import { UpdateAttributeValueDTO } from "@mercurjs/framework";

export const POST = async (
  req: AuthenticatedMedusaRequest<UpdateAttributeValueDTO>,
  res: MedusaResponse
) => {
  const valueId = req.params.value_id;

  const { result } = await updateAttributePossibleValueWorkflow(req.scope).run({
    input: {
      ...req.validatedBody,
      id: valueId,
    },
  });

  res.json({ attribute_value: result });
};

Steps

updateAttributePossibleValueStep: Updates the attribute possible value.

Input

input

UpdateAttributeValueDTO

required

The details to update.

Show properties

string

required

The ID of the possible value to update.

value

string

The new value.

rank

number

The new rank.

metadata

Record<string, unknown>

New metadata.

Output

AttributePossibleValueDTO

The updated attribute possible value.

updateAttributesWorkflow

This documentation provides a reference to the updateAttributesWorkflow. It belongs to the @mercurjs/b2c-core package. This workflow updates one or more attributes, including their details, possible values, and category associations. Source code

Examples

API Route

packages/modules/b2c-core/src/api/admin/attributes/[id]/route.ts

import { AuthenticatedMedusaRequest, MedusaResponse } from "@medusajs/framework";
import { updateAttributesWorkflow } from "../../../../workflows/attribute/workflows/update-attributes";
import { AdminUpdateAttributeType } from "../../validators";

export const POST = async (
  req: AuthenticatedMedusaRequest<AdminUpdateAttributeType>,
  res: MedusaResponse
) => {
  const attributeId = req.params.id;

  await updateAttributesWorkflow(req.scope).run({
    input: {
      attributes: [
        {
          ...req.validatedBody,
          id: attributeId,
          product_category_ids:
            req.validatedBody.product_category_ids?.map((id) => ({ id })) ||
            undefined,
        },
      ],
    },
  });

  // ... fetch and return updated attribute
};

Steps

updateAttributesStep: Updates the attributes and their possible values.
useQueryGraphStep: Fetches current category links to determine what to add or remove.
dismissRemoteLinkStep: Removes links to categories that are no longer associated.
createRemoteLinkStep: Creates links to newly associated categories.

Input

input

object

required

Show properties

attributes

UpdateAttributeDTO[]

required

The list of attributes to update.

Show properties

string

required

The ID of the attribute.

name

string

The new name.

product_category_ids

string[]

The new list of product category IDs. Replaces existing links.

possible_values

CreateAttributeValueDTO[]

The new list of possible values. This handles upsert/replace logic.

Output

AttributeDTO[]

The updated attributes.

Steps

Output

void

No return value.

updateAttributePossibleValueStep

Updates a single attribute possible value. Source code

Input

payload

UpdateAttributeValueDTO

required

The update data.

Output

AttributePossibleValueDTO

The updated value.

updateAttributesStep

Updates attributes and their possible values. Uses upsert/replace logic for values. Source code

Input

data

UpdateAttributeDTO[]

required

List of attributes to update.

Output

AttributeDTO[]

The updated attributes.

validateAttributeValueStep

Validates that a value is allowed for a given attribute and product. It checks:

If the value is in the attribute’s possible_values (if restricted).
If the product belongs to a category allowed by the attribute.
If the product already has a value for this attribute (duplicate check).

Source code

Input

input

CreateProductAttributeValueDTO

required

The value creation payload to validate.

Output

void

Throws an error if validation fails.

Quick start

Components

Core Concepts

Product

Integrations

Deployment

Help

​Workflows

​createAttributePossibleValuesWorkflow

​Examples

​Steps

​Input

​Output

​createAttributeValueWorkflow

​Examples

​Steps

​Input

​Output

​createAttributesWorkflow

​Examples

​Steps

​Input

​Output

​deleteAttributeValueWorkflow

​Examples

​Steps

​Input

​Output

​deleteAttributeWorkflow

​Examples

​Steps

​Input

​Output

​updateAttributePossibleValueWorkflow

​Examples

​Steps

​Input

​Output

​updateAttributesWorkflow

​Examples

​Steps

​Input

​Output

​Steps

​createAttributePossibleValuesStep

​Input

​Output

​createAttributeValueStep

​Input

​Output

​createAttributesStep

​Input

​Output

​deleteAttributeValueStep

​Input

​Output

​deleteAttributeStep

​Input

​Output

​updateAttributePossibleValueStep

​Input

​Output

​updateAttributesStep

​Input

​Output

​validateAttributeValueStep

​Input

​Output

Workflows

createAttributePossibleValuesWorkflow

Examples

Steps

Input

Output

createAttributeValueWorkflow

Examples

Steps

Input

Output

createAttributesWorkflow

Examples

Steps

Input

Output

deleteAttributeValueWorkflow

Examples

Steps

Input

Output

deleteAttributeWorkflow

Examples

Steps

Input

Output

updateAttributePossibleValueWorkflow

Examples

Steps

Input

Output

updateAttributesWorkflow

Examples

Steps

Input

Output

Steps

createAttributePossibleValuesStep

Input

Output

createAttributeValueStep

Input

Output

createAttributesStep

Input

Output

deleteAttributeValueStep

Input

Output

deleteAttributeStep

Input

Output

updateAttributePossibleValueStep

Input

Output

updateAttributesStep

Input

Output

validateAttributeValueStep

Input

Output