> For the complete documentation index, see [llms.txt](https://knowledgebase.offer18.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://knowledgebase.offer18.com/network/integration/offer-sync/offer-sync-guide.md).

# Offer Sync Guide

The General Purpose of Using the API feature is to Import / Synchronize the Offers quickly from Advertiser's Platforms, respectively.

#### **1.** Integration **»** **Offers Sync**

![](https://2731110321-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-ME6HkHUCzlM0Mu33Q9W%2F-MMnbCRAAJrecIJk_pQ7%2F-MMnezTruHuq_1A8-sjb%2F5f2957652ff7bc16ab40b0114ad2bc96.gif?alt=media\&token=e63749c4-dd17-4a66-a535-2da016dc5d7f)

**2. Select Network / Partner Platform »** **Setup** 

***

### **Go to Credentials**

**Credentials -** These will be API details given by the Advertiser which will include API domain, Key as main credentials. Usually, these always change as per Platforms

<figure><img src="/files/ddNqTDT3Dmz4ylyQY2G8" alt=""><figcaption></figcaption></figure>

1. Specify API name
2. Enter API Credentials
3. Go to Next&#x20;

***

### **Go to Settings**

The options row includes various configuration settings that the user wants to make in imported Offers

<figure><img src="/files/yskUY0YhZpf51xbbgsuh" alt=""><figcaption></figcaption></figure>

<table data-header-hidden><thead><tr><th width="150"></th><th></th></tr></thead><tbody><tr><td><strong>Fields</strong></td><td><strong>Description</strong></td></tr><tr><td>Schedule</td><td>This is the Schedule defines how much time API should be updated automatically</td></tr><tr><td>Affiliate Payout %</td><td>This helps in specifying the % of Payout user wants to share with your Affiliate</td></tr><tr><td>Stop Offer</td><td>Users can configure what settings should be applied to the Offers which are not got synced in the next scheduled sync of the API</td></tr><tr><td>Advertiser</td><td>This would be the profile of that Advertiser user created under which all of the synced Offers will get saved</td></tr><tr><td>Offer Visibility</td><td>The user can select by default Visibility status for synced Offers for Affiliates. <br>(Public, Public + Approval Required, Private)</td></tr><tr><td>Fallback</td><td>Global Fallback and custom Fallback can apply to synced Offers </td></tr><tr><td>Offer Category</td><td>Category can be selected for the synced Offers </td></tr><tr><td>Offer Description</td><td>Description added here will be prepended in synced Offer's Description</td></tr><tr><td>Offer KPI</td><td>Offer KPI added here will be prepended in synced Offer's Description</td></tr><tr><td>Remove Tracking URL Tokens</td><td>Using this option one can remove unnecessary tokens in Offer URL</td></tr><tr><td>Append Tracking URL Tokens</td><td>Using this option one can Append necessary tokens in Offer URL</td></tr><tr><td>Assign Affiliates</td><td>One can Assign Affiliates to Synced Offers</td></tr><tr><td>Over Capping Action</td><td>Over Capping Actions can be added to synced Offers</td></tr></tbody></table>

***

### **Go to Filters**

Using filter options, one can filter the sync results to get particular / desired data from the Advertisers&#x20;

<figure><img src="/files/qxG3cA1RhHhxPvRXUY32" alt=""><figcaption></figcaption></figure>

Filers in Offer Sync are

<table data-header-hidden><thead><tr><th width="150"></th><th></th></tr></thead><tbody><tr><td><strong>Filter</strong> </td><td><strong>Description</strong></td></tr><tr><td>Offer Sync Limit</td><td>One can limit the count of Offers to be synced from API </td></tr><tr><td>Model </td><td>Offers with specific Models can be filtered using this </td></tr><tr><td>Price Range</td><td>One can set a lower and upper limit for price in Offers to be synced from API </td></tr><tr><td>Offer Status</td><td>Offers with specific status can be filtered using this<br>approved/expired</td></tr><tr><td>OS </td><td>Offers for specific Operating systems can be filtered using this </td></tr><tr><td>Country </td><td>Offers for specific Countries can be filtered using this </td></tr><tr><td>Currency</td><td>Offers for specific Currency can be filtered using this </td></tr><tr><td>Events / Goals</td><td>Offers containing specific events can be filtered using this</td></tr><tr><td>Advertiser Offers</td><td>One can specify the Advertiser ID whose Offer must  sync or must not be synced</td></tr></tbody></table>

**Fields**

These are the fields that can be configured by the user to sync either always or one time or never.

<figure><img src="/files/HmdB8zSPx4BoiyBQUHmA" alt=""><figcaption></figcaption></figure>

***

### Test API

Using this one can check the raw response of API.