gaaaw commited on
Commit
60e423e
·
1 Parent(s): 84b3337

chages to api payloads

Browse files
scenarios/01_order_placement.json CHANGED
@@ -8,18 +8,30 @@
8
  "bug_count": { "simple": 2, "moderate": 2, "complex": 2, "total": 6 },
9
  "schema": {
10
  "type": "object",
11
- "required": ["user_id", "items", "currency", "shipping"],
12
  "properties": {
13
  "user_id": { "type": "string", "description": "ID of the user placing the order" },
14
  "items": {
15
  "type": "array",
16
- "description": "List of items to order, each with product_id, quantity, and unit_price",
17
  "items": {
18
  "type": "object",
 
19
  "properties": {
20
- "product_id": { "type": "string" },
21
- "quantity": { "type": "integer" },
22
- "unit_price": { "type": "number" }
 
 
 
 
 
 
 
 
 
 
 
23
  }
24
  }
25
  },
@@ -27,11 +39,66 @@
27
  "currency": { "type": "string", "description": "ISO 4217 currency code (e.g. USD, EUR)" },
28
  "shipping": {
29
  "type": "object",
30
- "description": "Shipping details including address, method, and country",
 
31
  "properties": {
32
- "address": { "type": "string" },
 
 
33
  "method": { "type": "string", "description": "Shipping method: standard, express, or overnight" },
34
- "country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code" }
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
35
  }
36
  }
37
  }
@@ -39,14 +106,56 @@
39
  "sample_payload": {
40
  "user_id": "usr_4821",
41
  "items": [
42
- { "product_id": "prod_991", "quantity": 2, "unit_price": 29.99 }
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
43
  ],
44
  "coupon_code": "SAVE10",
45
  "currency": "USD",
46
  "shipping": {
 
 
47
  "address": "123 Main St, Springfield, IL 62701",
48
  "method": "standard",
49
- "country": "US"
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
50
  }
51
  }
52
  }
 
8
  "bug_count": { "simple": 2, "moderate": 2, "complex": 2, "total": 6 },
9
  "schema": {
10
  "type": "object",
11
+ "required": ["user_id", "items", "currency", "shipping", "billing", "payment"],
12
  "properties": {
13
  "user_id": { "type": "string", "description": "ID of the user placing the order" },
14
  "items": {
15
  "type": "array",
16
+ "description": "List of items to order",
17
  "items": {
18
  "type": "object",
19
+ "required": ["product_id", "quantity", "unit_price"],
20
  "properties": {
21
+ "product_id": { "type": "string", "description": "ID of the product" },
22
+ "variant_id": { "type": "string", "description": "Optional variant ID (e.g. size, colour)" },
23
+ "quantity": { "type": "integer", "description": "Number of units" },
24
+ "unit_price": { "type": "number", "description": "Price per unit at time of order" },
25
+ "discount_override": { "type": "number", "description": "Optional per-item discount amount that overrides any automatically applied discount" },
26
+ "customization": {
27
+ "type": "object",
28
+ "description": "Optional item-level customization options",
29
+ "properties": {
30
+ "engraving": { "type": "string", "description": "Text to engrave on the item" },
31
+ "gift_wrap": { "type": "boolean", "description": "Whether the item should be gift-wrapped" },
32
+ "gift_message": { "type": "string", "description": "Optional message to include with gift wrap" }
33
+ }
34
+ }
35
  }
36
  }
37
  },
 
39
  "currency": { "type": "string", "description": "ISO 4217 currency code (e.g. USD, EUR)" },
40
  "shipping": {
41
  "type": "object",
42
+ "description": "Shipping details including address, method, and recipient information",
43
+ "required": ["address", "method", "country", "recipient_name"],
44
  "properties": {
45
+ "recipient_name": { "type": "string", "description": "Full name of the shipment recipient" },
46
+ "phone": { "type": "string", "description": "Optional E.164 phone number for delivery notifications" },
47
+ "address": { "type": "string", "description": "Full street address of the delivery location" },
48
  "method": { "type": "string", "description": "Shipping method: standard, express, or overnight" },
49
+ "country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code" },
50
+ "instructions": { "type": "string", "description": "Optional special delivery instructions for the carrier" },
51
+ "signature_required": { "type": "boolean", "description": "Optional flag to require a signature upon delivery" }
52
+ }
53
+ },
54
+ "billing": {
55
+ "type": "object",
56
+ "description": "Billing information for the order",
57
+ "required": ["same_as_shipping", "address", "name"],
58
+ "properties": {
59
+ "same_as_shipping": { "type": "boolean", "description": "If true, billing address is copied from the shipping address" },
60
+ "name": { "type": "string", "description": "Name as it appears on the billing account or card" },
61
+ "address": {
62
+ "type": "object",
63
+ "description": "Billing address",
64
+ "properties": {
65
+ "line1": { "type": "string" },
66
+ "line2": { "type": "string" },
67
+ "city": { "type": "string" },
68
+ "state": { "type": "string" },
69
+ "postal_code": { "type": "string" },
70
+ "country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code" }
71
+ }
72
+ }
73
+ }
74
+ },
75
+ "payment": {
76
+ "type": "object",
77
+ "description": "Payment details for the order",
78
+ "required": ["method", "token"],
79
+ "properties": {
80
+ "method": { "type": "string", "description": "Payment method: card, wallet, or buy_now_pay_later" },
81
+ "token": { "type": "string", "description": "Tokenised payment instrument reference" },
82
+ "save_for_future": { "type": "boolean", "description": "Optional flag to save the payment method for future orders" }
83
+ }
84
+ },
85
+ "fulfillment_preference": {
86
+ "type": "object",
87
+ "description": "Optional preferences that govern how the order is fulfilled",
88
+ "properties": {
89
+ "allow_partial": { "type": "boolean", "description": "Whether to allow partial shipment if not all items are available simultaneously" },
90
+ "consolidate_shipments": { "type": "boolean", "description": "Whether to consolidate items into as few shipments as possible" },
91
+ "preferred_carrier": { "type": "string", "description": "Optional preferred carrier name (e.g. FedEx, UPS, USPS)" }
92
+ }
93
+ },
94
+ "gift_order": { "type": "boolean", "description": "Optional flag indicating this is a gift order; suppresses price information in packing slip" },
95
+ "metadata": {
96
+ "type": "object",
97
+ "description": "Optional metadata about how and where the order was placed",
98
+ "properties": {
99
+ "source": { "type": "string", "description": "Order origin: web, mobile, or api" },
100
+ "session_id": { "type": "string", "description": "Browser or app session identifier" },
101
+ "ab_variant": { "type": "string", "description": "Optional A/B test variant the user was assigned to" }
102
  }
103
  }
104
  }
 
