Skip to main content
Elimapi

Product API Reference (v2)

Summary

This page lists the complete endpoints, parameters, and response structure of the Product API v2 (current version, recommended for new integrations): keyword search, image search, product details, image upload, and shipping fee calculation on Taobao and 1688.

If you are using the v1 version, see Product API v1 (Legacy). For a step-by-step walkthrough, see Searching for products.

All endpoints are POST, require an authentication header (JWT or API Key), and require the platform parameter with the value taobao or alibaba.

EndpointDescriptionPlatform
POST /v2/products/searchSearch products by keyword✅ Taobao ✅ 1688
POST /v2/products/search-by-imageSearch products by image✅ Taobao ✅ 1688
POST /v2/products/findGet product details✅ Taobao ✅ 1688
POST /v2/products/detailGet full product details✅ Taobao ✅ 1688
POST /v2/products/upload-imageUpload an image to Alibaba’s server✅ Taobao ✅ 1688
POST /v2/products/shipping-feeCalculate shipping fee✅ Taobao ❌ 1688

Search products by keyword

POST /v2/products/search

Example request:

{
  "platform": "taobao",
  "q": "áo thun cotton",
  "lang": "vi",
  "sort": "SALE_QTY_DESC",
  "page": 1,
  "size": 20,
  "filter": {
    "priceRange": { "min": 0, "max": 100 }
  }
}

Parameters

ParameterTypeRequiredDescription
platformstringPlatform: taobao or alibaba
qstringSearch keyword
langstringTitle translation language: vi, en, ru, ko, ja. Translated data is in the title_en key; the title key remains the original Chinese
sortstringSort order (see table below)
filterobjectResult filter (see table below)
pagenumberPage number, starting from 1
sizenumberResults per page: 20 to 40
keywordTranslatebooleanTranslate the search keyword to the language matching lang

Sort results (sort)

ValueDescriptionPlatform
PRICE_ASCPrice ascending✅ Taobao ✅ 1688
PRICE_DESCPrice descending✅ Taobao ✅ 1688
SALE_QTY_ASCSales quantity ascending✅ Taobao ✅ 1688
SALE_QTY_DESCSales quantity descending✅ Taobao ✅ 1688
RETENTION_ASCRepurchase rate ascending❌ Taobao ✅ 1688
RETENTION_DESCRepurchase rate descending❌ Taobao ✅ 1688

Filter results (filter)

ParameterDescriptionPlatform
filter.priceRangePrice range in CNY: { "min": 0, "max": 100 }✅ Taobao ✅ 1688
filter.shopIdProducts from the same seller. Taobao uses a numeric shop id; 1688 uses an alphanumeric shopId✅ Taobao ✅ 1688
filter.sellerLevelSeller level: L1L4 (see table below)❌ Taobao ✅ 1688
filter.isFactoryOnly get products from super factories❌ Taobao ✅ 1688
filter.ffmOutboundFast outbound criteria: FFMO1FFMO6 (see table below)❌ Taobao ✅ 1688
filter.ffmDeliveryFast delivery criteria: FFMD0FFMD2 (see table below)❌ Taobao ✅ 1688
filter.allowReturnAllow 7-day no-reason return❌ Taobao ✅ 1688
filter.allowDropshipAllow dropship❌ Taobao ✅ 1688
filter.freeshipForDropshipAllow dropship + freeship❌ Taobao ✅ 1688
filter.newArrivalNewly updated products: 7DAY, 30DAY❌ Taobao ✅ 1688
filter.platformPickPlatform-selected sources for the domestic market❌ Taobao ✅ 1688
filter.globalPickPlatform-selected sources for the international market❌ Taobao ✅ 1688
filter.dropshipPickPlatform-selected sources for dropship❌ Taobao ✅ 1688
filter.categoryIdFilter by category ID❌ Taobao ✅ 1688
filter.categoryIdListFilter by a list of category IDs❌ Taobao ✅ 1688
filter.sellerOpenIdSearch within a single store (when set, q is the in-store keyword)❌ Taobao ✅ 1688

