Wimsup Referrals
Manage affiliates and referrals with ease. Whether it is digital or point-of-sale (POS) conversion, you can seamlessly integrate our API to track both types of sale items using a single API. This unified approach simplifies your tracking process and provides a comprehensive overview of your sales performance across various channels. The API-first offering of Wimsup makes it easy to implement…
Wimsup Referrals endpoints
| Method | Endpoint | Description |
|---|---|---|
| Step 1: Account | ||
| POST |
Generate owners dashboard link /dashboard_link_owner |
This will generate a dashboard link. Useful if you are using wimsup dashboard and on BASIC plan. This link is not needed if you are building your dashboard. |
| POST |
Register account /register_account |
Register a master referral account, please use valid email for verification and app keys |
| Step 2: Register Item | ||
| POST |
Register Item /register_item |
Registers referral item for tracking. There is no limit on number of items. Item names are unique to the store. You can use SKU or any short name as name. |
| Step 3: Register Affiliates | ||
| POST |
Register code /register_code |
Registers code an item. You can register as many codes you want |
| POST |
Generate dashboard link /dashboard_link |
This will generate a dashboard link. Useful if you are using wimsup dashboard and on BASIC plan. This link is not needed if you are building your dashboard. |
| Step 4 : convert | ||
| POST |
Convert code /convert_code |
Convert registered code |
| Data | ||
| POST |
Codes per Referral ID /codes_per_refid |
Get all codes for a referral ID, This can be email or unique ID you set during registering a code |
| POST |
Items /items |
Get all items (Products) you have registered to track referrals |
| POST |
Affiliates /codes |
Get all codes |
| POST |
Conversions /conversions |
Returns all conversions for your app |
| Deals and Claims | ||
| POST |
Deal Offers /offers |
All offers related apis see offers, claim, validate codes etc. |
| POST |
claim offer /claim_offer |
claims and registers the offer |
| Other endpoints | ||
| POST |
Register Item /register_item |
Registers referral item for tracking. There is no limit on number of items. Item names are unique to the store. You can use SKU or any short name as name. |
| POST |
Convert code /convert_code |
Convert registered code |
| POST |
Register code /register_code |
Registers code an item. You can register as many codes you want |
| POST |
Codes per Referral ID /codes_per_refid |
Get all codes for a referral ID, This can be email or unique ID you set during registering a code |
| POST |
Generate owners dashboard link /dashboard_link_owner |
This will generate a dashboard link. Useful if you are using wimsup dashboard and on BASIC plan. This link is not needed if you are building your dashboard. |
| POST |
Items /items |
Get all items (Products) you have registered to track referrals |
| POST |
claim offer /claim_offer |
claims and registers the offer |
| POST |
Generate dashboard link /dashboard_link |
This will generate a dashboard link. Useful if you are using wimsup dashboard and on BASIC plan. This link is not needed if you are building your dashboard. |
| POST |
Codes /codes |
Get all codes |
| POST |
Deal Offers /offers |
deal |
| POST |
Register account /register_account |
Register a master referral account, please use valid email for verification and app keys |
| POST |
Conversions /conversions |
gets all conversions |
Wimsup Referrals pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | $4.99 / month | — |
|
| PRO | $6.99 / month | 50 / minute |
|
| ULTRA Recommended | $19.99 / month | — |
|
| MEGA | $49.99 / month | — |
|