Product content and recommendations

Toolset product_content, 9 tools.

RecordsHivatkozás másolása

product_relationsHivatkozás másolása

The related products and add-ons one product shows: the ones picked by hand, the ones picked automatically and the automatic ones hidden. Pass the product id.

• Permission: products.read
• Tools: product_relations_get

recommendation_excludedHivatkozás másolása

The products the store never recommends, with their title and thumbnail.

• Permission: products.read
• Tools: recommendation_excluded_list

recommendation_settingsHivatkozás másolása

How the store recommends products: whether it is on, where it shows (product page related and add-ons, cart, abandoned-cart email), the categories it leaves out, the price band of a similar product and the signals it uses. There is one record; pass any id, e.g. "current".

• Permission: products.read
• Tools: recommendation_settings_get

variants_without_weightHivatkozás másolása

How many variants have no weight, which weight-based shipping prices cannot use. There is one record; pass any id, e.g. "current".

• Permission: products.read
• Tools: variants_without_weight_get

ActionsHivatkozás másolása

product_relations_hide_autoHivatkozás másolása

Hide or show one automatically chosen related product or add-on on a product.

• Action key: product_relations.hide_auto
• 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",
  "kind": "related",
  "other_product_id": "019bb596-4f49-7df2-8e43-087dbab6350c",
  "hidden": true
}

product_relations_setHivatkozás másolása

Add related products or add-ons to a product, or unlink them.

kind is related or addon. product_ids are added to the hand-picked list, or taken off it with unlink. mutual links both products to each other.

• Action key: product_relations.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",
  "kind": "related",
  "product_ids": [
    "019bb596-4f49-7df2-8e43-087dbab6350c"
  ]
}

product_seo_setHivatkozás másolása

Set the search title and description of a product, its share card, and how search engines index it.

Read the current settings with product_get include seo. A field left out stays as it is; null resets it to automatic. robots_index false hides the page from search engines and the sitemap; canonical_url names the address search engines should index instead (a storefront path /… or an https address). The sitemap priority and change frequency are hints search engines mostly ignore; leave them automatic unless asked.

• Action key: product_seo.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",
  "seo_title": "Handmade soap",
  "seo_description": "Cold-process soap."
}

{
  "product_id": "019bb58e-0ec1-79c1-9f40-d39d8d07674b",
  "og_title": "Our handmade soap",
  "robots_index": false
}

recommendation_rule_setHivatkozás másolása

Turn automatic recommendations off for a product, or leave it out of everyone else's.

• Action key: recommendation_rule.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",
  "excluded": true
}

recommendation_settings_updateHivatkozás másolása

Change how products are recommended.

Only the fields passed change.

• Action key: recommendation_settings.update
• Permission: settings.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:

{
  "enabled": true,
  "placements": {
    "cart": false
  }
}