Raw schema
{
"type": "object",
"properties": {
"product_ids": {
"description": "Only these product ids.",
"maxItems": 100,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"sku": {
"description": "Only the product with exactly this SKU.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"category_ids": {
"description": "Only products in these categories.",
"maxItems": 100,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"location_ids": {
"description": "Only these inventory locations (see megaventory_list_inventory_locations).",
"maxItems": 100,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"main_supplier_ids": {
"description": "Only products whose main supplier is one of these ids.",
"maxItems": 100,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"search": {
"description": "Products whose description contains this text.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"only_positive_quantity": {
"description": "Only products with a positive quantity.",
"type": "boolean"
},
"only_needing_reorder": {
"description": "Only products that need to be ordered (at or below their alert level).",
"type": "boolean"
},
"include_product_details": {
"description": "Also return the product objects.",
"type": "boolean"
},
"filters": {
"description": "Extra filters, all combined with AND. Field names are the property names shown in the results (case-insensitive).",
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_]{0,79}$",
"description": "A field of the record, for example SalesOrderClientID or ProductSellingPrice."
},
"operator": {
"type": "string",
"enum": [
"Equals",
"NotEquals",
"BeginsWith",
"EndsWith",
"Contains",
"GreaterThan",
"LessThan"
]
},
"value": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"required": [
"field",
"operator",
"value"
]
}
},
"limit": {
"description": "How many records to return, 1-100 (default 25). Megaventory returns the newest records first (highest id) and has no page offset: narrow with filters instead of paging.",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}