> For the complete documentation index, see [llms.txt](https://help.checkoutchamp.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.checkoutchamp.com/crm/plugins/data-sources/re-amaze.md).

# Re:amaze

This article is a guide to connect your Re:amaze account with CheckoutChamp.

{% hint style="info" %}
Re:amaze CheckoutChamp Integration Documentation
{% endhint %}

***

### Step 1: Add an API User for Re:amaze <a href="#re-amaze-step1-addanapiuserforre-amaze" id="re-amaze-step1-addanapiuserforre-amaze"></a>

Follow the instructions here to add an API User in CheckoutChamp. Take note of the loginId and password for Step &#x32;**.**

[Create An API User](/crm/admin-setup/create-a-user/create-an-api-user.md)

After creating the user go back to edit and save the user again

{% hint style="info" %}
The user must have only “REAMAZE” listed in the **IP Whitelist** field. Do not list any other IP addresses.
{% endhint %}

{% hint style="info" %}
The user must have access to the following endpoints:

* Update Order
* Query Orders
* Refund Order
* Cancel Order
* Query Customers
* Add Customer Note
* Update Customer
* Query Purchase
  {% endhint %}

### Step 2: Configure Re:amaze <a href="#re-amaze-step2-configurere-amaze" id="re-amaze-step2-configurere-amaze"></a>

**Login to Re:amaze and navigate to Settings → Custom Module**

Enter the following for **Custom module url**. Replace {loginId} and {password} with the credentials from Step 1.

<https://api.checkoutchamp.com/plugin/reamaze/?loginId={loginId}\\&password={password}>

<figure><img src="https://3790748257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FT43PzcNjyZtWby9yrGd3%2Fuploads%2FPmAfJ67sCVE1afAmQvB2%2Fimage.png?alt=media&amp;token=30096973-38a5-4971-a256-48b572affdf3" alt=""><figcaption></figcaption></figure>

### Step 3: Test Re:amaze <a href="#re-amaze-step3-testre-amaze" id="re-amaze-step3-testre-amaze"></a>

Orders are retrieved from CheckoutChamp based on the email address used in the ticket.

<figure><img src="https://3790748257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FT43PzcNjyZtWby9yrGd3%2Fuploads%2Ffu5PJNePZQmIIRjrIOFv%2Fimage.png?alt=media&amp;token=45ab4da3-04c9-4d4c-b940-63635435cb34" alt=""><figcaption></figcaption></figure>

&#x20;