? How to Use Custom API Status Values in SiteVibes

Modified on Wed, 4 Jun at 11:57 AM

If you're sending orders to SiteVibes via API (e.g., from an ERP, POS, or custom system), you can define custom order statuses that trigger loyalty point rewards.

This is only needed for API-based orders — Shopify BigCommerce, Magento and other supported integrations pass statuses automatically.

Where to Configure

Go to:
Loyalty > Program > Settings > Loyalty Tab > Reward from orders

In the Custom API status values section, add the status names your system sends (e.g., shipped, completed, ready_to_pickup).

?️ How It Works

When your system sends an order status via API, SiteVibes will only trigger loyalty points if the status is listed in this section.

? API Reference – POST Order Status

Example:

POST /order-data/M4088700/status 
{  "status": "shipped" }

If shipped is registered, loyalty points will be awarded.

✅ Common Use Cases

System	Status	Reward Triggered When...
ERP	`order_delivered`	Order is marked delivered
POS	`completed`	In-store purchase is completed
Custom	`ready_to_pickup`	Customer picks up the order

Need help? Contact SiteVibes support or your onboarding manager.