Merchandising

Toolset catalog_merch, 7 tools.

ActionsCopy Anchor Link

product_coverage_clearCopy Anchor Link

Remove the geographic limits from a product so it sells everywhere the store does.

• Action key: product_coverage.clear
• Permission: products.write
• Approval: Always waits for a person to approve it.
• Effect: Changes the live store.
• Destructive: in compact mode it runs with run_destructive_action.
• Retries: safe to repeat with the same input.

Example input:

{
  "product_id": "019bb58e-0ec1-79c1-9f40-d39d8d07674b"
}

product_coverage_setCopy Anchor Link

Limit where a product is sold to the given countries or territories.

include_codes are country or territory codes the product is sold in; exclude_codes carves exceptions out of them. Replaces the current coverage.

• Action key: product_coverage.set
• Permission: products.write
• Approval: Waits for approval when the store requires it for this action.
• Effect: Changes the live store.
• Retries: safe to repeat with the same input.

Example input:

{
  "product_id": "019bb58e-0ec1-79c1-9f40-d39d8d07674b",
  "include_codes": [
    "HU",
    "AT"
  ],
  "exclude_codes": []
}

product_highlighted_features_clearCopy Anchor Link

Remove a product's highlighted features.

• Action key: product_highlighted_features.clear
• Permission: products.write
• Approval: Always waits for a person to approve it.
• Effect: Changes the live store.
• Destructive: in compact mode it runs with run_destructive_action.
• Retries: safe to repeat with the same input.

Example input:

{
  "product_id": "019bb58e-0ec1-79c1-9f40-d39d8d07674b"
}

product_highlighted_features_setCopy Anchor Link

Set the short feature list shown at the top of a product's page.

items_text holds one feature per line and replaces the current list; an empty text removes it. Read the current list with product_get include highlighted_features.

• Action key: product_highlighted_features.set
• Permission: products.write
• Approval: Waits for approval when the store requires it for this action.
• Effect: Changes the live store.
• Retries: safe to repeat with the same input.

Example input:

{
  "product_id": "019bb58e-0ec1-79c1-9f40-d39d8d07674b",
  "items_text": "100% cotton\nMachine washable"
}

product_popularity_setCopy Anchor Link

Pin a product's rank in popularity-sorted lists, or link it to an IGDB game.

manual_rank overrides the computed popularity (null removes the override); igdb_game_id links the product to a game catalog entry (null unlinks it). Read the current values with product_get include popularity. Refused while a popularity sync is running.

• Action key: product_popularity.set
• Permission: products.write
• Approval: Waits for approval when the store requires it for this action.
• Effect: Changes the live store.
• Retries: safe to repeat with the same input.

Example input:

{
  "product_id": "019bb58e-0ec1-79c1-9f40-d39d8d07674b",
  "manual_rank": 1
}

product_visibility_setCopy Anchor Link

Choose whether a product is listed in the storefront or reachable by direct link only.

• Action key: product_visibility.set
• Permission: products.write
• Approval: Waits for approval when the store requires it for this action.
• Effect: Changes the live store.
• Retries: safe to repeat with the same input.

Example input:

{
  "product_id": "019bb58e-0ec1-79c1-9f40-d39d8d07674b",
  "storefront_visibility": "direct_link_only"
}

product_warranty_setCopy Anchor Link

Assign a warranty policy to a product, or remove its own so the store default applies.

Pass null to remove the assignment.

• Action key: product_warranty.set
• Permission: products.write
• Approval: Waits for approval when the store requires it for this action.
• Effect: Changes the live store.
• Retries: safe to repeat with the same input.

Example inputs:

{
  "product_id": "019bb58e-0ec1-79c1-9f40-d39d8d07674b",
  "warranty_policy_id": "019bb819-4494-70f4-a487-4e536b0d042e"
}

{
  "product_id": "019bb58e-0ec1-79c1-9f40-d39d8d07674b",
  "warranty_policy_id": null
}