Custom Endpoints

Returns a personalized list of products based on the given query parameter.

GET /api/v1/custom/id/{ Ruleset ID }

📘

Notes

To use this endpoint you must add a valid ruleset ID to /api/v1/custom/id/{ Ruleset ID }

Using Rebuy's GUI

You can use our GET /api/v1/custom/id/{ Ruleset ID } endpoint through our Graphical User Interface (GUI). We allow access to this feature with what we call data sources. In data sources, you can create a set of conditional rules (ie. a ruleset). If those conditions are met by one of your customers, this endpoint will return them a list of products.

Once created, data sources can be applied to power widgets. However, this page doesn't go into detail on how to create and use widgets.

Navigating to the Data Source Editor

First, log into Rebuy Engine
In the left navigation bar, select Data Sources

Alt text

Creating Rulesets

To create a ruleset, select the Create Ruleset button.

Alt text

After creating a ruleset, you can set your first rule. Rulesets can be powered by only one rule, or you can choose to stack multiple rules for further customization.

Alt text

For each rule block, there is an "IF" condition and a "RETURN" statement.

![Alt text](https://rebuyengine.com/media/images/rule_if_and_return_blank.png "A blank "if" and "return" block in the data source editor.")

"IF" conditions

For each "IF" condition, you define parameters that can tell us when a certain condition is met.

Alt text

This is where our GUI and endpoint synchronize so well. At this stage, you are literally defining what information you are sending to our API.

You can make your "IF" condition more complex if you add "AND IF" or "OR IF" statements into the rule.

Alt text

"RETURN" statements

For each "RETURN" Statement, you define parameters that can tell our API what to return to your customer. This is another area where our GUI and endpoint synchronize so well. At this stage, you are literally defining what information you are receiving from our API.

Alt text

You can make your "RETURN" statements more complex if you add "AND" statements into the rule.

Alt text

Example Data Sources

Below you will find some great ways that our clients have effectively used this feature.

The associated upsell

In the example below, if the grooming kit is chosen by the customer, we will display them some essentials that go along with the kit. In other words, your shop is ready to sell them a product and as a result we want to upsell them another product.

Alt text

More Reading

Read more on widgets

Language
Credentials
Query
Click Try It! to start a request and see the response here!