Documentation
Everything, written down.
How CODGuard installs, what each setting does, which endpoints the storefront calls, and what happens on every order. Written to be read in order, or searched when something breaks.
Getting started
Configuration
- OTP verificationChannels, code rules, rate limits, templates and the returning-customer skip.
- Payment modesCOD, prepaid incentives and partial payments — how each flow is built.
- Business rulesBlock COD by pincode, cart value, product or collection — and add a handling fee.
- RTO risk scoringHow the 0–100 score is produced, and what auto-flag and auto-cancel do.
- Modal designTheming and copy for the storefront verification modal.
- Message templatesLifecycle events, editable bodies and template variables.
Reference
- API referenceThe app-proxy endpoints the storefront modal calls.
- Order attributesThe attributes CODGuard writes to every checkout, and who reads them.
- WebhooksTopics CODGuard subscribes to and what each one triggers.
- Data model & scopesWhat CODGuard stores, and which Shopify permissions each capability needs.
Operations
- Analytics & logsWhat the dashboard measures and how to read the event log.
- Address correctionFix an undeliverable address before the courier finds it.
- BillingPlans, message rates, what is billable, and how history is valued.
- TroubleshootingThe failures merchants hit most, and what each one actually means.
Not covered here?
Send the order number and a timestamp. Every message, event and error is logged per shop, so that is usually enough to find the exact cause.
