{"section":"tutorials","requestedLocale":"en","requestedSlug":"affiliates-program-app","locale":"en","slug":"affiliates-program-app","path":"docs/en/tutorials/apps/affiliates-program-app.md","branch":"main","content":"> ℹ️ The **Affiliates Program** is an app that is only supported by [VTEX IO](/en/docs/tracks/cms-vtex-io) stores and is not available for stores that use [Legacy Portal CMS](/en/docs/tracks/legacy-cms-portal) or [Headless CMS](https://www.faststore.dev/tutorials/cms/0#vtex-headless-cms). Please visit the Affiliates Program app developer guide to install and configure the app on your VTEX store.\n\nIn the **Affiliates Program** app, an affiliate is someone who partners with your VTEX store to promote sales in exchange for a commission. The term is, therefore, different from the [usual concept of an affiliate at VTEX](/en/docs/tutorials/what-is-an-affiliate). \n\nThe **Affiliates Program** app generates a specific URL from your VTEX store to your [registered affiliates](#adding-an-affiliate). When the affiliate shares the URL with a customer who buys using the link, the affiliate gets a commission. \n\nThe app creates two page groups after being installed in your VTEX environment:\n\n- [Affiliate pages](#affiliate-pages)\n- [VTEX Admin pages](#vtex-admin-pages)\n\n### Affiliate Pages\n\nThe app creates three types of affiliate pages, available to them without any access to your store's VTEX Admin, as shown in the table below:\n\n| **Type** | **URL** |\n| ---------- | ---------- |\n| Affiliate page | `{storeName.com}/affiliates/{affiliateSlug}` |\n| Affiliate profile page | `{storeName.com}/affiliates/{affiliateSlug}/profile` |\n| Registration form page | `{storeName.com}/affiliate/form` |\n\nThe **affiliate page** is the VTEX store URL that they will share with the customers. The following image shows an example:\n\n\n\nThe **affiliate profile page** is an interface where the affiliate can track and manage their orders and commissions. The image below shows an example:\n\n\n\nThe **registration page** allows those who are interested in becoming affiliates to fill in their information to apply for VTEX store registration. \n\n> ℹ️ The affiliate pages are customizable. Learn more in the [Affiliates Program app](https://developers.vtex.com/vtex-developer-docs/docs/affiliates-program-app) developer's guide.\n\n### VTEX Admin pages\n\nThe **Affiliates Program app** creates interfaces in the VTEX Admin for you to manage all affiliate-related content. \n\nAfter [installing](https://developers.vtex.com/vtex-developer-docs/docs/affiliates-program-app#installation) the app, the following pages become available in your VTEX Admin under **Other > Affiliates**: \n\n- [Affiliate Management](#affiliate-management)\n- [Order Management](#order-management)\n- [Commission Management](#commission-management)\n\nIf your store uses the [New VTEX Admin](https://content.vtex.com/join-new-admin-beta-program-en/), go to **Apps > Affiliates**. \n\n## Affiliate Management\n\nThe **Affiliate Management** page allows you to do the following:\n\n- [Add an affiliate](#adding-an-affiliate)\n- [Search for affiliates](#searching-for-affiliates)\n- [Filter affiliates](#filtering-affiliates)\n- [View affiliate details](#viewing-affiliate-details)\n- [Edit an affiliate](#editing-an-affiliate)\n\n\n\n### Adding an affiliate\n\nClick the `Add Affiliate` button to create a new affiliate, fill in the fields displayed, and click `Save`.\n\n> The following fields are required: _Name, Email, URL identifier_, and _Phone_.\n\n### Searching for affiliates\n\nEnter any of the following information in the search bar to search for an affiliate: _Affiliate ID, Name, Store Name, Email_, or _Phone_.\n\n> ⚠️ In the **Affiliates Program app**, not only is the term affiliate different from the [usual VTEX affiliate concept](/en/docs/tutorials/what-is-an-affiliate), but the `Affiliate ID` does not correspond to the default code. In the app, the `Affiliate ID` is an alphanumeric code automatically generated when you create a new affiliate.\n\n### Filtering affiliates\n\nTo filter the affiliate search, click `All` and select the desired option. The default `All` option searches all of your affiliates, and the other options are approval-related: `Yes` for approved affiliates and `No` for non-approved ones.\n\n### Viewing affiliate details\n\nTo view affiliate details, on the affiliate row, click **More actions**, and then click **Details**. You will be redirected to a page where you can view information about the affiliate and also do the following: \n\n- **Activate affiliate:** Click the toggle under `Active?` .\n- **Access the [Order Management page](#order-management) of the affiliates:** Click the `Order Management` button.\n- **Edit affiliate:** Click the `Edit` button.\n\n### Editing an affiliate\n\nIf you need to edit an affiliate and change its information, follow the steps below:\n\n1. In the row related to the affiliate, click **More actions**.\n2. Click **Edit**. \n3. Change the information added.\n4. Click `Save`.\n\n## Order Management\n\nThe **Order Management** page allows you to do the following:\n\n- [Monitor data](#monitoring-data)\n- [Search for orders](#searching-for-orders)\n- [Filter orders](#filtering-orders)\n- [Export order spreadsheet](#exporting-the-order-list)\n- [View order details](#viewing-order-details)\n\n\n\n### Monitoring data\n\nAt the top of the page, you see the following metrics about orders placed through the links of one or more affiliates:\n\n- **Total Orders:** Total number of affiliate orders.\n- **Order Total:** Sum of the order values, calculated from the item prices without shipping costs.\n- **Order Total Commission:** Sum of the amounts of affiliate commissions on orders.\n\n> ℹ️ To track an order flow, click the `Order ID`. This will redirect you to the VTEX Admin under **Orders > All Orders**.\n\n### Searching for orders\n\nType the `affiliate ID` related to the order into the search bar to find an order. You can do this by using filters, as seen [below](#filtering-orders).\n\n### Filtering orders\n\nYou can filter the order search by the following criteria:\n\n- **Order status:** The default option is to show all orders. To choose a status, click **All Orders** and select one of the options: _Created, Payment approved, Payment Pending, Invoiced_, or _Canceled_. Learn more in [Order Flow and Status](/en/docs/tutorials/order-flow-and-status).\n- **Order Date:** Filter from a range of days and hours when the orders were created. To do so, the `From` field sets a start date and the `To` field sets the end date.\n\n### Exporting the order list\n\nThe **Affiliates Program app** allows you to export a list with a CSV extension of your affiliate orders. \n\n> ⚠️ To enable the list export function, you must first set up email templates described in the [Affiliates Program app](https://developers.vtex.com/vtex-developer-docs/docs/affiliates-program-app#email-templates) developer's guide.\n\nAfter configuration, click **Export** on the **Order Management** page to export the list. The following confirmation message will be displayed:\n\n > _The report is being generated and will be_ _sent to your email._\n\nThe generated file will be sent to the email address of the [user](/en/docs/tutorials/managing-admin-users) who is currently logged in. The exported content refers to the total of orders in the list at the time of export. If a filter is active, only the selected offers will be exported. \n\n### Viewing order details\n\nTo see an order data, in the row for the order click **More Actions**, and then click **Details**. \n\n## Commission Management\n\nThe **Commission Management** page allows you to do the following:\n\n- [Search for commissions](#searching-for-commissions)\n- [Edit commissions](#editing-commissions)\n- [Export commission spreadsheet](#exporting-commission-spreadsheet)\n- [Import commissions](#importing-commissions)\n- [Download last import](#downloading-the-last-import)\n\n\n\n### Searching for commissions\n\nTo search for order commissions, in the search bar of the Commissions tab, type the `SKU ID` of the order, which is the [SKU identification number](/en/docs/tutorials/finding-a-sku-id). \n\n### Editing commissions\n\nYou can change the commission percentage by following the steps below:\n\n1. On the Commissions tab, in the row for the commission you want to edit, click **More actions**.\n2. Click **Edit**. \n3. In the modal that opened, enter the desired commission number. Decimals are not accepted.\n4. Click `Confirm`.\n\nThe following message will be displayed:\n\n> _Commission updated successfully_\n\n### Exporting commission spreadsheet\n\nTo export a SKU commission spreadsheet with a CSV extension, at the top of the **Commission Management** page, click **Export**. The following confirmation message should be displayed:\n\n> _The report is being generated and will be sent to your email._\n\nThe file will be sent to the email address of the [user](/en/docs/tutorials/managing-admin-users) who is currently logged in.\n\n> ℹ️ The exported content refers to the list SKU commissions at the time of export. Only the selected SKU commissions will be exported if a filter is active.\n\n### Importing commissions\n\nYou can update commissions in bulk by SKU by following the steps below. You can use a sample template by clicking `XLSX Template`.\n\n1. Go to the **Import Commissions** tab.\n2. Drag and drop the CSV or XLSX file format into the dotted area, or click `Choose a file`.\n3. Click `Send File`.\n\nCheck if the following message is displayed:\n\n> _The file is being processed_\n\nThe name of the submitted fileadded file name will appear next to the `Last Import` field.\n\n> ℹ️ You can identify the import information and the user by hovering over the `?` symbol next to `Last Import`.\n\n### Downloading the last import\n\nThe last imported file isavailable for download. To download it, go to the **Import Commissions** tab, find the file next to `Last Import` and click it."}