106
  "sample_payload": {
107
  "user_id": "usr_4821",
108
  "items": [
109
+ {
110
+ "product_id": "prod_991",
111
+ "quantity": 2,
112
+ "unit_price": 29.99,
113
+ "variant_id": "var_red_m"
114
+ },
115
+ {
116
+ "product_id": "prod_442",
117
+ "quantity": 1,
118
+ "unit_price": 79.99,
119
+ "customization": {
120
+ "engraving": "Happy Birthday!",
121
+ "gift_wrap": true,
122
+ "gift_message": "Enjoy your gift!"
123
+ }
124
+ }
125
  ],
126
  "coupon_code": "SAVE10",
127
  "currency": "USD",
128
  "shipping": {
129
+ "recipient_name": "Alice Johnson",
130
+ "phone": "+14155550101",
131
  "address": "123 Main St, Springfield, IL 62701",
132
  "method": "standard",
133
+ "country": "US",
134
+ "instructions": "Leave at front door if no answer"
135
+ },
136
+ "billing": {
137
+ "same_as_shipping": false,
138
+ "name": "Alice Johnson",
139
+ "address": {
140
+ "line1": "456 Oak Ave",
141
+ "city": "San Francisco",
142
+ "state": "CA",
143
+ "postal_code": "94102",
144
+ "country": "US"
145
+ }
146
+ },
147
+ "payment": {
148
+ "method": "card",
149
+ "token": "tok_visa_4242",
150
+ "save_for_future": true
151
+ },
152
+ "fulfillment_preference": {
153
+ "allow_partial": false,
154
+ "consolidate_shipments": true
155
+ },
156
+ "metadata": {
157
+ "source": "web",
158
+ "session_id": "sess_abc123"
159
  }
160
  }
161
  }
scenarios/03_inventory_adjustment.json CHANGED
@@ -15,7 +15,24 @@
15
  "adjustment_type": { "type": "string", "description": "Type of adjustment: add, remove, or set" },
16
  "quantity": { "type": "integer", "description": "Quantity to add, remove, or set" },
17
  "reason": { "type": "string", "description": "Reason for the adjustment: restock, sale, damage, audit, or transfer" },
18
- "performed_by": { "type": "string", "description": "User ID of the operator performing the adjustment" }
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
19
  }
20
  },
21
  "sample_payload": {
@@ -24,6 +41,13 @@
24
  "adjustment_type": "add",
25
  "quantity": 50,
26
  "reason": "restock",
27
- "performed_by": "usr_ops_77"
 
 
 
 
 
 
 
28
  }
29
  }
 
15
  "adjustment_type": { "type": "string", "description": "Type of adjustment: add, remove, or set" },
16
  "quantity": { "type": "integer", "description": "Quantity to add, remove, or set" },
17
  "reason": { "type": "string", "description": "Reason for the adjustment: restock, sale, damage, audit, or transfer" },
18
+ "performed_by": { "type": "string", "description": "User ID of the operator performing the adjustment" },
19
+ "unit_cost": { "type": "number", "description": "Optional cost per unit for this adjustment, used for inventory valuation" },
20
+ "batch_id": { "type": "string", "description": "Optional batch identifier for lot tracking" },
21
+ "expiry_date": { "type": "string", "description": "Optional ISO 8601 date (YYYY-MM-DD) for the expiry of this batch" },
22
+ "notes": { "type": "string", "description": "Optional free-text notes about the adjustment" },
23
+ "notify": {
24
+ "type": "object",
25
+ "description": "Optional configuration for low-stock notifications triggered by this adjustment",
26
+ "properties": {
27
+ "on_low_stock": { "type": "boolean", "description": "If true, send a notification when stock falls below the threshold" },
28
+ "threshold": { "type": "integer", "description": "Stock level at or below which a low-stock notification is sent" }
29
+ }
30
+ },
31
+ "tags": {
32
+ "type": "array",
33
+ "description": "Optional list of tags for categorising or searching adjustments",
34
+ "items": { "type": "string" }
35
+ }
36
  }
37
  },
38
  "sample_payload": {
 
41
  "adjustment_type": "add",
42
  "quantity": 50,
43
  "reason": "restock",
44
+ "performed_by": "usr_ops_77",
45
+ "unit_cost": 12.50,
46
+ "batch_id": "batch_2026_04",
47
+ "notes": "Spring restock cycle",
48
+ "notify": {
49
+ "on_low_stock": true,
50
+ "threshold": 10
51
+ }
52
  }
53
  }
scenarios/04_transaction_creation.json CHANGED
@@ -8,8 +8,9 @@
8
  "bug_count": { "simple": 2, "moderate": 2, "complex": 2, "total": 6 },
9
  "schema": {
10
  "type": "object",
11
- "required": ["from_account_id", "to_account_id", "amount", "currency", "transaction_type"],
12
  "properties": {
 
13
  "from_account_id": { "type": "string", "description": "Account ID to debit" },
14
  "to_account_id": { "type": "string", "description": "Account ID to credit" },
15
  "amount": { "type": "number", "description": "Transaction amount; must be positive" },
@@ -17,16 +18,85 @@
17
  "transaction_type": { "type": "string", "description": "Type of transaction: debit, credit, or transfer" },
18
  "reference": { "type": "string", "description": "Optional external reference (e.g. invoice number)" },
19
  "description": { "type": "string", "description": "Optional human-readable description" },
20
- "scheduled_at": { "type": "string", "description": "Optional ISO8601 datetime to schedule the transaction; if omitted, executes immediately" }
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
21
  }
22
  },
23
  "sample_payload": {
 
24
  "from_account_id": "acc_8821",
25
  "to_account_id": "acc_1134",
26
  "amount": 250.00,
27
  "currency": "USD",
28
  "transaction_type": "transfer",
29
  "reference": "INV-2026-0042",
30
- "description": "Invoice payment"
 
 
 
 
 
 
 
 
 
 
31
  }
32
  }
 
8
  "bug_count": { "simple": 2, "moderate": 2, "complex": 2, "total": 6 },
