Elimapi Docs

Product API Guide

The following is the guide to the product API

Search products by keyword

View details: Search products

Language translation

Use the lang parameter to translate the language of search results. The value of lang is described in the table below:

ValueDescriptionPlatform
viVietnameseβœ… Taobao βœ… 1688
enEnglishβœ… Taobao βœ… 1688

Translated data is in the titleEn key. The title key remains Chinese data.

Sort search results

Use the sort parameter to sort search results. The value of sort is described in the table below:

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 search results

Use the filter parameter to sort search results. The value of filter is described in the table below:

Filter CriteriaDescriptionPlatform
price_rangePrice range (unit: CNY)βœ… Taobao βœ… 1688
shop_idProducts from same sellerβœ… Taobao βœ… 1688
seller_levelSeller level❌ Taobao βœ… 1688
is_factoryOnly get products from super factories❌ Taobao βœ… 1688
ffm_outboundFast outbound criteria❌ Taobao βœ… 1688
ffm_deliveryFast delivery criteria❌ Taobao βœ… 1688
allow_return7-day no-reason return❌ Taobao βœ… 1688
allow_dropshipAllow dropship❌ Taobao βœ… 1688
freeship_for_dropshipAllow dropship + freeship❌ Taobao βœ… 1688
new_arrivalNewly updated products on platform❌ Taobao βœ… 1688
platform_pickPlatform-selected sources for domestic market❌ Taobao βœ… 1688
global_pickPlatform-selected sources for international market❌ Taobao βœ… 1688
dropship_pickPlatform-selected sources for dropship❌ Taobao βœ… 1688

Fast outbound criteria ffm_outbound

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%

Fast delivery criteria ffm_delivery

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

Fast delivery criteria new_arrival

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

Seller level criteria seller_level

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.

View details: Search products

There are 2 ways to search products by image:

1. Search by image URL

Applicable scope: βœ… Taobao βœ… 1688

Use the img_url key in the parameter to query. However, only image links from Alibaba can be used: *.alicdn.com

2. Search by uploaded image

Applicable scope: βœ… Taobao βœ… 1688

To use this function, first upload the image to Alibaba server using the API Upload image. Then use the img_id key instead of img_url in the query parameter to make the request.

Get detailed product information

View details: Product details

If you frequently encounter short links like https://e.tb.cn/h.hPY04k4RPfAco8F?tk=0CCI430IUqd, you must first process this link to get the original link.

Use the API Unshorten link to get the original link and product ID.

Explanation of product price types

Price AttributeDescriptionPlatform
priceRegular price. For 1688, it’s wholesale price without freeship, quantity depends on seller settings.βœ… Taobao βœ… 1688
promotion_pricePromotion price, lower than or equal to 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 regular price. Difference depends on whether seller has active dropship.❌ Taobao βœ… 1688

Price display and application logic

Some products may have multiple price types. Price display and application logic depends on the platform. Additionally, prices via API may be higher than prices viewed directly on taobao/1688 websites. This is because website price mechanisms may have applied promotions, discounts, or other promotional programs. API prices cannot apply these complex promotional programs.

If you display prices to customers on extension/web/app, please note to add a warning to let customers know that prices may be higher than prices viewed directly on taobao/1688. If you find API prices are higher, please contact your customer service for assistance in adjusting prices when creating purchase orders.

For taobao, priority is given to displaying and applying promotion prices. If no promotion price exists, use regular price.

For 1688, price application logic depends on the value of the quote_type field:

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

Seller levels on 1688

The level is also used to determine seller credibility on 1688, determined through the seller_type field. There are 3 levels:

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

Explanation of 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?