Find
substitution_suggest
Suggest alternatives for an item that is unavailable.
Use it when an item the buyer wanted is out of stock or was removed. It suggests; it never adds anything to a cart.
| Type | Read: looks things up, changes nothing |
| Needs a cart the buyer approved | No |
| Moves money | No |
Tool description (what the assistant sees)
Suggests alternatives for an unavailable SKU or a free-text query from the same live shop catalogs product search reads. Optional filters: merchant_id, in_stock_only, max_unit_price_cents and limit (max 5). Returns suggestions only; nothing is added to a cart, and the buyer's substitution policy decides what may be substituted. Read-only.#Parameters
| Name | Type | Required | Description |
|---|---|---|---|
unavailable_sku | string | No | The SKU that cannot be bought. |
query | string | No | Free text describing what the buyer wanted, when there is no SKU. |
merchant_id | uuid | No | Only suggest from this shop. |
in_stock_only | boolean | No | Leave out offers that are not in stock. |
max_unit_price_cents | integer | No | Only suggest items at or under this unit price, in cents. |
limit | integer | No | How many suggestions, 1 to 5. |