9
  "schema": {
10
  "type": "object",
11
+ "required": ["idempotency_key", "from_account_id", "to_account_id", "amount", "currency", "transaction_type"],
12
  "properties": {
13
+ "idempotency_key": { "type": "string", "description": "UUID used to deduplicate retried requests; requests with the same key return the original result without re-executing" },
14
  "from_account_id": { "type": "string", "description": "Account ID to debit" },
15
  "to_account_id": { "type": "string", "description": "Account ID to credit" },
16
  "amount": { "type": "number", "description": "Transaction amount; must be positive" },
 
18
  "transaction_type": { "type": "string", "description": "Type of transaction: debit, credit, or transfer" },
19
  "reference": { "type": "string", "description": "Optional external reference (e.g. invoice number)" },
20
  "description": { "type": "string", "description": "Optional human-readable description" },
21
+ "scheduled_at": { "type": "string", "description": "Optional ISO8601 datetime to schedule the transaction; if omitted, executes immediately" },
22
+ "fee": {
23
+ "type": "object",
24
+ "description": "Optional fee associated with this transaction",
25
+ "properties": {
26
+ "amount": { "type": "number", "description": "Fee amount; must be positive" },
27
+ "currency": { "type": "string", "description": "ISO 4217 currency code of the fee" },
28
+ "bearer": { "type": "string", "description": "Who bears the fee: sender, receiver, or split" }
29
+ }
30
+ },
31
+ "exchange_rate": {
32
+ "type": "object",
33
+ "description": "Optional exchange rate details used when the from and to accounts hold different currencies",
34
+ "properties": {
35
+ "rate": { "type": "number", "description": "Exchange rate applied (from_currency to to_currency)" },
36
+ "provider": { "type": "string", "description": "Name of the exchange rate provider" },
37
+ "locked_until": { "type": "string", "description": "ISO8601 datetime until which the rate is guaranteed" }
38
+ }
39
+ },
40
+ "compliance": {
41
+ "type": "object",
42
+ "description": "Optional compliance and regulatory information for the transaction",
43
+ "properties": {
44
+ "purpose_code": { "type": "string", "description": "Regulatory purpose code (e.g. SUPP for supplier payment, SALA for salary)" },
45
+ "source_of_funds": { "type": "string", "description": "Declared source of funds: salary, savings, investment, or other" },
46
+ "sanctions_check_id": { "type": "string", "description": "Optional ID of an external sanctions screening check result" }
47
+ }
48
+ },
49
+ "limits": {
50
+ "type": "object",
51
+ "description": "Optional limit thresholds to validate the transaction against before execution",
52
+ "properties": {
53
+ "daily_limit": { "type": "number", "description": "Maximum cumulative transfer amount allowed per day for the from account" },
54
+ "per_transaction_limit": { "type": "number", "description": "Maximum amount allowed for a single transaction" }
55
+ }
56
+ },
57
+ "notification": {
58
+ "type": "object",
59
+ "description": "Optional notification configuration for transaction events",
60
+ "properties": {
61
+ "notify_sender": { "type": "boolean", "description": "Whether to notify the sender account holder on completion" },
62
+ "notify_receiver": { "type": "boolean", "description": "Whether to notify the receiver account holder on completion" },
63
+ "channels": {
64
+ "type": "array",
65
+ "description": "Channels to use for notifications: email, sms, or push",
66
+ "items": { "type": "string" }
67
+ }
68
+ }
69
+ },
70
+ "tags": {
71
+ "type": "array",
72
+ "description": "Optional tags for categorising or searching transactions",
73
+ "items": { "type": "string" }
74
+ },
75
+ "metadata": {
76
+ "type": "object",
77
+ "description": "Optional arbitrary key-value metadata attached to the transaction",
78
+ "additionalProperties": { "type": "string" }
79
+ }
80
  }
81
  },
82
  "sample_payload": {
83
+ "idempotency_key": "550e8400-e29b-41d4-a716-446655440000",
84
  "from_account_id": "acc_8821",
85
  "to_account_id": "acc_1134",
86
  "amount": 250.00,
87
  "currency": "USD",
88
  "transaction_type": "transfer",
89
  "reference": "INV-2026-0042",
90
+ "description": "Invoice payment",
91
+ "compliance": {
92
+ "purpose_code": "SUPP",
93
+ "source_of_funds": "salary"
94
+ },
95
+ "notification": {
96
+ "notify_sender": true,
97
+ "notify_receiver": true,
98
+ "channels": ["email"]
99
+ },
100
+ "tags": ["invoice", "supplier"]
101
  }
102
  }
scenarios/05_refund_processing.json CHANGED
@@ -20,12 +20,25 @@
20
  "description": "Optional list of specific line items to refund; if omitted, full refund is assumed",
21
  "items": {
22
  "type": "object",
 
23
  "properties": {
24
- "item_id": { "type": "string" },
25
- "quantity": { "type": "integer" },
26
- "amount": { "type": "number" }
 
27
  }
28
  }
 
 
 
 
 
 
 
 
 
 
 
29
  }
30
  }
31
  },
@@ -34,6 +47,14 @@
34
  "transaction_id": "txn_9901",
35
  "amount": 59.99,
36
  "reason": "customer_request",
37
- "refund_method": "original"
 
 
 
 
 
 
 
 
38
  }
39
  }
 
20
  "description": "Optional list of specific line items to refund; if omitted, full refund is assumed",
21
  "items": {
22
  "type": "object",
23
+ "required": ["item_id", "quantity", "amount"],
24
  "properties": {
25
+ "item_id": { "type": "string", "description": "ID of the line item being refunded" },
26
+ "quantity": { "type": "integer", "description": "Number of units being refunded; must be positive" },
27
+ "amount": { "type": "number", "description": "Refund amount for this line item" },
28
+ "reason": { "type": "string", "description": "Optional per-item reason for refund" }
29
  }
30
  }
31
+ },
32
+ "customer_note": { "type": "string", "description": "Optional note visible to the customer explaining the refund" },
33
+ "internal_note": { "type": "string", "description": "Optional internal note not visible to the customer" },
34
+ "notify_customer": { "type": "boolean", "description": "Whether to send the customer a refund confirmation notification; defaults to true" },
35
+ "metadata": {
36
+ "type": "object",
37
+ "description": "Optional metadata about the source of the refund request",
38
+ "properties": {
39
+ "source": { "type": "string", "description": "System or channel that originated the refund (e.g. support_portal, api, backoffice)" },
40
+ "agent_id": { "type": "string", "description": "ID of the support agent who initiated the refund, if applicable" }
41
+ }
42
  }
43
  }
44
  },
 
47
  "transaction_id": "txn_9901",
48
  "amount": 59.99,
49
  "reason": "customer_request",
50
+ "refund_method": "original",
51
+ "line_items": [
52
+ { "item_id": "item_001", "quantity": 1, "amount": 59.99 }
53
+ ],
54
+ "notify_customer": true,
55
+ "metadata": {
56
+ "source": "support_portal",
57
+ "agent_id": "agt_772"
58
+ }
59
  }
60
  }
scenarios/10_account_creation.json CHANGED
@@ -17,7 +17,59 @@
17
  "phone": { "type": "string", "description": "Optional E.164-format phone number" },
18
  "date_of_birth": { "type": "string", "description": "Optional ISO 8601 date (YYYY-MM-DD)" },
19
  "role": { "type": "string", "description": "Account role: customer, vendor, or admin" },
20
- "terms_accepted": { "type": "boolean", "description": "Must be true; user must accept terms of service" }
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
21
  }
22
  },
23
  "sample_payload": {
@@ -27,6 +79,20 @@
27
  "last_name": "Smith",
28
  "phone": "+14155550123",
29
  "role": "customer",
30
- "terms_accepted": true
 
 
 
 
 
 
 
 
 
 
 
 
 
 
31
  }
32
  }
 
17
  "phone": { "type": "string", "description": "Optional E.164-format phone number" },
18
  "date_of_birth": { "type": "string", "description": "Optional ISO 8601 date (YYYY-MM-DD)" },
19
  "role": { "type": "string", "description": "Account role: customer, vendor, or admin" },
