{
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "Keyword to match against product names, e.g. 'denim shirt'."
},
"taxon": {
"type": "string",
"description": "Permalink filter, e.g. 'categories/men/shirts' or 'collections/new-arrivals'."
},
"min_price": {
"type": "number",
"minimum": 0,
"description": "Minimum price in USD."
},
"max_price": {
"type": "number",
"minimum": 0,
"description": "Maximum price in USD."
},
"in_stock": {
"type": "boolean",
"description": "If true, only return purchasable items in stock.",
"default": true
},
"sort": {
"type": "string",
"enum": [
"popularity",
"-popularity",
"price",
"-price",
"name",
"-name",
"-available_on"
],
"description": "Sort order.",
"default": "-popularity"
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 20,
"default": 10
}
}
}{
"type": "object",
"properties": {
"slug": {
"type": "string",
"description": "Product slug, e.g. 'denim-shirt'."
}
},
"required": [
"slug"
]
}{
"type": "object",
"properties": {
"parent": {
"type": "string",
"description": "Optional permalink filter for children of a given parent, e.g. 'categories/men'."
}
}
}{
"type": "object",
"properties": {}
}{
"type": "object",
"properties": {
"variant_id": {
"type": "integer",
"description": "The variant ID (NOT the product ID). Get this from get_product → variants."
},
"quantity": {
"type": "integer",
"minimum": 1,
"maximum": 10,
"default": 1
}
},
"required": [
"variant_id"
]
}{
"type": "object",
"properties": {
"coupon_code": {
"type": "string"
}
},
"required": [
"coupon_code"
]
}{
"type": "object",
"properties": {}
}{
"type": "object",
"properties": {}
}