> ## Documentation Index
> Fetch the complete documentation index at: https://docs.api.ehunt.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Shopify Products API

**Endpoint**

text

```text theme={null}
POST /api/vi/shopify-items
```

**Authentication**\
Include your API Key in the request header:

text

```text theme={null}
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

```python theme={null}
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

```json theme={null}
{
  "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.\\