20
+ "terms_accepted": { "type": "boolean", "description": "Must be true; user must accept terms of service" },
21
+ "address": {
22
+ "type": "object",
23
+ "description": "Optional home or primary mailing address",
24
+ "properties": {
25
+ "line1": { "type": "string", "description": "Primary street address line" },
26
+ "line2": { "type": "string", "description": "Optional secondary address line (apartment, suite, etc.)" },
27
+ "city": { "type": "string", "description": "City" },
28
+ "state": { "type": "string", "description": "State or province code" },
29
+ "postal_code": { "type": "string", "description": "Postal or ZIP code" },
30
+ "country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code" }
31
+ }
32
+ },
33
+ "business": {
34
+ "type": "object",
35
+ "description": "Optional business details; applicable when role is vendor",
36
+ "properties": {
37
+ "company_name": { "type": "string", "description": "Legal name of the business" },
38
+ "tax_id": { "type": "string", "description": "Tax identification number (EIN, VAT, etc.)" },
39
+ "industry": { "type": "string", "description": "Industry sector of the business" },
40
+ "website": { "type": "string", "description": "Optional business website URL" },
41
+ "size": { "type": "string", "description": "Company headcount band: 1-10, 11-50, 51-200, 201-1000, or 1000+" }
42
+ }
43
+ },
44
+ "preferences": {
45
+ "type": "object",
46
+ "description": "Optional user preferences set at registration",
47
+ "properties": {
48
+ "language": { "type": "string", "description": "Preferred BCP47 language tag (e.g. en-US)" },
49
+ "timezone": { "type": "string", "description": "Preferred IANA timezone identifier (e.g. America/Chicago)" },
50
+ "currency": { "type": "string", "description": "Preferred ISO 4217 currency code (e.g. USD)" },
51
+ "marketing_opt_in": { "type": "boolean", "description": "Whether the user opts in to marketing communications" }
52
+ }
53
+ },
54
+ "emergency_contact": {
55
+ "type": "object",
56
+ "description": "Optional emergency contact information",
57
+ "properties": {
58
+ "name": { "type": "string", "description": "Full name of the emergency contact" },
59
+ "relationship": { "type": "string", "description": "Relationship to the user (e.g. spouse, parent, sibling)" },
60
+ "phone": { "type": "string", "description": "E.164-format phone number of the emergency contact" }
61
+ }
62
+ },
63
+ "referral_code": { "type": "string", "description": "Optional referral code from an existing user or campaign" },
64
+ "identity_verification": {
65
+ "type": "object",
66
+ "description": "Optional identity document details for KYC verification",
67
+ "properties": {
68
+ "document_type": { "type": "string", "description": "Type of identity document: passport, drivers_license, or national_id" },
69
+ "document_number": { "type": "string", "description": "Document number as it appears on the identity document" },
70
+ "issuing_country": { "type": "string", "description": "ISO 3166-1 alpha-2 code of the country that issued the document" }
71
+ }
72
+ }
73
  }
74
  },
75
  "sample_payload": {
 
79
  "last_name": "Smith",
80
  "phone": "+14155550123",
81
  "role": "customer",
82
+ "terms_accepted": true,
83
+ "address": {
84
+ "line1": "789 Elm Street",
85
+ "city": "Chicago",
86
+ "state": "IL",
87
+ "postal_code": "60601",
88
+ "country": "US"
89
+ },
90
+ "preferences": {
91
+ "language": "en-US",
92
+ "timezone": "America/Chicago",
93
+ "currency": "USD",
94
+ "marketing_opt_in": false
95
+ },
96
+ "referral_code": "REF-ALICE-99"
97
  }
98
  }
scenarios/11_profile_update.json CHANGED
@@ -16,7 +16,30 @@
16
  "phone": { "type": "string", "description": "Optional E.164-format phone number" },
17
  "bio": { "type": "string", "description": "Optional biography text; maximum 500 characters" },
18
  "avatar_url": { "type": "string", "description": "Optional avatar image URL; must use https scheme" },
19
- "preferred_language": { "type": "string", "description": "Optional BCP 47 language tag (e.g. en-US)" }
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
20
  }
21
  },
22
  "sample_payload": {
@@ -24,6 +47,17 @@
24
  "first_name": "Alice",
25
  "last_name": "Johnson",
26
  "bio": "Software engineer at KushoAI",
27
- "preferred_language": "en-US"
 
 
 
 
 
 
 
 
 
 
 
28
  }
29
  }
 
16
  "phone": { "type": "string", "description": "Optional E.164-format phone number" },
17
  "bio": { "type": "string", "description": "Optional biography text; maximum 500 characters" },
18
  "avatar_url": { "type": "string", "description": "Optional avatar image URL; must use https scheme" },
19
+ "preferred_language": { "type": "string", "description": "Optional BCP 47 language tag (e.g. en-US)" },
20
+ "address": {
21
+ "type": "object",
22
+ "description": "Optional mailing address for the user",
23
+ "properties": {
24
+ "line1": { "type": "string", "description": "Primary street address line" },
25
+ "line2": { "type": "string", "description": "Optional secondary address line (apartment, suite, etc.)" },
26
+ "city": { "type": "string", "description": "City" },
27
+ "state": { "type": "string", "description": "State or province code" },
28
+ "postal_code": { "type": "string", "description": "Postal or ZIP code" },
29
+ "country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code" }
30
+ }
31
+ },
32
+ "social_links": {
33
+ "type": "object",
34
+ "description": "Optional social media profile URLs",
35
+ "properties": {
36
+ "twitter": { "type": "string", "description": "Optional Twitter/X profile URL" },
37
+ "linkedin": { "type": "string", "description": "Optional LinkedIn profile URL" },
38
+ "github": { "type": "string", "description": "Optional GitHub profile URL" }
39
+ }
40
+ },
41
+ "notification_email": { "type": "string", "description": "Optional separate email address for notifications, distinct from the login email" },
42
+ "timezone": { "type": "string", "description": "Optional IANA timezone identifier (e.g. America/Los_Angeles)" }
43
  }
44
  },
45
  "sample_payload": {
 
47
  "first_name": "Alice",
48
  "last_name": "Johnson",
49
  "bio": "Software engineer at KushoAI",
50
+ "preferred_language": "en-US",
51
+ "address": {
52
+ "line1": "456 Oak Ave",
53
+ "city": "San Francisco",
54
+ "state": "CA",
55
+ "postal_code": "94102",
56
+ "country": "US"
57
+ },
58
+ "social_links": {
59
+ "linkedin": "https://linkedin.com/in/alicejohnson"
60
+ },
61
+ "timezone": "America/Los_Angeles"
62
  }
63
  }
scenarios/13_appointment_booking.json CHANGED
@@ -17,7 +17,31 @@
17
  "duration_minutes": { "type": "integer", "description": "Duration of the appointment in minutes; must be positive" },
18
  "timezone": { "type": "string", "description": "IANA timezone identifier (e.g. America/New_York)" },
19
  "notes": { "type": "string", "description": "Optional notes for the provider" },
20
- "reminder_minutes": { "type": "integer", "description": "Optional minutes before appointment to send a reminder; must be positive" }
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
21
  }
22
  },
