Here's the full API list mapped to the schema, ordered by build sequence so your backend developer knows what to build first.
Phase 1 — Auth & Shop Install
| Index |
API Name |
Endpoint |
Type |
Description |
Connected DB Table (Operation) |
Sequence |
Connected API |
Auth Required |
| 1 |
Shopify OAuth Install |
/auth/install |
GET |
Starts Shopify OAuth flow for new install |
shops (WRITE) |
1 |
Shopify OAuth Callback |
No |
| 2 |
Shopify OAuth Callback |
/auth/callback |
GET |
Completes OAuth, stores access token, creates shop |
shops (WRITE), shop_settings (WRITE), shop_preferences (WRITE), shop_subscription (WRITE), shop_usage (WRITE) |
2 |
Shopify OAuth Install |
No |
| 3 |
App Uninstalled Webhook |
/webhooks/app/uninstalled |
POST |
Marks shop inactive on uninstall |
shops (UPDATE) |
3 |
— |
Webhook HMAC |
| 4 |
Create Admin User Session |
/auth/session |
POST |
Creates merchant admin login session |
users (WRITE), user_sessions (WRITE) |
4 |
Shopify OAuth Callback |
No |
| 5 |
Verify Session |
/auth/verify |
GET |
Validates active admin session token |
user_sessions (READ) |
5 |
Create Admin User Session |
Session |
| 6 |
Generate API Key |
/admin/api/api-keys |
POST |
Issues a public API key for a merchant |
api_keys (WRITE) |
6 |
Verify Session |
Session |
| 7 |
Revoke API Key |
/admin/api/api-keys/:id |
DELETE |
Revokes an issued API key |
api_keys (UPDATE) |
7 |
Generate API Key |
Session |
Phase 2 — Shopify Sync
| Index |
API Name |
Endpoint |
Type |
Description |
Connected DB Table (Operation) |
Sequence |
Connected API |
Auth Required |
| 8 |
Product Sync (Full) |
/internal/sync/products |
POST |
Bulk-syncs all products on install |
shopify_products (WRITE) |
8 |
OAuth Callback |
Internal |
| 9 |
Product Webhook (Create/Update) |
/webhooks/products/update |
POST |
Syncs single product on change |
shopify_products (UPDATE) |
9 |
Product Sync (Full) |
Webhook HMAC |
| 10 |
Product Webhook (Delete) |
/webhooks/products/delete |
POST |
Removes product on deletion |
shopify_products (DELETE) |
10 |
Product Sync (Full) |
Webhook HMAC |
| 11 |
Collection Sync |
/internal/sync/collections |
POST |
Syncs product collections |
shopify_collections (WRITE) |
11 |
Product Sync (Full) |
Internal |
| 12 |
Customer Sync |
/internal/sync/customers |
POST |
Bulk-syncs customers |
shopify_customers (WRITE) |
12 |
OAuth Callback |
Internal |
| 13 |
Customer Webhook |
/webhooks/customers/update |
POST |
Syncs single customer on change |
shopify_customers (UPDATE) |
13 |
Customer Sync |
Webhook HMAC |
| 14 |
Order Sync |
/internal/sync/orders |
POST |
Bulk-syncs historical orders |
shopify_orders (WRITE), shopify_order_items (WRITE) |
14 |
OAuth Callback |
Internal |
| 15 |
Order Paid Webhook |
/webhooks/orders/paid |
POST |
Triggers review-request eligibility |
shopify_orders (UPDATE) |
15 |
Order Sync, Create Review Request |
Webhook HMAC |
| 16 |
Order Fulfilled Webhook |
/webhooks/orders/fulfilled |
POST |
Marks order fulfilled, may trigger reminder |
shopify_orders (UPDATE) |
16 |
Order Sync |
Webhook HMAC |
| 17 |
Webhook Log Viewer |
/admin/api/webhooks/logs |
GET |
Lists recent webhook processing status |
shopify_webhooks (READ) |
17 |
— |
Session |
Phase 3 — Review Engine (Core)
| Index |
API Name |
Endpoint |
Type |
Description |
Connected DB Table (Operation) |
Sequence |
Connected API |
Auth Required |
| 18 |
Submit Review |
/api/v1/reviews |
POST |
Customer submits a review (public storefront) |
reviews (WRITE), customers (WRITE/UPDATE), review_media (WRITE) |
18 |
Verify Order Ownership |
API Key |
| 19 |
Verify Order Ownership |
/internal/reviews/verify-order |
POST |
Confirms customer bought the product |
shopify_order_items (READ), shopify_orders (READ) |
19 |
— |
Internal |
| 20 |
Get Review by ID |
/admin/api/reviews/:id |
GET |
Fetch single review detail for admin |
reviews (READ), review_media (READ), review_ai (READ) |
20 |
— |
Session |
| 21 |
List Reviews (Admin) |
/admin/api/reviews |
GET |
Paginated/filterable review list for merchant |
reviews (READ) |
21 |
— |
Session |
| 22 |
Approve Review |
/admin/api/reviews/:id/approve |
PATCH |
Approves a pending review, publishes it |
reviews (UPDATE), review_history (WRITE) |
22 |
Rebuild Product Payload |
Session |
| 23 |
Reject Review |
/admin/api/reviews/:id/reject |
PATCH |
Rejects a review |
reviews (UPDATE), review_history (WRITE) |
23 |
Rebuild Product Payload |
Session |
| 24 |
Edit Review |
/admin/api/reviews/:id |
PUT |
Merchant edits review content |
reviews (UPDATE), review_history (WRITE) |
24 |
Rebuild Product Payload |
Session |
| 25 |
Delete Review |
/admin/api/reviews/:id |
DELETE |
Soft-deletes a review |
reviews (UPDATE), review_history (WRITE) |
25 |
Rebuild Product Payload |
Session |
| 26 |
Feature Review |
/admin/api/reviews/:id/feature |
PATCH |
Marks review as featured/highlighted |
reviews (UPDATE) |
26 |
Rebuild Product Payload |
Session |
| 27 |
Reply to Review |
/admin/api/reviews/:id/reply |
POST |
Merchant posts a public reply |
review_replies (WRITE) |
27 |
Rebuild Product Payload |
Session |
| 28 |
Vote Helpful |
/api/v1/reviews/:id/vote |
POST |
Visitor votes review helpful/not |
review_votes (WRITE), reviews (UPDATE) |
28 |
— |
API Key |
| 29 |
Report Review |
/api/v1/reviews/:id/report |
POST |
Visitor reports a review |
review_reports (WRITE), reviews (UPDATE) |
29 |
— |
API Key |
| 30 |
Tag Review |
/internal/reviews/:id/tags |
POST |
Applies tags (manual or AI-generated) |
review_tags (WRITE) |
30 |
AI Auto-Tag Job |
Internal |
Phase 4 — Storefront Widget (Public, Read-Heavy)
| Index |
API Name |
Endpoint |
Type |
Description |
Connected DB Table (Operation) |
Sequence |
Connected API |
Auth Required |
| 31 |
Get Widget Payload |
/api/v1/widget/:productId |
GET |
The storefront endpoint — one call, one row |
product_review_payload (READ) |
31 |
Rebuild Product Payload |
API Key |
| 32 |
Rebuild Product Payload |
/internal/widget/rebuild/:productId |
POST |
Async job: recomputes payload after any write |
review_rating_summary (READ), reviews (READ), review_media (READ), product_review_payload (WRITE) |
32 |
Approve/Edit/Delete Review, Reply, Vote |
Internal |
| 33 |
Get Widget Settings (Public) |
/api/v1/widget/:shopId/settings |
GET |
Fetches display config for storefront render |
widget_settings (READ), widget_theme (READ), widget_layout (READ) |
33 |
— |
API Key |
| 34 |
Update Widget Settings |
/admin/api/widget/settings |
PUT |
Merchant toggles show images/videos/per-page |
widget_settings (UPDATE) |
34 |
Rebuild Product Payload |
Session |
| 35 |
Update Widget Theme |
/admin/api/widget/theme |
PUT |
Merchant sets colors/fonts |
widget_theme (UPDATE) |
35 |
— |
Session |
| 36 |
Update Widget Layout |
/admin/api/widget/layout |
PUT |
Merchant sets grid/list/card style |
widget_layout (UPDATE) |
36 |
— |
Session |
Phase 5 — AI Layer
| Index |
API Name |
Endpoint |
Type |
Description |
Connected DB Table (Operation) |
Sequence |
Connected API |
Auth Required |
| 37 |
Generate Review from Rating |
/internal/ai/generate-review |
POST |
Auto-writes review text for 4-5 star ratings |
ai_jobs (WRITE), review_ai (WRITE), ai_prompts (READ) |
37 |
Submit Review |
Internal |
| 38 |
Generate Improvement Suggestion |
/internal/ai/suggest-followup |
POST |
Creates guided questions for 1-3 star ratings |
ai_jobs (WRITE), review_ai (WRITE) |
38 |
Submit Review |
Internal |
| 39 |
AI Job Status |
/admin/api/ai/jobs/:id |
GET |
Checks status of an AI job |
ai_jobs (READ) |
39 |
— |
Session |
| 40 |
Sentiment Analysis Job |
/internal/ai/sentiment |
POST |
Scores review sentiment |
review_ai (UPDATE), ai_jobs (WRITE) |
40 |
Submit Review |
Internal |
| 41 |
Spam Detection Job |
/internal/ai/spam-check |
POST |
Flags likely spam reviews |
review_ai (UPDATE), reviews (UPDATE) |
41 |
Submit Review |
Internal |
| 42 |
Auto-Tag Job |
/internal/ai/auto-tag |
POST |
Generates tags from review content |
review_tags (WRITE), ai_jobs (WRITE) |
42 |
Tag Review |
Internal |
| 43 |
Submit AI Feedback |
/admin/api/ai/feedback |
POST |
Merchant rates AI output quality |
ai_feedback (WRITE) |
43 |
— |
Session |
| 44 |
Get AI Usage |
/admin/api/ai/usage |
GET |
Shows AI request count/cost this period |
ai_usage (READ) |
44 |
— |
Session |
Phase 6 — Review Collection (Requests)
| Index |
API Name |
Endpoint |
Type |
Description |
Connected DB Table (Operation) |
Sequence |
Connected API |
Auth Required |
| 45 |
Create Review Request |
/internal/review-requests |
POST |
Queues a post-purchase review request |
email_queue (WRITE) |
45 |
Order Paid Webhook |
Internal |
| 46 |
Send Review Reminder |
/internal/review-requests/reminder |
POST |
Sends follow-up if no review submitted |
email_queue (WRITE) |
46 |
Create Review Request |
Internal |
Phase 7 — Merchant Admin & Analytics
| Index |
API Name |
Endpoint |
Type |
Description |
Connected DB Table (Operation) |
Sequence |
Connected API |
Auth Required |
| 47 |
Get Dashboard Summary |
/admin/api/dashboard |
GET |
Overview stats for admin home screen |
daily_shop_stats (READ), shop_usage (READ) |
47 |
— |
Session |
| 48 |
Get Product Analytics |
/admin/api/analytics/products/:id |
GET |
Per-product rating trend and breakdown |
daily_product_stats (READ), review_rating_summary (READ) |
48 |
— |
Session |
| 49 |
Get Shop Analytics |
/admin/api/analytics/shop |
GET |
Shop-wide trend over time |
daily_shop_stats (READ) |
49 |
— |
Session |
| 50 |
Get AI Insights |
/admin/api/analytics/insights/:productId |
GET |
Sentiment/tag breakdown per product |
product_review_summary (READ) |
50 |
— |
Session |
| 51 |
Update Shop Settings |
/admin/api/shop/settings |
PUT |
Toggles auto-approve, require-order, etc. |
shop_settings (UPDATE) |
51 |
— |
Session |
| 52 |
Update Shop Preferences |
/admin/api/shop/preferences |
PUT |
Language, currency, date format |
shop_preferences (UPDATE) |
52 |
— |
Session |
Phase 8 — Billing
| Index |
API Name |
Endpoint |
Type |
Description |
Connected DB Table (Operation) |
Sequence |
Connected API |
Auth Required |
| 53 |
List Plans |
/api/v1/billing/plans |
GET |
Fetches available pricing tiers |
plans (READ) |
53 |
— |
Session |
| 54 |
Create Subscription Charge |
/admin/api/billing/subscribe |
POST |
Initiates Shopify recurring charge |
subscriptions (WRITE), billing_events (WRITE) |
54 |
List Plans |
Session |
| 55 |
Billing Charge Callback |
/webhooks/billing/callback |
POST |
Confirms charge activation from Shopify |
subscriptions (UPDATE), billing_events (WRITE), shop_subscription (UPDATE) |
55 |
Create Subscription Charge |
Webhook HMAC |
| 56 |
Cancel Subscription |
/admin/api/billing/cancel |
POST |
Cancels current subscription |
subscriptions (UPDATE), billing_events (WRITE) |
56 |
— |
Session |
| 57 |
Record Usage Charge |
/internal/billing/usage-record |
POST |
Logs metered AI usage for billing |
usage_records (WRITE) |
57 |
AI Job endpoints |
Internal |
| 58 |
Get Billing History |
/admin/api/billing/history |
GET |
Lists past charges/events |
billing_events (READ) |
58 |
— |
Session |
Phase 9 — Notifications
| Index |
API Name |
Endpoint |
Type |
Description |
Connected DB Table (Operation) |
Sequence |
Connected API |
Auth Required |
| 59 |
Create Notification |
/internal/notifications |
POST |
Creates in-app alert for merchant |
notifications (WRITE) |
59 |
Approve/Report Review, Low Rating |
Internal |
| 60 |
List Notifications |
/admin/api/notifications |
GET |
Fetches merchant's notification feed |
notifications (READ) |
60 |
— |
Session |
| 61 |
Mark Notification Read |
/admin/api/notifications/:id/read |
PATCH |
Marks a notification as read |
notifications (UPDATE) |
61 |
— |
Session |
Phase 10 — Public API (External Developers/Partners)
| Index |
API Name |
Endpoint |
Type |
Description |
Connected DB Table (Operation) |
Sequence |
Connected API |
Auth Required |
| 62 |
Public: Get Reviews |
/public/api/v1/products/:id/reviews |
GET |
External API for reviews by product |
reviews (READ), review_media (READ) |
62 |
Generate API Key |
API Key |
| 63 |
Public: Get Product Summary |
/public/api/v1/products/:id/summary |
GET |
External API for rating summary |
review_rating_summary (READ) |
63 |
Generate API Key |
API Key |
Build order logic: Phases 1–3 are your MVP-blocking path (nothing else works without auth, sync, and reviews). Phase 4 (widget) can start as soon as Phase 3's reviews table has data — it doesn't need AI or billing to exist. Phases 5–10 can be parallelized across the team once the core loop works end-to-end.
Want this exported as an actual .md file so you can drop it straight into your repo's /docs folder?