@mercurjs/docs 2.2.1 → 2.3.0-canary.1

package/content/references/workflows/payout/process-payout-for-webhook.mdx

@@ -1,34 +0,0 @@
----
-title: "processPayoutForWebhookWorkflow"
-description: "Apply a payout provider webhook event to the matching account or payout."
----
-
-Maps a normalized provider webhook action to a status update: account events set the payout account to `active`, `restricted`, or `rejected`; payout events set the payout to `processing`, `paid`, `failed`, or `canceled`. Unsupported actions (or events without an ID) are ignored. Triggered by the `payout-webhook` subscriber after the payout provider parses the raw webhook payload.
-
-## Usage
-
-```ts
-import { processPayoutForWebhookWorkflow } from "@mercurjs/core/workflows"
-
-await processPayoutForWebhookWorkflow(container).run({
-  input: {
-    action: "payout.paid",
-    data: { id: "payout_123" },
-  },
-})
-```
-
-## Input
-
-<ParamField body="action" type="string" required>One of `account.activated`, `account.restricted`, `account.rejected`, `payout.processing`, `payout.paid`, `payout.failed`, `payout.canceled`, `not_supported`.</ParamField>
-<ParamField body="data" type="object">
-  Event target; nothing happens when omitted.
-
-  <Expandable title="properties">
-    <ParamField body="id" type="string" required>The ID of the payout account (for `account.*` actions) or the payout (for `payout.*` actions).</ParamField>
-  </Expandable>
-</ParamField>
-
-## Result
-
-<ResponseField name="result" type="void">No return value; the matching account or payout status is updated as a side effect.</ResponseField>

package/content/references/workflows/product/confirm-products.mdx

@@ -1,48 +0,0 @@
----
-title: "confirmProductsWorkflow"
-description: "Approve proposed products and publish them to the catalog."
----
-
-Approves products awaiting review: validates every product is in `proposed` status, sets them to `published`, and records a confirmed `STATUS_CHANGE` audit action per product. Triggered by `POST /admin/products/:id/confirm`. Emits `product.published` with one `{ id, internal_note }` entry per product.
-
-## Usage
-
-```ts
-import { confirmProductsWorkflow } from "@mercurjs/core/workflows"
-
-await confirmProductsWorkflow(container).run({
-  input: {
-    product_ids: ["prod_01H..."],
-    actor_id: "user_01H...",
-    internal_note: "Approved after review",
-  },
-})
-```
-
-## Input
-
-<ParamField body="product_ids" type="string[]" required>
-  Ids of the products to publish. Every product must currently be in `proposed` status.
-</ParamField>
-
-<ParamField body="actor_id" type="string">
-  Actor id recorded on the audit trail entry.
-</ParamField>
-
-<ParamField body="internal_note" type="string">
-  Operator-only note stored on the audit change and included in the emitted event.
-</ParamField>
-
-<ParamField body="additional_data" type="object">Custom data passed through to the workflow hooks.</ParamField>
-
-## Result
-
-<ResponseField name="result" type="void">
-  Returns nothing; the products are updated in place.
-</ResponseField>
-
-## Hooks
-
-<ResponseField name="productsConfirmed" type="hook">
-  Runs after publishing with `{ product_ids, internal_note }`.
-</ResponseField>

package/content/references/workflows/product/create-products.mdx