23
  "sample_payload": {
@@ -26,6 +50,12 @@
26
  "service_id": "svc_haircut_01",
27
  "start_time": "2026-04-15T10:00:00",
28
  "duration_minutes": 30,
29
- "timezone": "America/New_York"
 
 
 
 
 
 
30
  }
31
  }
 
17
  "duration_minutes": { "type": "integer", "description": "Duration of the appointment in minutes; must be positive" },
18
  "timezone": { "type": "string", "description": "IANA timezone identifier (e.g. America/New_York)" },
19
  "notes": { "type": "string", "description": "Optional notes for the provider" },
20
+ "reminder_minutes": { "type": "integer", "description": "Optional minutes before appointment to send a reminder; must be positive" },
21
+ "payment": {
22
+ "type": "object",
23
+ "description": "Optional payment details for the appointment",
24
+ "properties": {
25
+ "method": { "type": "string", "description": "Payment method: card, wallet, or insurance" },
26
+ "card_last4": { "type": "string", "description": "Last 4 digits of the card used; applicable when method is card" },
27
+ "insurance_id": { "type": "string", "description": "Insurance policy identifier; applicable when method is insurance" }
28
+ }
29
+ },
30
+ "intake_form": {
31
+ "type": "object",
32
+ "description": "Optional pre-appointment intake form submitted by the patient",
33
+ "properties": {
34
+ "chief_complaint": { "type": "string", "description": "Primary reason for the appointment" },
35
+ "allergies": { "type": "array", "description": "List of known allergies", "items": { "type": "string" } },
36
+ "last_visit": { "type": "string", "description": "Optional ISO 8601 date of the patient's last visit" }
37
+ }
38
+ },
39
+ "send_confirmation": { "type": "boolean", "description": "Whether to send a booking confirmation to the user; defaults to true" },
40
+ "confirmation_channels": {
41
+ "type": "array",
42
+ "description": "Optional list of channels on which to send the confirmation: email, sms, or push",
43
+ "items": { "type": "string" }
44
+ }
45
  }
46
  },
47
  "sample_payload": {
 
50
  "service_id": "svc_haircut_01",
51
  "start_time": "2026-04-15T10:00:00",
52
  "duration_minutes": 30,
53
+ "timezone": "America/New_York",
54
+ "payment": {
55
+ "method": "card",
56
+ "card_last4": "4242"
57
+ },
58
+ "send_confirmation": true,
59
+ "confirmation_channels": ["email", "sms"]
60
  }
61
  }
scenarios/15_recurring_event_creation.json CHANGED
@@ -25,8 +25,68 @@
25
  "end_date": { "type": "string", "description": "ISO8601 date after which no more occurrences are created; required when end_type is date" }
26
  }
27
  },
28
- "attendees": { "type": "array", "description": "Optional list of attendee email addresses", "items": { "type": "string" } },
29
- "location": { "type": "string", "description": "Optional event location" }
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
30
  }
31
  },
32
  "sample_payload": {
@@ -40,6 +100,19 @@
40
  "end_type": "count",
41
  "count": 12
42
  },
43
- "attendees": ["alice@example.com", "bob@example.com"]
 
 
 
 
 
 
 
 
 
 
 
 
 
44
  }
45
  }
 
25
  "end_date": { "type": "string", "description": "ISO8601 date after which no more occurrences are created; required when end_type is date" }
26
  }
27
  },
28
+ "attendees": {
29
+ "type": "array",
30
+ "description": "Optional list of attendees with their roles and notification preferences",
31
+ "items": {
32
+ "type": "object",
33
+ "required": ["email", "role", "notify"],
34
+ "properties": {
35
+ "email": { "type": "string", "description": "Attendee's email address" },
36
+ "name": { "type": "string", "description": "Optional display name of the attendee" },
37
+ "role": { "type": "string", "description": "Attendee role: required, optional, or organizer" },
38
+ "notify": { "type": "boolean", "description": "Whether to send this attendee an invitation and event updates" }
39
+ }
40
+ }
41
+ },
42
+ "location": { "type": "string", "description": "Optional event location" },
43
+ "conference": {
44
+ "type": "object",
45
+ "description": "Optional virtual conference details",
46
+ "properties": {
47
+ "provider": { "type": "string", "description": "Conferencing provider: zoom, teams, meet, or custom" },
48
+ "auto_create": { "type": "boolean", "description": "If true, automatically create a meeting link via the provider's API" },
49
+ "dial_in_numbers": {
50
+ "type": "array",
51
+ "description": "Optional list of dial-in phone numbers for participants without internet access",
52
+ "items": {
53
+ "type": "object",
54
+ "properties": {
55
+ "country": { "type": "string", "description": "Country name or ISO code for this dial-in number" },
56
+ "number": { "type": "string", "description": "E.164 dial-in phone number" }
57
+ }
58
+ }
59
+ }
60
+ }
61
+ },
62
+ "reminders": {
63
+ "type": "array",
64
+ "description": "Optional list of reminders to send before each occurrence",
65
+ "items": {
66
+ "type": "object",
67
+ "properties": {
68
+ "minutes_before": { "type": "integer", "description": "Number of minutes before the event start to send this reminder" },
69
+ "channels": {
70
+ "type": "array",
71
+ "description": "Channels for this reminder: email, sms, or push",
72
+ "items": { "type": "string" }
73
+ }
74
+ }
75
+ }
76
+ },
77
+ "exceptions": {
78
+ "type": "array",
79
+ "description": "Optional list of ISO8601 dates on which the recurring event should be skipped",
80
+ "items": { "type": "string" }
81
+ },
82
+ "visibility": { "type": "string", "description": "Optional event visibility: public, private, or tentative" },
83
+ "color": { "type": "string", "description": "Optional hex colour code for calendar display (e.g. #FF5733)" },
84
+ "categories": {
85
+ "type": "array",
86
+ "description": "Optional list of category labels for the event",
87
+ "items": { "type": "string" }
88
+ },
89
+ "end_datetime": { "type": "string", "description": "Optional ISO8601 datetime; if provided, overrides duration_minutes for the last occurrence" }
90
  }
91
  },
92
  "sample_payload": {
 
100
  "end_type": "count",
101
  "count": 12
102
  },
103
+ "attendees": [
104
+ { "email": "alice@example.com", "name": "Alice Johnson", "role": "organizer", "notify": true },
105
+ { "email": "bob@example.com", "name": "Bob Smith", "role": "required", "notify": true },
106
+ { "email": "carol@example.com", "name": "Carol Lee", "role": "optional", "notify": true }
107
+ ],
108
+ "conference": {
109
+ "provider": "zoom",
110
+ "auto_create": true
111
+ },
112
+ "reminders": [
113
+ { "minutes_before": 30, "channels": ["email"] },
114
+ { "minutes_before": 5, "channels": ["push"] }
115
+ ],
116
+ "visibility": "private"
117
  }
118
  }
scenarios/16_email_dispatch.json CHANGED
@@ -27,7 +27,39 @@
27
  "template_id": { "type": "string", "description": "Optional template ID; if provided, body is ignored" },
28
  "body": { "type": "string", "description": "Email body content; required when template_id is not provided" },
