forked from ringcentral/slate
-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
48 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -421,12 +421,18 @@ | |
<li> | ||
<a href="#proxies" class="toc-h1 toc-link" data-title="Proxies">Proxies</a> | ||
<ul class="toc-list-h2"> | ||
<li> | ||
<a href="#where-do-i-get-a-proxy" class="toc-h2 toc-link" data-title="Where do I get a proxy?">Where do I get a proxy?</a> | ||
</li> | ||
<li> | ||
<a href="#configure-zincapi-for-your-own-proxy-byop" class="toc-h2 toc-link" data-title="Configure ZincAPI for your own proxy (BYOP)">Configure ZincAPI for your own proxy (BYOP)</a> | ||
</li> | ||
<li> | ||
<a href="#query-zincapi-for-current-byop-details" class="toc-h2 toc-link" data-title="Query ZincAPI for current BYOP details">Query ZincAPI for current BYOP details</a> | ||
</li> | ||
<li> | ||
<a href="#disable-byop" class="toc-h2 toc-link" data-title="Disable BYOP">Disable BYOP</a> | ||
</li> | ||
</ul> | ||
</li> | ||
<li> | ||
|
@@ -526,6 +532,9 @@ | |
</li> | ||
</ul> | ||
</li> | ||
<li> | ||
<a href="#blank-offers-page" class="toc-h1 toc-link" data-title="Blank Offers Page">Blank Offers Page</a> | ||
</li> | ||
</ul> | ||
<ul class="toc-footer"> | ||
<li><a href='http://dash.zinc.io/signup'>Sign Up for a Zinc account</a></li> | ||
|
@@ -629,26 +638,26 @@ <h1 id='supported-retailers'>Supported retailers</h1> | |
<tr> | ||
<td>Costco</td> | ||
<td>costco</td> | ||
<td>Y</td> | ||
<td>Y*</td> | ||
<td>Y</td> | ||
<td>Y</td> | ||
<td>N</td> | ||
</tr> | ||
<tr> | ||
<td>Walmart</td> | ||
<td>walmart</td> | ||
<td>Y*</td> | ||
<td>Y</td> | ||
<td>Y</td> | ||
<td>Y</td> | ||
<td>N</td> | ||
</tr> | ||
<tr> | ||
<td>Homedepot</td> | ||
<td>HomeDepot</td> | ||
<td>homedepot</td> | ||
<td>Y*</td> | ||
<td>N</td> | ||
<td>N</td> | ||
<td>Y</td> | ||
<td>Y</td> | ||
<td>N</td> | ||
</tr> | ||
<tr> | ||
<td>Lowes</td> | ||
|
@@ -661,7 +670,7 @@ <h1 id='supported-retailers'>Supported retailers</h1> | |
<tr> | ||
<td>AliExpress</td> | ||
<td>aliexpress</td> | ||
<td>Y</td> | ||
<td>Y*</td> | ||
<td>Y</td> | ||
<td>Y</td> | ||
<td>N</td> | ||
|
@@ -2464,6 +2473,12 @@ <h3 id='updating-a-case'>Updating a Case</h3> | |
<span class="nt">-d</span> <span class="s1">'{"message": "I have an update on this case"}'</span> | ||
</code></pre></div><h1 id='proxies'>Proxies</h1> | ||
<p>The Zinc API interfaces with the retailers via proxies. This enables each retailer interaction session to use unique and consistent IP addressing. Due to many factors, sometimes the bulk proxies available to us become blocked by retailers. The best path to keeping your own account from being blocked is to provide your own proxy service, by either hosting your own proxy or purchasing a proxy from a provider. We call this "bring-your-own-proxy" (BYOP).</p> | ||
<h2 id='where-do-i-get-a-proxy'>Where do I get a proxy?</h2> | ||
<p>We cannot recommend any specific proxy provider. Many commerical providers are | ||
unsuitable because their IPs are low quality and shared among many users. It is | ||
best to use a real residential IP address dedicated to your ordering flow.</p> | ||
|
||
<p>One option is to deploy the Zinc proxy container, on Github at <a href="https://github.com/zincio/zn-proxy">zinc/zn-proxy</a>.</p> | ||
<h2 id='configure-zincapi-for-your-own-proxy-byop'>Configure ZincAPI for your own proxy (BYOP)</h2> | ||
<p>To configure a BYOP, you must provide the retailer, email account, and full proxy connection URL.</p> | ||
|
||
|
@@ -2534,7 +2549,9 @@ <h2 id='configure-zincapi-for-your-own-proxy-byop'>Configure ZincAPI for your ow | |
<span class="nt">-X</span> GET <span class="se">\</span> | ||
<span class="nt">-u</span> <client_token>: <span class="se">\</span> | ||
<span class="nt">-d</span> <span class="s1">'{"retailer":"amazon","email":"[email protected]"}'</span> | ||
</code></pre></div><h1 id='object-reference'>Object reference</h1><h2 id='product-object'>Product object</h2> | ||
</code></pre></div><h2 id='disable-byop'>Disable BYOP</h2> | ||
<p>Use the DELETE method instead of PUT.</p> | ||
<h1 id='object-reference'>Object reference</h1><h2 id='product-object'>Product object</h2> | ||
<blockquote> | ||
<p>Example product object</p> | ||
</blockquote> | ||
|
@@ -3634,6 +3651,30 @@ <h3 id='do-you-have-any-sample-code-for-using-the-api'>Do you have any sample co | |
<ul> | ||
<li>Sample code that includes an example of a bulk order query can be found in this github <a href="https://github.com/zincio/api-samples">repo</a>.</li> | ||
</ul> | ||
<h1 id='blank-offers-page'>Blank Offers Page</h1> | ||
<p>Recently, Amazon has begun to return an empty page instead of a list of product offers. | ||
This appears to be an anti-bot response by Amazon, caused by the IP addresses used to place orders.</p> | ||
|
||
<p>This appears to primarily affect the UK, DE, and IN regions. US, CA, and FR currently appear unaffected.</p> | ||
|
||
<p>When this happens, our ordering agent will respond with the error <code>amazon_antibot_blank_offers_page</code>.</p> | ||
|
||
<p>This is done because we cannot guarantee full ordering safeguards without accessing this offers page.</p> | ||
|
||
<p>There are two workarounds that can be attempted:</p> | ||
|
||
<ol> | ||
<li><p>Set <code>take_buybox_offers</code> to true on the top level of the ordering object. | ||
This will automatically accept the first offer on the Amazon product page, | ||
without applying any <code>seller_selection_criteria</code>. For safety, it is | ||
suggested to set <code>max_price</code> and <code>max_delivery_days</code> as well. Because this | ||
accepts the default offer, it will not require loading the broken page.</p></li> | ||
<li><p>Bring your own proxy with BYOP. Ideally, you should use a real | ||
residential IP that is dedicated to your ordering flow. For more details, | ||
review the <a href="/#proxies">BYOP docs</a>.</p></li> | ||
</ol> | ||
|
||
<p>We will continue to monitor the situation and update this page as new details emerge.</p> | ||
|
||
</div> | ||
<div class="dark-box"> | ||
|