{
"type": "object",
"properties": {
"keyword": {
"type": "string",
"description": "Short noun phrases extracted from conversational input. Never pass full sentences. ALWAYS use the singular form, not the plural. Include color, material, and style descriptors for accuracy. For vague gift or occasion queries without a clear product type, use broad category terms. Preserve the existing keyword across filter refinements; only replace when the user makes a completely different request."
},
"sort": {
"description": "Sort order.",
"type": "string",
"enum": [
"price-asc",
"price-desc"
]
},
"priceRange": {
"description": "Price range in dollars. Format: 'min-max' e.g. '0-500', '1000-2000'.",
"type": "string"
}
},
"required": [
"keyword"
],
"$schema": "http://json-schema.org/draft-07/schema#"
}{
"type": "object",
"properties": {
"ids": {
"minItems": 1,
"maxItems": 6,
"type": "array",
"items": {
"type": "string"
},
"description": "Product IDs to present, in display order."
}
},
"required": [
"ids"
],
"$schema": "http://json-schema.org/draft-07/schema#"
}{
"type": "object",
"properties": {
"meta": {
"type": "object",
"properties": {
"ucp-agent": {
"description": "Platform profile URI for capability negotiation.",
"type": "object",
"properties": {
"profile": {
"type": "string"
}
},
"required": [
"profile"
]
}
},
"description": "UCP request metadata (platform profile advertisement)."
},
"query": {
"description": "Free-text search query.",
"type": "string"
},
"filters": {
"type": "object",
"properties": {
"categories": {
"type": "array",
"items": {
"type": "string"
}
},
"price": {
"type": "object",
"properties": {
"min": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Monetary amount in ISO 4217 minor units (e.g. cents)."
},
"max": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Monetary amount in ISO 4217 minor units (e.g. cents)."
}
}
}
}
},
"context": {
"type": "object",
"properties": {
"address_country": {
"type": "string"
},
"address_region": {
"type": "string"
},
"postal_code": {
"type": "string"
},
"intent": {
"type": "string"
},
"language": {
"type": "string"
},
"currency": {
"type": "string"
},
"eligibility": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"pagination": {
"type": "object",
"properties": {
"cursor": {
"type": "string"
},
"limit": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
}
}
},
"$schema": "http://json-schema.org/draft-07/schema#"
}{
"type": "object",
"properties": {
"meta": {
"type": "object",
"properties": {
"ucp-agent": {
"description": "Platform profile URI for capability negotiation.",
"type": "object",
"properties": {
"profile": {
"type": "string"
}
},
"required": [
"profile"
]
}
},
"description": "UCP request metadata (platform profile advertisement)."
},
"ids": {
"minItems": 1,
"type": "array",
"items": {
"type": "string"
},
"description": "Product ids, handles, or variant ids to resolve."
}
},
"required": [
"ids"
],
"$schema": "http://json-schema.org/draft-07/schema#"
}{
"type": "object",
"properties": {
"meta": {
"type": "object",
"properties": {
"ucp-agent": {
"description": "Platform profile URI for capability negotiation.",
"type": "object",
"properties": {
"profile": {
"type": "string"
}
},
"required": [
"profile"
]
}
},
"description": "UCP request metadata (platform profile advertisement)."
},
"id": {
"type": "string",
"description": "Product id or handle."
}
},
"required": [
"id"
],
"$schema": "http://json-schema.org/draft-07/schema#"
}{
"type": "object",
"properties": {
"meta": {
"type": "object",
"properties": {
"ucp-agent": {
"description": "Platform profile URI for capability negotiation.",
"type": "object",
"properties": {
"profile": {
"type": "string"
}
},
"required": [
"profile"
]
}
},
"description": "UCP request metadata (platform profile advertisement)."
},
"line_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Variant id being purchased."
},
"quantity": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"id",
"quantity"
]
}
},
"buyer": {
"type": "object",
"properties": {
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email": {
"type": "string"
},
"phone_number": {
"type": "string"
}
}
}
},
"required": [
"line_items"
],
"$schema": "http://json-schema.org/draft-07/schema#"
}{
"type": "object",
"properties": {
"meta": {
"type": "object",
"properties": {
"ucp-agent": {
"description": "Platform profile URI for capability negotiation.",
"type": "object",
"properties": {
"profile": {
"type": "string"
}
},
"required": [
"profile"
]
}
},
"description": "UCP request metadata (platform profile advertisement)."
},
"id": {
"type": "string",
"description": "Cart id to update."
},
"line_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Variant id being purchased."
},
"quantity": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"id",
"quantity"
]
}
},
"buyer": {
"type": "object",
"properties": {
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email": {
"type": "string"
},
"phone_number": {
"type": "string"
}
}
}
},
"required": [
"id",
"line_items"
],
"$schema": "http://json-schema.org/draft-07/schema#"
}{
"type": "object",
"properties": {
"meta": {
"type": "object",
"properties": {
"ucp-agent": {
"description": "Platform profile URI for capability negotiation.",
"type": "object",
"properties": {
"profile": {
"type": "string"
}
},
"required": [
"profile"
]
}
},
"description": "UCP request metadata (platform profile advertisement)."
},
"line_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Variant id being purchased."
},
"quantity": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"id",
"quantity"
]
}
},
"buyer": {
"type": "object",
"properties": {
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email": {
"type": "string"
},
"phone_number": {
"type": "string"
}
}
},
"context": {
"type": "object",
"properties": {
"address_country": {
"type": "string"
},
"address_region": {
"type": "string"
},
"postal_code": {
"type": "string"
},
"intent": {
"type": "string"
},
"language": {
"type": "string"
},
"currency": {
"type": "string"
},
"eligibility": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"required": [
"line_items"
],
"$schema": "http://json-schema.org/draft-07/schema#"
}{
"type": "object",
"properties": {
"meta": {
"type": "object",
"properties": {
"ucp-agent": {
"description": "Platform profile URI for capability negotiation.",
"type": "object",
"properties": {
"profile": {
"type": "string"
}
},
"required": [
"profile"
]
}
},
"description": "UCP request metadata (platform profile advertisement)."
},
"id": {
"type": "string",
"description": "Checkout session id to update."
},
"line_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Variant id being purchased."
},
"quantity": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"id",
"quantity"
]
}
},
"buyer": {
"type": "object",
"properties": {
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email": {
"type": "string"
},
"phone_number": {
"type": "string"
}
}
},
"context": {
"type": "object",
"properties": {
"address_country": {
"type": "string"
},
"address_region": {
"type": "string"
},
"postal_code": {
"type": "string"
},
"intent": {
"type": "string"
},
"language": {
"type": "string"
},
"currency": {
"type": "string"
},
"eligibility": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"required": [
"id",
"line_items"
],
"$schema": "http://json-schema.org/draft-07/schema#"
}{
"type": "object",
"properties": {
"meta": {
"type": "object",
"properties": {
"ucp-agent": {
"description": "Platform profile URI for capability negotiation.",
"type": "object",
"properties": {
"profile": {
"type": "string"
}
},
"required": [
"profile"
]
}
},
"description": "UCP request metadata (platform profile advertisement)."
},
"id": {
"type": "string",
"description": "Checkout session id to complete."
},
"payment": {
"type": "object",
"properties": {
"instruments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"handler_id": {
"type": "string"
},
"type": {
"type": "string"
},
"selected": {
"type": "boolean"
},
"billing_address": {
"type": "object",
"properties": {
"extended_address": {
"type": "string"
},
"street_address": {
"type": "string"
},
"address_locality": {
"type": "string"
},
"address_region": {
"type": "string"
},
"address_country": {
"type": "string"
},
"postal_code": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"phone_number": {
"type": "string"
}
}
},
"display": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"credential": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"token": {
"type": "string"
}
},
"additionalProperties": {}
}
},
"required": [
"handler_id",
"type"
]
}
}
},
"required": [
"instruments"
],
"description": "Payment instruments acquired via the advertised handler."
}
},
"required": [
"id",
"payment"
],
"$schema": "http://json-schema.org/draft-07/schema#"
}