29
  "cc": { "type": "array", "description": "Optional list of CC email addresses", "items": { "type": "string" } },
30
- "priority": { "type": "string", "description": "Send priority: low, normal, or high" }
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
31
  }
32
  },
33
  "sample_payload": {
@@ -35,6 +67,12 @@
35
  "from_name": "KushoAI",
36
  "subject": "Your weekly summary",
37
  "body": "Here is your activity for this week.",
38
- "priority": "normal"
 
 
 
 
 
 
39
  }
40
  }
 
27
  "template_id": { "type": "string", "description": "Optional template ID; if provided, body is ignored" },
28
  "body": { "type": "string", "description": "Email body content; required when template_id is not provided" },
29
  "cc": { "type": "array", "description": "Optional list of CC email addresses", "items": { "type": "string" } },
30
+ "priority": { "type": "string", "description": "Send priority: low, normal, or high" },
31
+ "headers": {
32
+ "type": "object",
33
+ "description": "Optional custom email headers as arbitrary string key-value pairs",
34
+ "additionalProperties": { "type": "string" }
35
+ },
36
+ "tracking": {
37
+ "type": "object",
38
+ "description": "Optional tracking configuration for this email send",
39
+ "properties": {
40
+ "open_tracking": { "type": "boolean", "description": "Whether to track email opens" },
41
+ "click_tracking": { "type": "boolean", "description": "Whether to track link clicks within the email" },
42
+ "utm_campaign": { "type": "string", "description": "Optional UTM campaign identifier appended to tracked links" }
43
+ }
44
+ },
45
+ "send_at": { "type": "string", "description": "Optional ISO8601 datetime to schedule the email for future delivery; if omitted, sends immediately" },
46
+ "tags": {
47
+ "type": "array",
48
+ "description": "Optional list of tags for categorising and filtering sent emails",
49
+ "items": { "type": "string" }
50
+ },
51
+ "attachments": {
52
+ "type": "array",
53
+ "description": "Optional list of file attachments",
54
+ "items": {
55
+ "type": "object",
56
+ "properties": {
57
+ "filename": { "type": "string", "description": "Name of the file as it will appear to the recipient" },
58
+ "content_type": { "type": "string", "description": "MIME type of the attachment (e.g. application/pdf)" },
59
+ "url": { "type": "string", "description": "Publicly accessible URL from which the attachment content will be fetched" }
60
+ }
61
+ }
62
+ }
63
  }
64
  },
65
  "sample_payload": {
 
67
  "from_name": "KushoAI",
68
  "subject": "Your weekly summary",
69
  "body": "Here is your activity for this week.",
70
+ "priority": "normal",
71
+ "tracking": {
72
+ "open_tracking": true,
73
+ "click_tracking": true,
74
+ "utm_campaign": "weekly-digest-2026-04"
75
+ },
76
+ "tags": ["digest", "weekly"]
77
  }
78
  }
scenarios/17_push_notification_config.json CHANGED
@@ -28,7 +28,20 @@
28
  "end": { "type": "string", "description": "End time in HH:MM format" },
29
  "timezone": { "type": "string", "description": "IANA timezone identifier" }
30
  }
31
- }
 
 
 
 
 
 
 
 
 
 
 
 
 
32
  }
33
  },
34
  "sample_payload": {
@@ -42,6 +55,13 @@
42
  "start": "22:00",
43
  "end": "08:00",
44
  "timezone": "America/New_York"
45
- }
 
 
 
 
 
 
 
46
  }
47
  }
 
28
  "end": { "type": "string", "description": "End time in HH:MM format" },
29
  "timezone": { "type": "string", "description": "IANA timezone identifier" }
30
  }
31
+ },
32
+ "notification_types": {
33
+ "type": "object",
34
+ "description": "Optional configuration for which notification presentation types are permitted on the device",
35
+ "properties": {
36
+ "badge": { "type": "boolean", "description": "Whether badge count updates are enabled" },
37
+ "sound": { "type": "boolean", "description": "Whether notification sounds are enabled" },
38
+ "alert": { "type": "boolean", "description": "Whether visible alert notifications are enabled" }
39
+ }
40
+ },
41
+ "badge_count": { "type": "integer", "description": "Optional initial badge count to set on the app icon" },
42
+ "sound_name": { "type": "string", "description": "Optional name of the sound file to play for notifications; use 'default' for the system default sound" },
43
+ "content_available": { "type": "boolean", "description": "Optional flag for iOS background fetch; when true, a silent push is delivered to wake the app" },
44
+ "expiry_seconds": { "type": "integer", "description": "Optional time-to-live in seconds for undelivered notifications; after this period the notification is discarded" }
45
  }
46
  },
47
  "sample_payload": {
 
55
  "start": "22:00",
56
  "end": "08:00",
57
  "timezone": "America/New_York"
58
+ },
59
+ "notification_types": {
60
+ "badge": true,
61
+ "sound": true,
62
+ "alert": true
63
+ },
64
+ "sound_name": "default",
65
+ "expiry_seconds": 86400
66
  }
67
  }
scenarios/18_notification_preferences.json CHANGED
@@ -13,21 +13,48 @@
13
  "user_id": { "type": "string", "description": "Path parameter: ID of the user whose preferences are being set" },
14
  "channels": {
15
  "type": "object",
16
- "description": "Enabled notification delivery channels",
17
  "properties": {
18
- "email": { "type": "boolean" },
19
- "sms": { "type": "boolean" },
20
- "push": { "type": "boolean" }
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
21
  }
22
  },
23
- "frequency": { "type": "string", "description": "Notification delivery frequency: realtime, daily_digest, or weekly_digest" },
24
  "categories": {
25
  "type": "object",
26
  "description": "Per-category opt-in flags",
27
  "properties": {
28
  "marketing": { "type": "boolean" },
29
  "transactional": { "type": "boolean" },
30
- "security": { "type": "boolean" }
 
 
 
31
  }
32
  },
33
  "quiet_hours": {
@@ -38,13 +65,58 @@
38
  "start": { "type": "string", "description": "Start time in HH:MM format; required when enabled is true" },
39
  "end": { "type": "string", "description": "End time in HH:MM format; required when enabled is true" }
40
  }
41
- }
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
42
  }
43
  },
44
  "sample_payload": {
45
  "user_id": "usr_4821",
46
- "channels": { "email": true, "sms": false, "push": true },
 
 
 
 
47
  "frequency": "realtime",
48
- "categories": { "marketing": false, "transactional": true, "security": true }
 
 
 
 
 
 
 
 
 
 
 
 
49
  }
50
  }
 
13
  "user_id": { "type": "string", "description": "Path parameter: ID of the user whose preferences are being set" },