@@ -1,63 +0,0 @@
----
-title: "createProductsWorkflow"
-description: "Create master catalog products with seller eligibility and creator attribution."
----
-
-Creates master catalog products, resolving Mercur `attributes` inputs into native product options and value links, linking each product to its eligible sellers (`product_seller` links), and recording a confirmed `PRODUCT_ADD` audit action attributed to `created_by`. Triggered by `POST /admin/products` and `POST /vendor/products`. Variants default to `manage_inventory: false` unless set explicitly. Emits `product.created`.
-
-## Usage
-
-```ts
-import { createProductsWorkflow } from "@mercurjs/core/workflows"
-
-const { result } = await createProductsWorkflow(container).run({
-  input: {
-    products: [{ title: "Linen Shirt", seller_ids: ["sel_01H..."] }],
-    created_by: "sel_01H...",
-  },
-})
-```
-
-## Input
-
-<ParamField body="products" type="object[]" required>
-  Products to create.
-  <Expandable title="properties">
-    <ParamField body="title" type="string" required>
-      The product title. All Medusa `CreateProductDTO` fields (handle, description, status, variants, categories, images, etc.) are accepted, except `options`.
-    </ParamField>
-    <ParamField body="attributes" type="ProductAttributeBatchAdd[]">
-      Attribute inputs resolved into native options and value links — `{ id, value_ids }` / `{ id, value }` for existing attributes, or `{ title, values, is_variant_axis }` / `{ title, type, value }` for inline ones. Do not pass native `options`.
-    </ParamField>
-    <ParamField body="seller_ids" type="string[]">
-      Seller ids to link to the product as eligible sellers.
-    </ParamField>
-    <ParamField body="variants" type="object[]">
-      Variants to create; `options` name-maps bind them to axis attributes. `manage_inventory` defaults to `false`.
-    </ParamField>
-  </Expandable>
-</ParamField>
-
-<ParamField body="created_by" type="string" required>
-  Actor id recorded on the `PRODUCT_ADD` audit action.
-</ParamField>
-
-<ParamField body="additional_data" type="object">
-  Arbitrary data forwarded to the underlying Medusa create workflows and the `productsCreated` hook.
-</ParamField>
-
-## Result
-
-<ResponseField name="result" type="ProductDTO[]">
-  The created products, including their generated ids, options, and statuses.
-</ResponseField>
-
-## Hooks
-
-<ResponseField name="validate" type="hook">
-  Runs first with `{ input, products }` — use it to reject invalid payloads before anything is created.
-</ResponseField>
-
-<ResponseField name="productsCreated" type="hook">
-  Runs after creation with `{ products, additional_data }`.
-</ResponseField>

package/content/references/workflows/product/link-sellers-to-product-category.mdx

@@ -1,40 +0,0 @@
----
-title: "linkSellersToProductCategoryWorkflow"
-description: "Add or remove seller eligibility links on a product category."
----
-
-Updates which sellers are allowed to sell in a product category by creating and removing seller–category links in one call — the mechanism behind restricted categories. Triggered by `POST /admin/product-categories/:id/sellers`. No events are emitted.
-
-## Usage
-
-```ts
-import { linkSellersToProductCategoryWorkflow } from "@mercurjs/core/workflows"
-
-await linkSellersToProductCategoryWorkflow(container).run({
-  input: {
-    id: "pcat_01H...",
-    add: ["sel_01H..."],
-    remove: ["sel_01J..."],
-  },
-})
-```
-
-## Input
-
-<ParamField body="id" type="string" required>
-  Id of the product category whose seller links are being updated.
-</ParamField>
-
-<ParamField body="add" type="string[]">
-  Seller ids to link to the category.
-</ParamField>
-
-<ParamField body="remove" type="string[]">
-  Seller ids to unlink from the category.
-</ParamField>
-
-## Result
-
-<ResponseField name="result" type="void">
-  Returns nothing; the links are created and removed in place.
-</ResponseField>

package/content/references/workflows/product/link-sellers-to-product.mdx

@@ -1,40 +0,0 @@
----
-title: "linkSellersToProductWorkflow"
-description: "Add or remove seller eligibility links on a master product."
----
-
-Updates which sellers are eligible for a master product by creating and removing `product_seller` links in one call. Triggered by `POST /admin/products/:id/sellers`. No events are emitted and the product record itself is untouched.
-
-## Usage
-
-```ts
-import { linkSellersToProductWorkflow } from "@mercurjs/core/workflows"
-
-await linkSellersToProductWorkflow(container).run({
-  input: {
-    id: "prod_01H...",
-    add: ["sel_01H..."],
-    remove: ["sel_01J..."],
-  },
-})
-```
-
-## Input
-
-<ParamField body="id" type="string" required>
-  Id of the product whose seller links are being updated.
-</ParamField>
-
-<ParamField body="add" type="string[]">
-  Seller ids to link to the product.
-</ParamField>
-
-<ParamField body="remove" type="string[]">
-  Seller ids to unlink from the product.
-</ParamField>
-
-## Result
-
-<ResponseField name="result" type="void">
-  Returns nothing; the links are created and removed in place.
-</ResponseField>