ffmOutbound values

ValueDescription
FFMO1Shipment rate within 24h < 95%
FFMO2Shipment rate within 24h >= 95%
FFMO3Shipment rate within 24h > 99%
FFMO4Shipment rate within 48h < 95%
FFMO5Shipment rate within 48h >= 95%
FFMO6Shipment rate within 48h > 99%

ffmDelivery values

ValueDescription
FFMD0Same day delivery
FFMD1Delivery within 24h
FFMD2Delivery within 48h

newArrival values

ValueDescription
7DAYNewly updated products in the last 7 days
30DAYNewly updated products in the last 30 days

sellerLevel values

ValueDescription
L1Total rating 5 stars
L2Total rating 4.5 – 5 stars
L3Total rating 4 – 4.5 stars
L4Total rating below 4 stars

Search products by image

Note: This feature does not apply to the Free plan.

POST /v2/products/search-by-image

There are 2 ways to search by image; you must pass exactly one of the following parameters:

1. Search by image URL — use the imgUrl parameter

Only image links from Alibaba can be used: *.alicdn.com.

{
  "platform": "taobao",
  "imgUrl": "https://img.alicdn.com/bao/uploaded/i3/694223667/O1CN01zSjKgp1cxXRQZsDLA_!!694223667.jpg",
  "lang": "vi",
  "page": 1,
  "size": 20
}

2. Search by uploaded image — use the imgId parameter

First upload the image via the Upload image API to get an imageId, then pass it to imgId:

{
  "platform": "alibaba",
  "imgId": "image-123",
  "lang": "vi",
  "page": 1,
  "size": 20
}

Parameters

ParameterTypeRequiredDescription
platformstringPlatform: taobao or alibaba
imgUrlstring❌*Alibaba image URL (*.alicdn.com)
imgIdstring❌*ID of an image uploaded via POST /v2/products/upload-image
langstringTitle translation language: vi, en, ru, ko, ja
sortstringSort order (same values as keyword search)
filterobjectFilter: supports filter.priceRange and filter.categoryId
pagenumberPage number, starting from 1
sizenumberResults per page: 1 to 20
keywordstringAdditional keyword when searching by image
keywordTranslatebooleanTranslate the search keyword

* At least one of imgUrl or imgId is required.

Get detailed product information

POST /v2/products/find
POST /v2/products/detail

Both endpoints share the same request structure and return detailed product information. detail returns fuller details and is suitable when you need 1688 data.

{
  "platform": "taobao",
  "id": "734467086498",
  "lang": "vi"
}

Parameters

ParameterTypeRequiredDescription
platformstringPlatform: taobao or alibaba
idstringProduct identifier: Taobao mi_id or item_url; 1688 offerId
langstringTitle translation language: vi, en, ru, ko, ja

If you encounter short links like https://e.tb.cn/h.hPY04k4RPfAco8F?tk=0CCI430IUqd, you must first process the link to get the original link — use the Unshorten link API to get the original link and product ID.

Product price types

Price AttributeDescriptionPlatform
priceRegular price. For 1688, wholesale price without freeship, quantity depends on seller settings✅ Taobao ✅ 1688
promotion_pricePromotion price, lower than or equal to the regular price✅ Taobao ✅ 1688
retail_priceRetail price + freeship from 1 product, for dropshipping. Usually appears in selected 1688 products❌ Taobao ✅ 1688
dropship_priceRetail price for 1 item, usually equal to the regular price. Depends on whether the seller has dropship active❌ Taobao ✅ 1688

Warning: If you display prices to customers on an extension/web/app, add a warning that prices may be higher than those viewed directly on Taobao/1688. If you find API prices are higher, contact customer service for help adjusting prices when creating purchase orders.

Taobao: prioritize displaying and applying the promotion price; if none exists, use the regular price.

1688: price application logic depends on the quote_type field:

