Shopify Products API

Endpoint text

POST /api/vi/shopify-items

Authentication
Include your API Key in the request header: text

X-VIP-TOKEN: your_api_key_here

Request Parameters

Parameter	Type	Required	Description
search_key	string	No	Search keyword or Shopify product/store URL
sort_by	int	No	Sort field: 14=weekly sales desc (default), 1=published time desc, 2=published time asc, 3=price desc, 4=price asc, 7=weekly sales desc, 9=ad count desc, 10=ad count asc, 11=competition desc, 12=competition asc, 13=created at desc, 15=weekly sales asc, 16=weekly revenue desc, 17=weekly revenue asc, 18=weekly revenue growth desc, 19=weekly revenue growth asc, 20=relevance asc, 21=relevance desc
page_num	int	No	Page number, starting from 1
page_size	int	No	Items per page, max 100
price_min	float	No	Minimum price (USD)
price_max	float	No	Maximum price (USD)
sales_weekly_min	int	No	Minimum weekly sales
sales_weekly_max	int	No	Maximum weekly sales
published_time_begin	string	No	Listing start date (YYYY-MM-DD)
published_time_end	string	No	Listing end date (YYYY-MM-DD)
facebook_ad	int	No	Has Facebook ads: 1=yes
competition_min	int	No	Minimum competition (number of stores)
competition_max	int	No	Maximum competition
has_supplier	int	No	Has supplier: 1=yes, 0=no
show_deleted	int	No	Show delisted products: 1=yes, 0=no
country	string	No	Shipping country code (e.g., US, CN)
lang	string	No	Language: en/cn, default en

Request Example python

import requests
import json

url = "https://api.ehunt.ai/api/vi/shopify-items"
headers = {
    "Content-Type": "application/json",
    "X-VIP-TOKEN": "your_api_key_here"
}
payload = {
    "search_key": "dress",
    "price_min": 10,
    "price_max": 50,
    "sales_weekly_min": 10,
    "sort_by": 7,
    "page_num": 1,
    "page_size": 20
}
response = requests.post(url, headers=headers, json=payload)
print(json.dumps(response.json(), indent=2))

Response Example json

{
  "code": 200,
  "message": "OK",
  "data": {
    "product_num": 100,
    "page_size": 20,
    "final_count": 20,
    "list": [
      {
        "product_id": "12345",
        "title": "Vintage Cotton Dress",
        "product_link": "https://example.myshopify.com/products/vintage-dress",
        "preview_image_url": "https://cdn.shopify.com/.../image.jpg",
        "country": "US",
        "min_price": 29.99,
        "max_price": 49.99,
        "store_id": "store_123",
        "shop_id": "shop_123",
        "store_link": "example.myshopify.com",
        "store_rank": "A",
        "competitor_count": 15,
        "facebook_ad_count": 3,
        "week_order_count": "1,234",
        "week_revenue_count": "12,345",
        "week_revenue_growth": 15.5,
        "shelf_time": "2024-01-15",
        "is_deleted": 0,
        "is_favourite": 0
      }
    ]
  },
  "used_today": 150,
  "remaining_today": 350
}

Response Fields

Field	Type	Description
product_id	string	Product ID
title	string	Product title
product_link	string	Product URL
preview_image_url	string	Main image URL
country	string	Shipping country
min_price	float	Minimum price (USD)
max_price	float	Maximum price (USD)
store_id	string	Store ID
shop_id	string	Shop ID
store_link	string	Store URL
store_rank	string	Store rank
competitor_count	int	Competition (number of stores)
facebook_ad_count	int	Number of Facebook ads
week_order_count	string	Weekly sales (formatted)
week_revenue_count	string	Weekly revenue (formatted)
week_revenue_growth	float	Weekly revenue growth (%)
shelf_time	string	Listing date
is_deleted	int	Delisted status (0=active, 1=delisted)
is_favourite	int	Favorited flag

Common Response Codes

Code	Description
200	Success
401	Authentication failed (invalid/expired API Key)
402	Insufficient credits or subscription expired
403	Access denied
429	Rate limit exceeded
500	Internal server error

Credit Usage

Each returned product/store consumes 1 credit.
Daily credit limit (shared across all VIP endpoints).
Response includes used_today and remaining_today to monitor usage.\

​Common Response Codes

​Credit Usage

Common Response Codes

Credit Usage