package/content/references/workflows/product/reject-product.mdx

@@ -1,48 +0,0 @@
----
-title: "rejectProductWorkflow"
-description: "Reject a proposed product submission with an optional message to the vendor."
----
-
-Rejects a product awaiting review: validates the product is in `proposed` status, sets it to `rejected`, and records a confirmed `STATUS_CHANGE` audit action whose `external_note` carries the rejection message. Triggered by `POST /admin/products/:id/reject`. Emits `product.rejected` with `{ id, message }`.
-
-## Usage
-
-```ts
-import { rejectProductWorkflow } from "@mercurjs/core/workflows"
-
-await rejectProductWorkflow(container).run({
-  input: {
-    product_id: "prod_01H...",
-    message: "Images do not meet marketplace guidelines",
-    actor_id: "user_01H...",
-  },
-})
-```
-
-## Input
-
-<ParamField body="product_id" type="string" required>
-  Id of the product to reject. Must currently be in `proposed` status.
-</ParamField>
-
-<ParamField body="message" type="string">
-  Vendor-facing rejection reason, stored as the audit change's `external_note` and included in the emitted event.
-</ParamField>
-
-<ParamField body="actor_id" type="string">
-  Actor id recorded on the audit trail entry.
-</ParamField>
-
-<ParamField body="additional_data" type="object">Custom data passed through to the workflow hooks.</ParamField>
-
-## Result
-
-<ResponseField name="result" type="void">
-  Returns nothing; the product status is updated in place.
-</ResponseField>
-
-## Hooks
-
-<ResponseField name="productRejected" type="hook">
-  Runs after rejection with `{ product_id, message }`.
-</ResponseField>

package/content/references/workflows/product/request-product-change.mdx

@@ -1,48 +0,0 @@
----
-title: "requestProductChangeWorkflow"
-description: "Ask a vendor to revise a proposed product submission without changing its status."
----
-
-Records an operator's request for revisions on a product awaiting review. Validates the product is in `proposed` status and records a confirmed `CHANGE_REQUESTED` audit action — the product itself is not mutated; the audit entry and its `external_note` are the durable signal to the vendor. Triggered by `POST /admin/products/:id/request-changes`. Emits `product.change-requested` with `{ id, message, actor_id }`.
-
-## Usage
-
-```ts
-import { requestProductChangeWorkflow } from "@mercurjs/core/workflows"
-
-await requestProductChangeWorkflow(container).run({
-  input: {
-    product_id: "prod_01H...",
-    message: "Please add care instructions to the description",
-    actor_id: "user_01H...",
-  },
-})
-```
-
-## Input
-
-<ParamField body="product_id" type="string" required>
-  Id of the product to request changes on. Must currently be in `proposed` status.
-</ParamField>
-
-<ParamField body="message" type="string">
-  Vendor-facing revision request, stored as the audit change's `external_note` and in the action's `details.message`.
-</ParamField>
-
-<ParamField body="actor_id" type="string">
-  Actor id recorded on the audit trail entry.
-</ParamField>
-
-<ParamField body="additional_data" type="object">Custom data passed through to the workflow hooks.</ParamField>
-
-## Result
-
-<ResponseField name="result" type="void">
-  Returns nothing; only an audit entry is created.
-</ResponseField>
-
-## Hooks
-
-<ResponseField name="productChangeRequested" type="hook">
-  Runs after the audit entry is recorded with `{ product_id, message }`.
-</ResponseField>

package/content/references/workflows/product-attribute/add-product-attributes-to-product.mdx