ValueDescription
directGet wholesale price by price and promotion_price
by_skuGet price by SKU
by_volumeGet price by price_range, depends on the minimum order quantity moq

Seller levels on 1688

Seller level is used to determine credibility on 1688, determined through the seller_type field:

ValueDescription
sellerRegular seller
merchantProfessional seller, verified by 1688
factoryManufacturing factory, verified by 1688 and meeting 1688 direct evaluation standards

Field values in extra_info

ValueDescription
isOnePsaleDoes it support dropshipping?
isSupportMixDoes it allow buying multiple products in one order?
isOnePsaleFreePostageDoes it support dropshipping + freeship?
noReason7DReturnDoes it allow no-reason return within 7 days?
1688_yxIs it a selected source?

Calculate shipping fee

Taobao only.

POST /v2/products/shipping-fee
{
  "platform": "taobao",
  "id": "734467086498",
  "addressInfo": {
    "country": "VN",
    "state": "Hanoi",
    "city": "Hanoi",
    "district": "Hoan Kiem"
  }
}

Parameters

ParameterTypeRequiredDescription
platformstringFixed to taobao
idstringProduct identifier: mi_id or item_url
addressInfo.countrystringReceiving country
addressInfo.statestringProvince/state
addressInfo.citystringCity
addressInfo.districtstringDistrict

The response contains post_fee (shipping fee in CNY), currency, item_id, mi_id, and item_resource.

Upload image

Used to get an imageId for image search (the imgId parameter).

POST /v2/products/upload-image

The request uses multipart/form-data:

FieldTypeRequiredDescription
filefileThe image file to upload
platformstringPlatform: taobao or alibaba

Response: { "imageId": "image-123" }.

Response structure

Response field names use snake_case. Each platform returns its own product structure:

  • find / detail → a product object (Product)
  • search / search-by-image{ "paginate": { "total", "current", "size" }, "items": [...] } (the paginate key may be absent when there is no pagination metadata)

Core fields (present on both platforms)

FieldDescription
idProduct ID
titleOriginal title (Chinese)
title_enTranslated title (when called with lang)
descriptionProduct description
quote_typeQuote type: direct / by_sku / by_volume
priceRegular price
promotion_pricePromotion price
quantityStock quantity
unitUnit of measure
shop_idSeller ID
shop_nameStore name
moqMinimum order quantity
category_idCategory ID
category_nameCategory name
category_pathCategory path
img_urlsProduct image list
seller_typeSeller type: seller / merchant / factory
statusProduct status
skusVariant list (color, size)
attributesProduct attributes

1688-only fields

In addition to the core fields, a 1688 response adds the following fields (grouped by topic):

  • Pricing: price_range, channel_price, promotion_model, fenxiao_sale_info, is_jxhy
  • Media: video_urls, white_image, translated_img_urls, translated_white_image
  • Translation: description_en, unit_en
  • Sales/reviews: sold, review, level
  • Shipping: shipping_info
  • Category: top_category_id, second_category_id, third_category_id
  • Identifiers & links: mp_id, item_type, batch_number, product_cargo_number, original_product_url, seller_shop_url, promotion_url
  • Metadata: selling_point, offer_identities, create_date, is_select, certificate_list, seller_mix_setting
  • Other: extra_info, sku_price_ranges

Note: A field entirely absent from the response means the field does not belong to the platform you are calling. A field with a null value means there is no data for that field in this request.

For the complete field list and detailed descriptions: Swagger API.

FAQ

Why is the product price from the API different from the price shown on the Taobao/1688 website?

  1. The API we are using is part of Alibaba’s cross-border logistics system, and its pricing is determined independently — separate from the prices shown on the website.
  2. Unlike the API, the website can distinguish between new and returning visitors, which allows it to apply targeted promotions or vouchers based on user type — a capability the API does not support.

Is there a test environment?

No. The default account already includes 200 free requests for trial integration.

Is the data real-time?

Yes, the data is retrieved directly from Taobao and 1688.

Yes, we support searching by image URL and uploaded image.