shopping_product_search

{
    "type": "object",
    "required": [
        "agent_id",
        "query"
    ],
    "properties": {
        "limit": {
            "type": "integer",
            "default": 5,
            "maximum": 10,
            "minimum": 1,
            "description": "Maximum products to return; integer from 1 to 10."
        },
        "query": {
            "type": "string",
            "description": "Natural-language product search query, e.g. 'portable battery powered air conditioner'."
        },
        "cursor": {
            "type": "string",
            "description": "Pagination cursor returned by a previous search response; omit for the first page."
        },
        "context": {
            "type": "object",
            "required": [],
            "properties": {
                "intent": {
                    "type": "string",
                    "description": "Natural-language shopping context or buyer intent; do not include secrets or payment data."
                },
                "currency": {
                    "type": "string",
                    "description": "ISO 4217 currency code such as 'USD'."
                },
                "language": {
                    "type": "string",
                    "description": "Preferred language or locale such as 'en' or 'en-US'."
                },
                "postal_code": {
                    "type": "string",
                    "description": "Buyer-provided destination postal code; omit when unknown."
                },
                "address_region": {
                    "type": "string",
                    "description": "Buyer-provided state, province, or region code/name; omit when unknown."
                },
                "address_country": {
                    "type": "string",
                    "description": "ISO 3166-1 alpha-2 country code. Use 'US', not 'USA'."
                }
            },
            "description": "Optional buyer/search context for catalog, cart, or checkout tools.",
            "additionalProperties": false
        },
        "filters": {
            "type": "object",
            "required": [],
            "properties": {
                "price": {
                    "type": "object",
                    "required": [],
                    "properties": {
                        "max": {
                            "type": "integer",
                            "minimum": 0,
                            "description": "Maximum price in minor units for the selected currency, e.g. cents for USD."
                        },
                        "min": {
                            "type": "integer",
                            "minimum": 0,
                            "description": "Minimum price in minor units for the selected currency, e.g. cents for USD."
                        },
                        "currency": {
                            "type": "string",
                            "description": "ISO 4217 currency code for price bounds, e.g. 'USD'."
                        }
                    },
                    "description": "Price filter using minor units.",
                    "additionalProperties": false
                },
                "ships_to": {
                    "type": "object",
                    "required": [
                        "country"
                    ],
                    "properties": {
                        "region": {
                            "type": "string",
                            "description": "Buyer-provided state/province/region for shipping filtering; omit when unknown."
                        },
                        "country": {
                            "type": "string",
                            "description": "ISO 3166-1 alpha-2 country code. Use 'US', not 'USA'."
                        },
                        "postal_code": {
                            "type": "string",
                            "description": "Buyer-provided destination postal code for shipping filtering; omit when unknown."
                        }
                    },
                    "description": "Shipping destination filter.",
                    "additionalProperties": false
                },
                "available": {
                    "type": "boolean",
                    "description": "Whether to prefer in-stock / available products."
                },
                "categories": {
                    "type": "array",
                    "items": {
                        "type": "object",
                        "required": [
                            "id"
                        ],
                        "properties": {
                            "id": {
                                "type": "string",
                                "description": "Category identifier from a known taxonomy; omit categories if unavailable."
                            },
                            "taxonomy": {
                                "type": "string",
                                "description": "Category taxonomy name/version when known."
                            }
                        },
                        "description": "Known taxonomy category filter.",
                        "additionalProperties": false
                    },
                    "maxItems": 10,
                    "description": "Optional category filters supplied from a known taxonomy."
                }
            },
            "description": "Optional product search filters.",
            "additionalProperties": false
        },
        "agent_id": {
            "type": "string",
            "description": "Registered UCP Gateway UUID returned by register_ucp_profile; required for every Shopping tool."
        }
    },
    "description": "Arguments for product search.",
    "additionalProperties": false
}