@@ -1,49 +0,0 @@
----
-title: "addProductAttributesToProductWorkflow"
-description: "Attach existing or inline attributes (and their values) to a product."
----
-
-Handles the `add` portion of the attribute batch engine (`createAndLinkProductAttributesToProductWorkflow`). Existing `text`/`unit` attributes get a new value created from `value`; `toggle` links the seeded `true`/`false` value; existing variant-axis `multi_select` attributes have their mirror `ProductOption` attached to the product with the selected value subset. Inline refs create a product-scoped attribute — axis refs also create an exclusive `ProductOption` — and link the values to the product.
-
-## Usage
-
-```ts
-import { addProductAttributesToProductWorkflow } from "@mercurjs/core/workflows"
-
-await addProductAttributesToProductWorkflow(container).run({
-  input: {
-    product_id: "prod_123",
-    add: [
-      { id: "pattr_material", value: "Cotton" },
-      { title: "Size", values: ["S", "M", "L"], is_variant_axis: true },
-    ],
-  },
-})
-```
-
-Also accepts an array of `{ product_id, add }` items to process several products in one run.
-
-## Input
-
-<ParamField body="product_id" type="string" required>The product to attach the attributes to.</ParamField>
-<ParamField body="add" type="ProductAttributeBatchAdd[]" required>
-  Attribute refs to attach.
-  <Expandable title="properties">
-    <ParamField body="id" type="string">Id of an existing attribute (existing form).</ParamField>
-    <ParamField body="value_ids" type="string[]">Attribute value ids to link (select types / axis subset).</ParamField>
-    <ParamField body="value" type="string | number | boolean">Scalar for `text` / `unit` / `toggle` attributes.</ParamField>
-    <ParamField body="title" type="string">Name of the inline attribute to create (inline form).</ParamField>
-    <ParamField body="type" type="AttributeType">One of `single_select`, `multi_select`, `unit`, `toggle`, `text`; inferred when omitted (`is_variant_axis` ⇒ `multi_select`, boolean `value` ⇒ `toggle`, else `text`).</ParamField>
-    <ParamField body="values" type="string[]">Value names to create for inline multi-value attributes.</ParamField>
-    <ParamField body="is_variant_axis" type="boolean">Create the inline attribute as a variant axis with an exclusive product option.</ParamField>
-    <ParamField body="is_filterable" type="boolean">Whether the inline attribute is filterable. Defaults to `false`.</ParamField>
-    <ParamField body="is_required" type="boolean">Whether the inline attribute is required. Defaults to `false`.</ParamField>
-    <ParamField body="description" type="string | null">Description of the inline attribute.</ParamField>
-    <ParamField body="metadata" type="object | null">Custom key-value data on the inline attribute.</ParamField>
-  </Expandable>
-</ParamField>
-<ParamField body="additional_data" type="object">Custom data passed through.</ParamField>
-
-## Result
-
-<ResponseField name="result" type="void">No return value.</ResponseField>

package/content/references/workflows/product-attribute/create-and-link-product-attributes-to-product.mdx