14
  "channels": {
15
  "type": "object",
16
+ "description": "Notification delivery channel configuration",
17
  "properties": {
18
+ "email": {
19
+ "type": "object",
20
+ "description": "Email channel settings",
21
+ "properties": {
22
+ "enabled": { "type": "boolean", "description": "Whether the email channel is active for this user" },
23
+ "verified": { "type": "boolean", "description": "Read-only hint indicating whether the email address has been verified" },
24
+ "address": { "type": "string", "description": "Optional override email address for notifications; defaults to the account email" }
25
+ }
26
+ },
27
+ "sms": {
28
+ "type": "object",
29
+ "description": "SMS channel settings",
30
+ "properties": {
31
+ "enabled": { "type": "boolean", "description": "Whether the SMS channel is active for this user" },
32
+ "verified": { "type": "boolean", "description": "Read-only hint indicating whether the phone number has been verified" },
33
+ "address": { "type": "string", "description": "Optional E.164 phone number to use for SMS notifications; defaults to the account phone" }
34
+ }
35
+ },
36
+ "push": {
37
+ "type": "object",
38
+ "description": "Push notification channel settings",
39
+ "properties": {
40
+ "enabled": { "type": "boolean", "description": "Whether push notifications are active for this user" },
41
+ "verified": { "type": "boolean", "description": "Read-only hint indicating whether a device token has been registered" },
42
+ "address": { "type": "string", "description": "Optional device token or endpoint identifier; typically managed by the push config endpoint" }
43
+ }
44
+ }
45
  }
46
  },
47
+ "frequency": { "type": "string", "description": "Default notification delivery frequency: realtime, daily_digest, or weekly_digest" },
48
  "categories": {
49
  "type": "object",
50
  "description": "Per-category opt-in flags",
51
  "properties": {
52
  "marketing": { "type": "boolean" },
53
  "transactional": { "type": "boolean" },
54
+ "security": { "type": "boolean" },
55
+ "reminders": { "type": "boolean" },
56
+ "social": { "type": "boolean" },
57
+ "product_updates": { "type": "boolean" }
58
  }
59
  },
60
  "quiet_hours": {
 
65
  "start": { "type": "string", "description": "Start time in HH:MM format; required when enabled is true" },
66
  "end": { "type": "string", "description": "End time in HH:MM format; required when enabled is true" }
67
  }
68
+ },
69
+ "per_category_overrides": {
70
+ "type": "object",
71
+ "description": "Optional per-category channel and frequency overrides that take precedence over the top-level settings",
72
+ "additionalProperties": {
73
+ "type": "object",
74
+ "properties": {
75
+ "channels": {
76
+ "type": "object",
77
+ "properties": {
78
+ "email": { "type": "boolean" },
79
+ "sms": { "type": "boolean" },
80
+ "push": { "type": "boolean" }
81
+ }
82
+ },
83
+ "frequency": { "type": "string", "description": "Override frequency for this category: realtime, daily_digest, or weekly_digest" }
84
+ }
85
+ }
86
+ },
87
+ "digest_schedule": {
88
+ "type": "object",
89
+ "description": "Optional schedule configuration used when frequency is daily_digest or weekly_digest",
90
+ "properties": {
91
+ "day_of_week": { "type": "string", "description": "Day of week for weekly digest delivery: mon, tue, wed, thu, fri, sat, or sun" },
92
+ "time": { "type": "string", "description": "Delivery time in HH:MM format (24-hour)" },
93
+ "timezone": { "type": "string", "description": "IANA timezone identifier for the delivery time" }
94
+ }
95
+ },
96
+ "unsubscribe_all": { "type": "boolean", "description": "Master kill switch; when true, no notifications are sent regardless of other settings" },
97
+ "language": { "type": "string", "description": "Optional BCP47 language tag for notification content localisation (e.g. en-US)" }
98
  }
99
  },
100
  "sample_payload": {
101
  "user_id": "usr_4821",
102
+ "channels": {
103
+ "email": { "enabled": true, "address": "alice@example.com" },
104
+ "sms": { "enabled": false },
105
+ "push": { "enabled": true }
106
+ },
107
  "frequency": "realtime",
108
+ "categories": {
109
+ "marketing": false,
110
+ "transactional": true,
111
+ "security": true
112
+ },
113
+ "per_category_overrides": {
114
+ "security": {
115
+ "channels": { "email": true, "sms": true, "push": true },
116
+ "frequency": "realtime"
117
+ }
118
+ },
119
+ "digest_schedule": null,
120
+ "language": "en-US"
121
  }
122
  }
scenarios/19_search_query.json CHANGED
@@ -19,20 +19,133 @@
19
  "price_min": { "type": "number", "description": "Optional minimum price filter" },
20
  "price_max": { "type": "number", "description": "Optional maximum price filter" },
21
  "in_stock": { "type": "boolean", "description": "Optional filter to only return in-stock products" },
22
- "rating_min": { "type": "number", "description": "Optional minimum average rating filter; valid range 1–5" }
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
23
  }
24
  },
25
  "sort_by": { "type": "string", "description": "Sort order: relevance, price_asc, price_desc, rating, or newest" },
26
  "page": { "type": "integer", "description": "Page number; minimum 1" },
27
  "page_size": { "type": "integer", "description": "Results per page; minimum 1, maximum 100" },
28
- "include_facets": { "type": "boolean", "description": "If true, include facet aggregations in the response; defaults to false" }
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
29
  }
30
  },
31
  "sample_payload": {
32
  "query": "wireless headphones",
33
- "filters": { "category": "electronics", "price_max": 200.00, "in_stock": true },
 
 
 
 
 
 
 
 
34
  "sort_by": "relevance",
35
  "page": 1,
36
- "page_size": 20
 
 
 
 
 
 
 
 
 
 
 
 
 
37
  }
38
  }
 
19
  "price_min": { "type": "number", "description": "Optional minimum price filter" },
20
  "price_max": { "type": "number", "description": "Optional maximum price filter" },
21
  "in_stock": { "type": "boolean", "description": "Optional filter to only return in-stock products" },
22
+ "rating_min": { "type": "number", "description": "Optional minimum average rating filter; valid range 1–5" },
23
+ "seller_ids": {
24
+ "type": "array",
25
+ "description": "Optional list of seller IDs to restrict results to",
26
+ "items": { "type": "string" }
27
+ },
28
+ "brand_ids": {
29
+ "type": "array",
30
+ "description": "Optional list of brand IDs to restrict results to",
31
+ "items": { "type": "string" }
32
+ },
33
+ "attribute_filters": {
34
+ "type": "array",
35
+ "description": "Optional structured attribute filters for precise product matching",
36
+ "items": {
37
+ "type": "object",
38
+ "required": ["attribute", "operator", "value"],
39
+ "properties": {
40
+ "attribute": { "type": "string", "description": "Name of the product attribute (e.g. color, battery_life_hours)" },
41
+ "operator": { "type": "string", "description": "Comparison operator: eq (equals), in (one of), or range" },
42
+ "value": { "description": "Filter value; a scalar for eq, an array for in, or an object with min/max keys for range" }
43
+ }
44
+ }
45
+ },
46
+ "geo": {
47
+ "type": "object",
48
+ "description": "Optional geographic proximity filter for location-aware product listings",
49
+ "properties": {
50
+ "lat": { "type": "number", "description": "Latitude of the centre point" },
51
+ "lng": { "type": "number", "description": "Longitude of the centre point" },
52
+ "radius_km": { "type": "number", "description": "Search radius in kilometres" }
53
+ }
54
+ },
55
+ "date_range": {
56
+ "type": "object",
57
+ "description": "Optional date range filter applied to a specific date field",
58
+ "properties": {
59
+ "field": { "type": "string", "description": "Name of the date field to filter (e.g. created_at, updated_at)" },
60
+ "from": { "type": "string", "description": "ISO8601 start datetime (inclusive)" },
61
+ "to": { "type": "string", "description": "ISO8601 end datetime (inclusive)" }
62
+ }
63
+ }
64
  }
