Properties
| Name | Type | Description |
|---|---|---|
| type | string | |
| product_level | string | Low inventory product level. |
| trigger_filter | object | |
| inventory_count | integer | |
| audience | array | |
| timeframe_days | integer |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/LowInventoryTrigger",
"title": "LowInventoryTrigger",
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"low-inventory"
]
},
"product_level": {
"description": "Low inventory product level.",
"type": "string",
"enum": [
"product",
"variant"
]
},
"trigger_filter": {
"$ref": "#/components/schemas/LowInventoryConditionFilter",
"nullable": true
},
"inventory_count": {
"type": "integer"
},
"audience": {
"type": "array",
"items": {
"type": "string",
"enum": [
"added-to-cart",
"checkout-started",
"viewed"
],
"description": "The profiles which the low inventory trigger applies to.\n\nWe check profiles to see if they have these kinds of events. If they\n do have them, then they are considered for the audience."
}
},
"timeframe_days": {
"type": "integer",
"example": 30,
"default": 30
}
},
"required": [
"type",
"product_level",
"trigger_filter",
"inventory_count",
"audience"
]
}