@@ -1,46 +0,0 @@
----
-title: "createAndLinkProductAttributesToProductWorkflow"
-description: "Batch attach, detach, and update attribute selections on a product."
----
-
-The batch orchestrator behind `POST /admin/products/:id/attributes/batch` and `POST /vendor/products/:id/attributes/batch`. Delegates to `removeProductAttributesFromProductWorkflow`, `addProductAttributesToProductWorkflow`, and `updateProductAttributesOnProductWorkflow`, applied in the order **remove → add → update** so removing and re-adding the same attribute in one call resolves correctly.
-
-## Usage
-
-```ts
-import { createAndLinkProductAttributesToProductWorkflow } from "@mercurjs/core/workflows"
-
-await createAndLinkProductAttributesToProductWorkflow(container).run({
-  input: {
-    product_id: "prod_123",
-    add: [{ id: "pattr_color", value_ids: ["pattrval_red"] }],
-    remove: ["pattr_old"],
-    update: [{ id: "pattr_size", add: ["pattrval_xl"] }],
-  },
-})
-```
-
-## Input
-
-<ParamField body="product_id" type="string" required>The product whose attributes are being managed.</ParamField>
-<ParamField body="add" type="ProductAttributeBatchAdd[]">Attributes to attach — existing (`{ id, value_ids | value }`) or inline (`{ title, type?, value | values, is_variant_axis? }`).</ParamField>
-<ParamField body="remove" type="string[]">Ids of attributes to detach; product-scoped attributes are deleted, shared ones are unlinked.</ParamField>
-<ParamField body="update" type="ProductAttributeBatchUpdate[]">Per-attribute selection changes (`{ id, title?, add?, remove?, value? }`).</ParamField>
-<ParamField body="additional_data" type="object">Custom data passed through to the workflow hooks.</ParamField>
-
-## Result
-
-<ResponseField name="result" type="void">No return value.</ResponseField>
-
-## Hooks
-
-- `validate` — runs before any mutation with `{ input }`; throw to reject the batch.
-- `productAttributesLinked` — runs after all sub-workflows with `{ product_id }`.
-
-```ts
-createAndLinkProductAttributesToProductWorkflow.hooks.productAttributesLinked(
-  async ({ product_id }) => {
-    // re-index the product
-  },
-)
-```

package/content/references/workflows/product-attribute/create-product-attribute-values.mdx

@@ -1,43 +0,0 @@
----
-title: "createProductAttributeValuesWorkflow"
-description: "Add values to an attribute, mirroring them onto its product option."
----
-
-Creates values on an existing attribute. If the attribute is a variant-axis `multi_select` with a mirror `ProductOption`, the option's value list is extended first and each new attribute value is bound to its option value via `product_option_value_id`. Triggered by `POST /admin/product-attributes/:id/values`. Emits `product-attribute-value.created`.
-
-## Usage
-
-```ts
-import { createProductAttributeValuesWorkflow } from "@mercurjs/core/workflows"
-
-const { result } = await createProductAttributeValuesWorkflow(container).run({
-  input: {
-    attribute_id: "pattr_color",
-    values: [{ name: "Green" }, { name: "Yellow", rank: 5 }],
-  },
-})
-```
-
-## Input
-
-<ParamField body="attribute_id" type="string" required>The attribute to add the values to.</ParamField>
-<ParamField body="values" type="CreateProductAttributeValueDTO[]" required>
-  Values to create.
-  <Expandable title="properties">
-    <ParamField body="name" type="string" required>Display name of the value.</ParamField>
-    <ParamField body="handle" type="string">URL-safe handle; auto-generated when omitted.</ParamField>
-    <ParamField body="rank" type="number">Sort rank.</ParamField>
-    <ParamField body="is_active" type="boolean">Whether the value is active.</ParamField>
-    <ParamField body="metadata" type="object | null">Custom key-value data.</ParamField>
-  </Expandable>
-</ParamField>
-<ParamField body="additional_data" type="object">Custom data passed through to the hooks.</ParamField>
-
-## Result
-
-<ResponseField name="result" type="ProductAttributeValueDTO[]">The created values.</ResponseField>
-
-## Hooks
-
-- `validate` — runs before creation with `{ input }`.
-- `productAttributeValuesCreated` — runs after creation with `{ values, additional_data }`.

package/content/references/workflows/product-attribute/create-product-attributes.mdx

