# Integrate with The Wishlist (app)

## What is The Wishlist?

The Wishlist is a tool that enhances the customer experience by enabling users to create and manage wishlists on your e-commerce store. It provides an easy way for retailers to capture shopper details and preferences, both in-store and online, and automatically generates personalised marketing campaigns that build engagement and drive sales.

{% hint style="info" %}
[thewishlist.io](https://www.thewishlist.io/)
{% endhint %}

<figure><img src="/files/lN8JzBPV6kKBCcH4HTsN" alt="" width="563"><figcaption></figcaption></figure>

## Pre-requisites

* A Shopify store with DotApparel Core installed (includes Apparel21 API credentials)
* A Firebase project upgraded to the Blaze plan
* Shopify store access with permission to install a private app on the Shopify store

## Steps for the setup

<table><thead><tr><th width="527">Steps</th><th>Responsibility</th></tr></thead><tbody><tr><td><p></p><p><strong>Install DotApparel Core</strong>: Ensure your Shopify store has DotApparel Core installed.</p></td><td>DotApparel</td></tr><tr><td><strong>Install The Wishlist App</strong>: Follow the installation instructions provided by The Wishlist.</td><td>The Wishlist</td></tr><tr><td><strong>Setup the CSVs</strong>: Setup the automated <code>customers.csv</code> and <code>orders.csv</code> exports in Apparel21.</td><td>Apparel21 Consultant</td></tr><tr><td><p><strong>Configure Settings</strong>: Customise DotApparel Core settings to fit your store's needs.</p><ul><li>Once configured, CSV files are uploaded to the SFTP.</li><li>DotApparel API processes these files and stores the data in the database (Firebase project within DotApparel Core).</li><li>The Wishlist accesses this data via the DotApparel APIs.</li></ul></td><td>DotApparel</td></tr><tr><td><strong>Test End-to-End:</strong> Conduct thorough testing (i.e., verify that saved wishlist items are appearing across devices)</td><td>Merchant &#x26; The Wishlist</td></tr></tbody></table>

## What is needed to setup The Wishlist?

* **DotApparel API:**
  * The Wishlist has access to all DotApparel API endpoints [mentioned here](https://developers.dotapparel.com.au/api/reference).
  * The Wishlist primarily uses `POST` and `GET` endpoints for customer and order data.
* **CSV Files**:
  * Both the `customers.csv` and `orders.csv` are required.

    **Note:** The CSV templates might be different from DotApparel Customers. Particularly, `orders.csv` must include online transactions.
  * An Apparel21 Consultant needs access to your Apparel21 instance to configure file exports.
  * The CSV files are used for `/customers/search` and `/orders/transactions/search` endpoints as a workaround to get both online and in-store data. Without this, the Apparel21 API only returns online data.

## Sync Frequency for CSV files

Data sync frequency can vary from daily to every 15 minutes for more real-time updates. This needs to be predetermined and set up by an Apparel21 specialist.

## **Costs**

* **Subscription Fees**: The use of DotApparel API incurs a fixed monthly charge of A$300, automatically billed to the merchant via Stripe.
* **Additional Charges**: Our Apparel21 Consultant my charge additional for any changes relating to the Apparel21 CSV exports.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.dotapparel.com.au/core/modules/integrate-with-the-wishlist-app.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
