¶ Overview
There are two options when creating Reps in Freedom through API.
- Basic or Minimal Rep Creation where only the Rep record is created and the signup order flow is handled through a separate process.
- Online Signup Flows where in addition to the Rep record, ByDesign is being leveraged for the sign up order and inventory is maintained in Freedom. This includes inventory, payment processing and order creation.
¶ Data Look Ups
When creating a Rep in Freedom there are three pieces of information that should be validated BEFORE creating the Rep record. The following APIs should be used to look up against Freedom as the system of record:
| Look Up | Method |
|---|---|
| Check Sponsor Exists | GET /api/user/rep/{repDID}/info |
| Check ReplicatedSiteName Doesn't Exist | POST api/rep/validateRepURL |
| Check Enrollee Email Doesn't Exist | POST api/rep/validateRepEmail |
In addition to these look ups, you will need to identify the Bonus Payout method the Rep should be set to. If you only offer check or direct deposit, you may choose to simply hard code those IDs. If there are more payout options and they are based on where the enrollee is signing up from, ByDesign suggests utiliing this look up to get the correct Bonus Payout method
| Look Up | Method |
|---|---|
| Available Bonus Payout Methods | GET /api/PayoutMethod/List |
¶ Basic Unlievel Rep Signup Workflow
It is important that before creating a Rep the data validations noted above have been completed. Once you are read to create a Rep and you have confirmed all the data is valid, you will call POST api/rep/Create
¶ Online Signup Workflow
In addition to the data validations noted above, when creating Reps through the Online Signup Workflow, the following lookups need to be performed.
| Look Up | Method |
|---|---|
| Available RepTypes | GET api/admin/repType |
| Available RankTypes | GET api/admin/rankType |
| Items Available for Enrollment | GET api/inventory/InventoryShopping/GetEnrollmentItems?repDID={repDID}&langKey={langKey}&country={country}&cartConfigurationId={cartConfigurationId}&localeID={localeID} |
When utilizing the Online Signup flow, the calls should be made in the following order as demonstrated in the diagram. It is important to note that once you start the Online Signup Order it follows the same process as the OnlineOrder for regular orders.
- Create OnlineSignup: POST api/order/OnlineSignup?sponsorRepDID={sponsorRepDID}
- Update OnlineSignup: PUT api/order/OnlineSignup?onlineSignupID={onlineSignupID}
- Create Online Signup Order: POST api/order/OnlineOrder/CreateForOnlineSignup?onlineSignupGuid={onlineSignupGuid}&country={country}&cartConfigurationID={cartConfigurationID}
- Update Online Signup Order: PUT api/order/OnlineOrder/UpdateForOnlienSignup?onlineSignupGuid={onlineSignupGuid}&sponsorRepDID={SponsorRepDID}&country={country}
- Follow the same process for evaluatiing promotions, shipping methods, tax as a regular OnlineOrder: Online Order Flow
- Once the order has been completed it is now time to create the new Rep and Order.
¶ Upgrade from Customer to Rep
If upgrading from a Customer to a Rep is permitted by the company, the new Rep account does not have be created through the methods above and can follow this flow instead.
- Veryify the customer account exists with the email provided.
- Customer Lookup: POST api/users/customer/CustomerLookup
- Once verified, upgrade the to a Rep.