@@ -1,56 +0,0 @@
----
-title: "createProductAttributesWorkflow"
-description: "Create catalog attributes with values, mirror options, and category links."
----
-
-Creates product attributes and their values. Variant-axis `multi_select` attributes also get a shared mirror `ProductOption` created, with each value bound to its option value. Optional `category_ids` create category links per attribute. Triggered by `POST /admin/product-attributes`. Emits `product-attribute.created`.
-
-## Usage
-
-```ts
-import { createProductAttributesWorkflow } from "@mercurjs/core/workflows"
-
-const { result } = await createProductAttributesWorkflow(container).run({
-  input: {
-    attributes: [
-      {
-        name: "Color",
-        type: "multi_select",
-        is_variant_axis: true,
-        values: [{ name: "Red" }, { name: "Blue" }],
-        category_ids: ["pcat_apparel"],
-      },
-    ],
-  },
-})
-```
-
-## Input
-
-<ParamField body="attributes" type="(CreateProductAttributeDTO & { category_ids?: string[] })[]" required>
-  Attributes to create.
-  <Expandable title="properties">
-    <ParamField body="name" type="string" required>Display name of the attribute.</ParamField>
-    <ParamField body="type" type="AttributeType" required>One of `single_select`, `multi_select`, `unit`, `toggle`, `text`.</ParamField>
-    <ParamField body="handle" type="string">URL-safe handle; auto-generated when omitted.</ParamField>
-    <ParamField body="description" type="string | null">Description of the attribute.</ParamField>
-    <ParamField body="is_required" type="boolean">Whether products must carry this attribute.</ParamField>
-    <ParamField body="is_filterable" type="boolean">Whether the attribute is exposed as a storefront filter.</ParamField>
-    <ParamField body="is_variant_axis" type="boolean">Mirror the attribute as a shared `ProductOption` (with `type: multi_select`).</ParamField>
-    <ParamField body="rank" type="number">Sort rank.</ParamField>
-    <ParamField body="is_active" type="boolean">Whether the attribute is active.</ParamField>
-    <ParamField body="values" type="CreateProductAttributeValueDTO[]">Values to create (`{ name, handle?, rank?, is_active?, metadata? }`).</ParamField>
-    <ParamField body="category_ids" type="string[]">Category ids to link the attribute to.</ParamField>
-    <ParamField body="metadata" type="object | null">Custom key-value data.</ParamField>
-  </Expandable>
-</ParamField>
-<ParamField body="additional_data" type="object">Custom data passed through to the hooks.</ParamField>
-
-## Result
-
-<ResponseField name="result" type="ProductAttributeDTO[]">The created attributes.</ResponseField>
-
-## Hooks
-
-- `validate` — runs before creation with `{ input }`.
-- `productAttributesCreated` — runs after creation with `{ attributes, additional_data }`.

package/content/references/workflows/product-attribute/delete-product-attribute-values.mdx

@@ -1,30 +0,0 @@
----
-title: "deleteProductAttributeValuesWorkflow"
-description: "Delete attribute values and shrink the mirror option accordingly."
----
-
-Deletes attribute values by id. When the deleted values belong to a single variant-axis `multi_select` attribute with a mirror `ProductOption`, the option's value list is rewritten to the attribute's remaining value names. Triggered by `DELETE /admin/product-attributes/:id/values/:value_id`; also run internally by the batch update engine. Emits `product-attribute-value.deleted`.
-
-## Usage
-
-```ts
-import { deleteProductAttributeValuesWorkflow } from "@mercurjs/core/workflows"
-
-await deleteProductAttributeValuesWorkflow(container).run({
-  input: { ids: ["pattrval_123", "pattrval_456"] },
-})
-```
-
-## Input
-
-<ParamField body="ids" type="string[]" required>Ids of the attribute values to delete.</ParamField>
-<ParamField body="additional_data" type="object">Custom data passed through to the hooks.</ParamField>
-
-## Result
-
-<ResponseField name="result" type="void">No return value.</ResponseField>
-
-## Hooks
-
-- `validate` — runs before deletion with `{ input }`.
-- `productAttributeValuesDeleted` — runs after deletion with `{ ids, additional_data }`.

package/content/references/workflows/product-attribute/delete-product-attributes.mdx

@@ -1,30 +0,0 @@
----
-title: "deleteProductAttributesWorkflow"
-description: "Delete attributes and their mirror product options."
----
-
-Deletes product attributes after validating none of them is still linked to a product or category. Mirror `ProductOption`s of axis attributes are deleted alongside. Triggered by `DELETE /admin/product-attributes/:id`; also run internally when detaching product-scoped attributes. Emits `product-attribute.deleted`.
-
-## Usage
-
-```ts
-import { deleteProductAttributesWorkflow } from "@mercurjs/core/workflows"
-
-await deleteProductAttributesWorkflow(container).run({
-  input: { ids: ["pattr_123"] },
-})
-```
-
-## Input
-
-<ParamField body="ids" type="string[]" required>Ids of the attributes to delete; the workflow throws if an attribute is still linked.</ParamField>
-<ParamField body="additional_data" type="object">Custom data passed through to the hooks.</ParamField>
-
-## Result
-
-<ResponseField name="result" type="void">No return value.</ResponseField>
-
-## Hooks
-
-- `validate` — runs before deletion with `{ input }`.
-- `productAttributesDeleted` — runs after deletion with `{ ids, additional_data }`.