65
  },
66
  "sort_by": { "type": "string", "description": "Sort order: relevance, price_asc, price_desc, rating, or newest" },
67
  "page": { "type": "integer", "description": "Page number; minimum 1" },
68
  "page_size": { "type": "integer", "description": "Results per page; minimum 1, maximum 100" },
69
+ "include_facets": { "type": "boolean", "description": "If true, include facet aggregations in the response; defaults to false" },
70
+ "facets": {
71
+ "type": "object",
72
+ "description": "Optional fine-grained facet configuration; takes precedence over include_facets when provided",
73
+ "properties": {
74
+ "enabled": { "type": "boolean", "description": "Whether to compute facet aggregations" },
75
+ "fields": {
76
+ "type": "array",
77
+ "description": "List of fields to aggregate facets for (e.g. brand, price_range, rating)",
78
+ "items": { "type": "string" }
79
+ },
80
+ "max_values_per_facet": { "type": "integer", "description": "Optional maximum number of values to return per facet field" }
81
+ }
82
+ },
83
+ "boost": {
84
+ "type": "array",
85
+ "description": "Optional list of field-value boost rules to promote certain results",
86
+ "items": {
87
+ "type": "object",
88
+ "required": ["field", "value", "factor"],
89
+ "properties": {
90
+ "field": { "type": "string", "description": "Field name to match for boosting" },
91
+ "value": { "description": "Value that triggers the boost" },
92
+ "factor": { "type": "number", "description": "Score multiplier; values greater than 1 promote, less than 1 demote" }
93
+ }
94
+ }
95
+ },
96
+ "personalization": {
97
+ "type": "object",
98
+ "description": "Optional personalization signals to tailor search ranking for the requesting user",
99
+ "properties": {
100
+ "user_id": { "type": "string", "description": "ID of the user; used to load browsing history and preferences" },
101
+ "use_history": { "type": "boolean", "description": "Whether to factor in the user's past browsing and purchase history" },
102
+ "use_location": { "type": "boolean", "description": "Whether to factor in the user's current location for proximity ranking" }
103
+ }
104
+ },
105
+ "spell_check": { "type": "boolean", "description": "Whether to attempt spell correction on the query string; defaults to true" },
106
+ "synonyms_enabled": { "type": "boolean", "description": "Whether to expand the query using the configured synonym dictionary; defaults to true" },
107
+ "highlight": {
108
+ "type": "object",
109
+ "description": "Optional configuration for query-term highlighting in search result snippets",
110
+ "properties": {
111
+ "enabled": { "type": "boolean", "description": "Whether to return highlighted fragments in results" },
112
+ "fields": {
113
+ "type": "array",
114
+ "description": "List of fields to apply highlighting to",
115
+ "items": { "type": "string" }
116
+ },
117
+ "fragment_size": { "type": "integer", "description": "Optional maximum character length of each highlighted fragment" }
118
+ }
119
+ },
120
+ "locale": { "type": "string", "description": "Optional BCP47 locale used to localise prices, dates, and sort behaviour (e.g. en-US)" }
121
  }
122
  },
123
  "sample_payload": {
124
  "query": "wireless headphones",
125
+ "filters": {
126
+ "category": "electronics",
127
+ "price_max": 200.00,
128
+ "in_stock": true,
129
+ "attribute_filters": [
130
+ { "attribute": "color", "operator": "in", "value": ["black", "white"] },
131
+ { "attribute": "battery_life_hours", "operator": "range", "value": { "min": 20 } }
132
+ ]
133
+ },
134
  "sort_by": "relevance",
135
  "page": 1,
136
+ "page_size": 20,
137
+ "facets": {
138
+ "enabled": true,
139
+ "fields": ["brand", "price_range", "rating"]
140
+ },
141
+ "personalization": {
142
+ "user_id": "usr_4821",
143
+ "use_history": true,
144
+ "use_location": false
145
+ },
146
+ "highlight": {
147
+ "enabled": true,
148
+ "fields": ["title", "description"]
149
+ }
150
  }
151
  }
scenarios/20_paginated_listing.json CHANGED
@@ -23,9 +23,18 @@
23
  "tags": { "type": "array", "description": "Optional list of tag strings to filter by", "items": { "type": "string" } },
24
  "condition": { "type": "string", "description": "Optional product condition: new, used, or refurbished" },
25
  "price_min": { "type": "number", "description": "Optional minimum price filter" },
26
- "price_max": { "type": "number", "description": "Optional maximum price filter" }
 
 
 
 
 
 
 
27
  }
28
- }
 
 
29
  }
30
  },
31
  "sample_payload": {
@@ -33,6 +42,17 @@
33
  "page": 1,
34
  "page_size": 25,
35
  "sort_by": "popularity",
36
- "sort_order": "desc"
 
 
 
 
 
 
 
 
 
 
 
37
  }
38
  }
 
23
  "tags": { "type": "array", "description": "Optional list of tag strings to filter by", "items": { "type": "string" } },
24
  "condition": { "type": "string", "description": "Optional product condition: new, used, or refurbished" },
25
  "price_min": { "type": "number", "description": "Optional minimum price filter" },
26
+ "price_max": { "type": "number", "description": "Optional maximum price filter" },
27
+ "rating_min": { "type": "number", "description": "Optional minimum average rating filter; valid range 1–5" },
28
+ "seller_id": { "type": "string", "description": "Optional seller ID to scope results to a single seller" },
29
+ "attributes": {
30
+ "type": "object",
31
+ "description": "Optional arbitrary product attribute filters (e.g. color, size, storage)",
32
+ "additionalProperties": { "type": "string" }
33
+ }
34
  }
35
+ },
36
+ "include_out_of_stock": { "type": "boolean", "description": "Whether to include out-of-stock products in the results; defaults to false" },
37
+ "locale": { "type": "string", "description": "Optional BCP47 locale tag used to localise product names and prices (e.g. en-US)" }
38
  }
39
  },
40
  "sample_payload": {
 
42
  "page": 1,
43
  "page_size": 25,
44
  "sort_by": "popularity",
45
+ "sort_order": "desc",
46
+ "filters": {
47
+ "price_min": 50.00,
48
+ "price_max": 500.00,
49
+ "condition": "new",
50
+ "rating_min": 4.0,
51
+ "attributes": {
52
+ "color": "black",
53
+ "storage": "256GB"
54
+ }
55
+ },
56
+ "locale": "en-US"
57
  }
58
  }