package/content/references/workflows/product-attribute/remove-product-attributes-from-product.mdx

@@ -1,29 +0,0 @@
----
-title: "removeProductAttributesFromProductWorkflow"
-description: "Detach attributes from a product, deleting product-scoped ones."
----
-
-Handles the `remove` portion of the attribute batch engine (`createAndLinkProductAttributesToProductWorkflow`). Rejects required attributes, dismisses the product's value links for every listed attribute, detaches the mirror `ProductOption` for shared axis attributes, and runs `deleteProductAttributesWorkflow` for product-scoped (inline) attributes so their exclusive options are deleted too.
-
-## Usage
-
-```ts
-import { removeProductAttributesFromProductWorkflow } from "@mercurjs/core/workflows"
-
-await removeProductAttributesFromProductWorkflow(container).run({
-  input: {
-    product_id: "prod_123",
-    remove: ["pattr_color", "pattr_custom_size"],
-  },
-})
-```
-
-## Input
-
-<ParamField body="product_id" type="string" required>The product to detach the attributes from.</ParamField>
-<ParamField body="remove" type="string[]" required>Ids of the attributes to detach; attributes with `is_required: true` cause the workflow to throw.</ParamField>
-<ParamField body="additional_data" type="object">Custom data passed through.</ParamField>
-
-## Result
-
-<ResponseField name="result" type="void">No return value.</ResponseField>

package/content/references/workflows/product-attribute/update-product-attribute-values.mdx

@@ -1,44 +0,0 @@
----
-title: "updateProductAttributeValuesWorkflow"
-description: "Update attribute values matching a selector and re-sync the mirror option."
----
-
-Updates attribute values by selector. When the touched values belong to a single variant-axis `multi_select` attribute with a mirror `ProductOption`, the option's value list is rewritten from the attribute's current value names. Triggered by `POST /admin/product-attributes/:id/values/:value_id`. Emits `product-attribute-value.updated`.
-
-## Usage
-
-```ts
-import { updateProductAttributeValuesWorkflow } from "@mercurjs/core/workflows"
-
-const { result } = await updateProductAttributeValuesWorkflow(container).run({
-  input: {
-    selector: { id: "pattrval_123" },
-    update: { name: "Dark Green" },
-  },
-})
-```
-
-## Input
-
-<ParamField body="selector" type="object" required>Filter for the values to update, e.g. `{ id: "pattrval_123" }`.</ParamField>
-<ParamField body="update" type="UpdateProductAttributeValueDTO" required>
-  Fields to set on every matched value.
-  <Expandable title="properties">
-    <ParamField body="name" type="string">New display name.</ParamField>
-    <ParamField body="handle" type="string">New handle.</ParamField>
-    <ParamField body="rank" type="number">Sort rank.</ParamField>
-    <ParamField body="is_active" type="boolean">Whether the value is active.</ParamField>
-    <ParamField body="product_option_value_id" type="string | null">Bound mirror option value.</ParamField>
-    <ParamField body="metadata" type="object | null">Custom key-value data.</ParamField>
-  </Expandable>
-</ParamField>
-<ParamField body="additional_data" type="object">Custom data passed through to the hooks.</ParamField>
-
-## Result
-
-<ResponseField name="result" type="ProductAttributeValueDTO[]">The updated values.</ResponseField>
-
-## Hooks
-
-- `validate` — runs before the update with `{ input }`.
-- `productAttributeValuesUpdated` — runs after the update with `{ values, additional_data }`.