Table of Contents
No. |
Method |
Description |
1.1 |
listPromotionProduct |
promotion products |
1.2 |
getPromotionProductDetail |
promotion product detail |
1.3 |
getPromotionLinks |
generate ad links for promotion products |
1.4 |
listPromotionCreative |
list promotion banner |
1.5 |
getCompletedOrders |
get order detail when it's status is pay or completed |
1.6 |
getOrderStatus |
get order detail when it's status is pay or completed by orderIds |
1.7 |
listHotProducts |
hot products at aliexpress |
1.8 |
listSimilarProducts |
recommened similar products at aliexpress |
1.9 |
getItemByOrderNumbers |
get product info by order numbers |
1.10 |
getAppPromotionProduct |
get product info at apps |
1.1 listPromotionProduct
1.1.1 Sample of the Request URL:
http://api.eshopbing.me/index.php/api/wordpress/ali_request?ApiName=api.listPromotionProduct&ver=2&ApiKey=[ApiKey]&AppKey=[AppKey]&ae_method=[ae_method]&type=Products&fields=[fields]&keywords=[keywords]
Sample URL |
Description |
Remark |
api.eshopbing.me |
Domain name for AliPrice Open Platform |
|
[ae_method] |
Api request |
curl or file |
[ver] |
api version |
The default value is 2. |
api.listPromotionProduct |
api name |
|
[ApiKey] |
Api Key |
When you apply the App successfully, the AliPrice will give you a key. |
[appkey] |
App Key |
When you create the App, the AliExpress open platform will generate an appKey and a secretKey. |
[fields] |
Fields |
List of fields needed to return. Please separate each other with an English comma “,” if you want to use more than one field. |
[type] |
Type |
Products |
1.1.2 Input Parameter:
Parameter |
Type |
Mandatory or not |
Description |
fields |
String |
Yes |
List of fields needed to return. Please separate each other with an English comma “,” if you want to use more than one field. |
keywords |
String |
Special No |
Product title must contain a relevant keyword. Note: You should select at least one of the parameters, keywords or category ID, when you run a query. |
categoryId |
String |
Special No |
The category ID for the products. Add the level-1 category description below for your reference. |
originalPriceFrom |
Double |
No |
The lowest product price,must be stated in USD, E.g. 12.34. |
originalPriceTo |
Double |
No |
The maximum product price,must be stated in USD E.g. US 56.78. |
volumeFrom |
Integer |
No |
The minimum number of sold affiliate products within 30 days, E.g. 123. |
volumeTo |
Integer |
No |
The maximum number of sold affiliate products within 30 days, E.g.456. |
pageNo |
Integer |
No |
Page number. The incoming value of 1 represents the first page; The incoming value of 2 represents the second page, and so on. The returned data from the first page is set to default. |
pageSize |
Integer |
No |
The maximum number of data that can be set on each page is 40. The default value is 20. |
sort |
String |
No |
You can set sort by price from high to low and from low to high, credit score from high to low and from low to high, the commission rate from high to low and from low to high, volume from high to low, the valid time from high to low and from low to high.
Values(orignalPriceUp, orignalPriceDown, sellerRateDown, commissionRateUp, commissionRateDown, volumeDown, validTimeUp, validTimeDown) |
startCreditScore |
Integer |
No |
The lower limit of the credit score of the seller, for example, 12. |
endCreditScore |
Integer |
No |
The upper limit of the credit score of the seller, for example, 123. |
highQualityItems |
String |
No |
The products contain good images & titles, great sales and postive feedback from buyers,for example,'true' or no this parameter. |
localCurrency |
String |
No |
Local Currency i.e. USD, RUB, GBP, BRL, CAD, AUD, EUR, INR, UAH, JPY, MXN, IDR, TRY, SEK |
language |
String |
No |
Lower case,total 17 languages supported(en,pt,ru,es,fr,id,it,nl,tr,vi,th,de,ko,ja,ar,pl,he) |
1.1.3 Output Parameter:
Parameter |
Type |
Description |
totalResults |
Integer |
The number of the total data returned. |
productId |
Long |
The product ID |
productTitle |
String |
The Product Title |
productUrl |
String |
The URL of the Detail Page of the product |
imageUrl |
String |
The URL of the main picture of the product |
originalPrice |
String |
The original price of the product, with the dollar sign, including cents, E.g. $9.95 |
salePrice |
String |
The current price of the product, with the dollar sign, including cents, E.g. $6.95 |
discount |
String |
The discount of the product, E.g. 10.00% |
evaluateScore |
Integer |
The average evaluated score of the product |
commission |
String |
The commission amount, with the dollar sign, including cents, E.g. $3.95 |
commissionRate |
String |
The commission rate, E.g. 12.34% |
30daysCommission |
String |
The total commission amount within the most recent 30 days, with the dollar sign, including cents, E.g. $33.95 |
volume |
Integer |
The number of sold affiliate products within 30 days. |
packageType |
String |
The packaging type of the products: piece or lot. |
lotNum |
Integer |
The number of products in the lot. |
validTime |
String |
The valid time of the product (yyyy-MM-dd) |
localPrice |
String |
Price in local currency |
allImageUrls |
String |
all images urls,separate with an English comma “,” |
1.1.4 Error Code:
20010000 |
Call succeeds |
20020000 |
System Error |
20030000 |
Unauthorized transfer request |
20030010 |
Required parameters |
20030020 |
Invalid protocol format |
20030030 |
API version input parameter error |
20030040 |
API name space input parameter error |
20030050 |
API name input parameter error |
20030060 |
Fields input parameter error |
20030070 |
Keyword input parameter error |
20030080 |
Category ID input parameter error |
20030090 |
Tracking ID input parameter error |
20030100 |
Commission rate input parameter error |
20030110 |
Original Price input parameter error |
20030120 |
Discount input parameter error |
20030130 |
Volume input parameter error |
20030140 |
Page number input parameter error |
20030150 |
Page size input parameter error |
20030160 |
Sort input parameter error |
20030170 |
Credit Score input parameter error |
1.1.5 Frequency of call: 300000/day
1.1.6 Sample of Result:
{ "result": { "totalResults": 105396, "products": [ { "lotNum": 1, "packageType": "piece", "imageUrl": "//is.alicdn.com/wsphoto/v0/1360130582/Smd-diode-ss12-font-b-mp3-b-font-.jpg", "evaluationScore": "", "volume": "0", "productId": 1360130582, "discount": "0%", "validTime": "2014-05-21", "commissionRate": "5.0%", "30daysCommission": "US $0.00", "originalPrice": "US $0.03", "productTitle": "Smd diode ss12 mp3", "productUrl": "https://www.aliexpress.com/item//1360130582.html", "salePrice": "US $0.03", "commission": "US $0.00" } ] }, "errorCode": 20010000 }
1.1.7 F&Q:
-
Can I change the protocol format?
No, the protocol format currently only supports param2, if you change it to other formats, the result will return an error.
-
What parameters can be configured in the system parameters?
The appkey, tracking ID, and product ID can be configured. Changing or adding other parameters might return an error.
-
What will happen if the mandatory fields are not set?
If the mandatory fields are not set, the return will be an error. Please set the mandatory fields by following the precise instructions in the API Document.
-
Can these products be sorted in the returning list?
Yes. The default sort list is: Price from high to low.
You can set sort by:
- Price from low to high
- Credit Score from high to low and from low to high
- The commission rate from high to low and from low to high
- Volume form high to low
- The added time from high to low and from low to high.
-
Could I use the product API to get the promotion URL directly?
No, but you can use the product API to get the product URLs, and then use the getPromotionUrl API to get the promotion URLs automatically.
1.1.8 CATEGORIES:
CATEGORIES |
CATEGORIES ID |
Apparel & Accessories |
3 |
Automobiles & Motorcycles |
34 |
Beauty & Health |
66 |
Books for Local Russian |
200004360 |
Computer & Office |
7 |
Construction & Real Estate |
13 |
Consumer Electronics |
44 |
Electrical Equipment & Supplies |
5 |
Electronic Components & Supplies |
502 |
Food |
2 |
Furniture |
1503 |
Hair & Accessories |
200003655 |
Hardware |
42 |
Home & Garden |
15 |
Home Appliances |
6 |
Industry & Business |
200001996 |
Jewelry & Accessories |
36 |
Lights & Lighting |
39 |
Luggage & Bags |
1524 |
Mother & Kids |
1501 |
Office & School Supplies |
21 |
Phones & Telecommunications |
509 |
Security & Protection |
30 |
Shoes |
322 |
Special Category |
200001075 |
Sports & Entertainment |
18 |
Tools |
1420 |
Toys & Hobbies |
26 |
Travel and Coupon Services |
200003498 |
Watches |
1511 |
Weddings & Events |
320 |
Click left menu [Category Index],you can get the primary categories and Secondary categories information .You can get more accurate product information.
1.2 getPromotionProductDetail
1.2.1 Request URL:
http://api.eshopbing.me/index.php/api/wordpress/ali_request?ApiName=api.getPromotionProductDetail&ver=2&AliPrice_key=[AliPrice_key]&AppKey=[AppKey]&ae_method=[ae_method]&type=ProductDetail&fields=[fields]&productId=[productId]
Sample URL |
Description |
Remark |
api.eshopbing.me |
Domain name for AliPrice Open Platform |
|
[ae_method] |
Api request |
curl or file |
[ver] |
api version |
The default value is 2. |
api.getPromotionProductDetail |
api name |
|
[ApiKey] |
Api Key |
When you apply the App successfully, the AliPrice will give you a key. |
[appkey] |
App Key |
When you create the App, the AliPrice open platform will generate an appKey and a secretKey. |
[fields] |
Fields |
List of fields needed to return. Please separate each other with an English comma “,” if you want to use more than one field. |
[productId] |
ProductId |
The product ID |
[type] |
Type |
ProductDetail |
1.2.2 Input Parameter:
Parameter |
Type |
Mandatory or not |
Description |
fields |
String |
Yes |
List of fields needed to return. Please separate each other with an English comma “,” if you want to use more than one field. |
productId |
String |
Yes |
The product ID |
localCurrency |
String |
No |
Local Currency i.e. USD, RUB, GBP, BRL, CAD, AUD, EUR, INR, UAH, JPY, MXN, IDR, TRY, SEK |
language |
String |
No |
Lower case,total 17 languages supported(en,pt,ru,es,fr,id,it,nl,tr,vi,th,de,ko,ja,ar,pl,he) |
1.2.3 Output Parameter:
Parameter |
Type |
Description |
productId |
Long |
The product ID |
productTitle |
String |
The Product Title |
productUrl |
String |
The URL of the Detail Page of the product |
imageUrl |
String |
The URL of the main picture of the product |
originalPrice |
String |
The original price of the product, with the dollar sign, including cents, E.g. $9.95 |
salePrice |
String |
The current price of the product, with the dollar sign, including cents, E.g. $6.95 |
discount |
String |
The discount of the product, E.g. 10.00% |
evaluateScore |
Integer |
The average evaluated score of the product |
commission |
String |
The commission amount, with the dollar sign, including cents, E.g. $3.95 |
commissionRate |
String |
The commission rate, E.g. 12.34% |
30daysCommission |
String |
The total commission amount within the most recent 30 days, with the dollar sign, including cents, E.g. $33.95 |
volume |
Integer |
TThe number of sold affiliate products within 30 days. |
packageType |
String |
The packaging type of the products: piece or lot. |
lotNum |
Integer |
The number of products in the lot. |
validTime |
String |
The valid time of the product (yyyy-MM-dd) |
storeName |
String |
The name of the seller’s store |
storeUrl |
String |
The Url of the seller’s store |
allImageUrls |
String |
all images urls,separate with an English comma “,” |
1.2.4 Error Code:
20010000 |
Call succeeds |
20020000 |
System Error |
20030000 |
Unauthorized transfer request |
20030010 |
Required parameters |
20030020 |
Invalid protocol format |
20030030 |
API version input parameter error |
20030040 |
API name space input parameter error |
20030050 |
API name input parameter error |
20030060 |
Fields input parameter error |
20030070 |
Product ID input parameter error |
1.2.5 Frequency of call: 100000/day
1.2.6 Sample of Result:
{ "result": { "lotNum": 1, "storeName": "Dollar Store", "packageType": "piece", "imageUrl": "//is.alicdn.com/wsphoto/v0/852517607/Mini-Fashoin-Clip-Metal-USB-MP3-Music-Media-Player-Support-1-8GB-Micro-SD-TF.jpg", "evaluationScore": "4.8", "volume": "71", "productId": 852517607, "discount": "20%", "validTime": "2014-04-30", "commissionRate": "5.0%", "30daysCommission": "US $7.71", "originalPrice": "US $4.75", "productTitle": "Mini Fashoin Clip Metal USB MP3 Music Media Player Support 1 - 8GB Micro SD TF", "productUrl": "https://www.aliexpress.com/item//852517607.html", "salePrice": "US $3.80", "commission": "US $0.19", "storeUrl": "https://www.aliexpress.com/store/213743" }, "errorCode": 20010000 }
1.3 getPromotionLinks
1.3.1 Request URL:
http://api.eshopbing.me/index.php/api/wordpress/ali_request?ApiName=api.getPromotionLinks&ver=2&AliPrice_key=[AliPrice_key]&AppKey=[AppKey]&ae_method=[ae_method]&type=PromotionLinks&trackingId=[trackingId]&fields=[fields]&urls=[url,url]
Sample URL |
Description |
Remark |
api.eshopbing.me |
Domain name for AliPrice Open Platform |
|
[ae_method] |
Api request |
curl or file |
[ver] |
api version |
The default value is 2. |
api.getPromotionLinks |
api name |
|
[ApiKey] |
Api Key |
When you apply the App successfully, the AliPrice will give you a key. |
[appkey] |
App Key |
When you create the App, the AliPrice open platform will generate an appKey and a secretKey. |
[fields] |
Fields |
List of fields needed to return. Please separate each other with an English comma “,” if you want to use more than one field. |
[trackingId] |
Tracking ID |
The tracking ID of your account in the Portals platform. |
[urls] |
Url |
The list of URLs need to be converted to promotion URLs. Please separate each URL with an English “,” if you want to use more than one field. The limit of URL’s that can be used is 50. |
[type] |
Type |
PromotionLinks |
1.3.2 Input Parameter:
Parameter |
Type |
Mandatory or not |
Description |
fields |
String |
Yes |
List of fields needed to return, options including “tracking ID” , ”publisher ID” , ”promotion URL”. Please separate each other with “,” if you want to use more than one field. |
trackingId |
String |
Yes |
The tracking ID of your account in the Portals platform. |
urls |
String |
Yes |
The list of URLs need to be converted to promotion URLs. Please separate each URL with an English “,” if you want to use more than one field. The limit of URL’s that can be used is 50. |
1.3.3 Output Parameter:
Parameter |
Type |
Description |
totalResults |
Integer |
The number of the total data returned. |
trackingId |
String |
The tracking ID of your account in the Portals platform. |
publisherId |
Long |
The publisher ID of your account in the Portals platform. |
url |
String |
The list of URLs need to be converted to promotion URLs. |
promotionUrl |
String |
The Promotion URL encoding some important parameters can be billing.Wecan not return the promotion urls of the goods what are not promoted by the Portals Platform. |
localPrice |
String |
Price in local currency |
1.3.4 Error Code:
20010000 |
Call succeeds |
20020000 |
System Error |
20030000 |
Unauthorized transfer request |
20030010 |
Required parameters |
20030020 |
Invalid protocol format |
20030030 |
API version input parameter error |
20030040 |
API name space input parameter error |
20030050 |
API name input parameter error |
20030060 |
Fields input parameter error |
20030070 |
Tracking ID input parameter error |
20030080 |
URL input parameter error or beyond the maximum number of the URLs |
1.3.5 Frequency of call: 50000/day
1.3.6 Sample of Result:
{ "result": { "promotionUrls": [ [ "https://www.aliexpress.com/item//852517607.html", "http://s.click.aliexpress.com/e/F3aeyMf" ] ], "publisherId": 107470220, "trackingId": "pann" }, "errorCode": 20010000 }
1.3.7 F&Q:
-
How can I use the converting URL API to get the promotion URLs automatically?
You need to set the URLs that are ready for transfer to chain, fields and tracking ID, then call the getPromotionUrl API. Finally you will get the promotion URLs automatically. The limit number of the URL list is 50.
1.4 listPromotionCreative
1.4.1 Request URL:
http://api.eshopbing.me/index.php/api/wordpress/ali_request?ApiName=api.listPromotionCreative&ver=2&ApiKey=[ApiKey]&AppKey=[AppKey]&ae_method=[ae_method]&type=PromotionCreative&appSignature=[appSignature]&category=[category]&language=[language]
1.4.2 Input Parameter:
Sample URL |
Description |
Remark |
api.eshopbing.me |
Domain name for AliPrice Open Platform |
|
[ae_method] |
Api request |
curl or file |
[ver] |
api version |
The default value is 2. |
api.listPromotionCreative |
api name |
|
[ApiKey] |
Api Key |
When you apply the App successfully, the AliPrice will give you a key. |
[appkey] |
App Key |
When you create the App, the AliPrice open platform will generate an appKey and a secretKey. |
[type] |
Type |
PromotionCreative |
[appSignature] |
Ad Center-API Setting–Digital signature |
you can see it in portals ,the path is Ad Center-API Setting–Digital signature. |
[category] |
Category name or all. |
|
[language] |
17 languages |
Lower case,total 17 languages supported(en,pt,ru,es,fr,id,it,nl,tr,vi,th,de,ko,ja,ar,pl,he). |
[pageNo] |
Page number |
Page number. The incoming value of 1 represents the first page; The incoming value of 2 represents the second page, and so on. The returned data from the first page is set to default. |
[pageSize] |
maximum number |
The maximum number of data that can be set on each page is 40. The default value is 20. |
1.4.3 Output Parameter:
Parameter |
Type |
Description |
totalResults |
Integer |
The number of the total data returned. |
activityUrl |
String |
|
activityTime |
String |
The end time of the activity (yyyy-MM-dd). |
activityTitle |
String |
|
description |
String |
activity description. |
images |
Array |
Image array,include one or more image infomation. |
height |
Integer |
The height of the promotion image. |
width |
Integer |
The width of the promotion image. |
imageUrl |
String |
The Url of the promotion image |
1.4.4 Error Code:
20010000 |
Call succeeds |
20020000 |
System Error |
20030000 |
Required Parameter error |
20030070 |
Unauthorized transfer request |
20030140 |
Page number input parameter error |
20030150 |
Page size input parameter error |
1.4.5 Frequency of call: 10000/day
1.4.6 Sample of Result:
{ "result": { "totalResults": 2, "products": [ { "activityUrl": "www.aliexpress.com", "activityTime": “2016-02-03”, "activityTitle": "minjie-test", "description": "for auto-test", "images": [ { "height": 250, "width": 300, "imageUrl": "https://ae01.alicdn.com/kf/UTB18B_AXXXXXXXSXpXXq6xXFXXXM/1.jpg" } ] } ] }, "errorMessage": null, "errorCode": 20010000, "class": "com.alibaba.intl.affiliate.open.promotion.share.dto.ResultDTO" }
1.4.7 category:
category |
all |
Apparel & Accessories |
Automobiles & Motorcycles |
Baby Products |
Beauty & Health |
Computer & Networking |
Construction & Real Estate |
Consumer Electronics |
Customized Products |
Electrical Equipment & Supplies |
Electronic Components & Supplies |
Food |
Furniture |
Hair & Accessories |
Hardware |
Home & Garden |
Home Appliances |
Industry & Business |
Jewelry & Watch |
Lights & Lighting |
Luggage & Bags |
Office & School Supplies |
Phones & Telecommunications |
Security & Protection |
Shoes |
Special Category |
Sports & Entertainment |
Tools |
Toys & Hobbies |
Watches |
1.5 getCompletedOrders
1.5.1 Request URL:
http://api.eshopbing.me/index.php/api/wordpress/ali_request?ApiName=api.getCompletedOrders&ver=2&ApiKey=[ApiKey]&AppKey=[AppKey]&ae_method=[ae_method]&type=CompletedOrders&appSignature=[appSignature]&startDate=[startDate]&endDate=[endDate]&liveOrderStatus=[liveOrderStatus]
1.5.2 Input Parameter:
Sample URL |
Description |
Remark |
api.eshopbing.me |
Domain name for AliPrice Open Platform |
|
[ae_method] |
Api request |
curl or file |
[ver] |
api version |
The default value is 2. |
api.getCompletedOrders |
api name |
|
[ApiKey] |
Api Key |
When you apply the App successfully, the AliPrice will give you a key. |
[appkey] |
App Key |
When you create the App, the AliPrice open platform will generate an appKey and a secretKey. |
[type] |
Type |
CompletedOrders |
[appSignature] |
Ad Center-API Setting–Digital signature |
you can see it in portals ,the path is Ad Center-API Setting–Digital signature. |
[startDate] |
date |
query start date yyyy-mm-dd,eg:2016-01-03. |
[endDate] |
date |
query end date yyyy-mm-dd,eg:2016-02-03. |
[liveOrderStatus] |
Status |
enter:pay or success |
[pageNo] |
Page number |
Page number. The incoming value of 1 represents the first page; The incoming value of 2 represents the second page, and so on. The returned data from the first page is set to default. |
[pageSize] |
maximum number |
The maximum number of data that can be set on each page is 20. The default value is 10. |
1.5.3 Output Parameter:
Parameter |
Type |
Description |
totalResults |
Integer |
The number of the total data returned. |
orderTime |
String |
payment success time MM-dd-yyyy HH:mm. |
transactionTime |
String |
completed order time MM-dd-yyyy HH:mm. |
orderNumber |
Long |
|
product |
String |
the tittle of the product. |
orderStatus |
String |
|
commissionRate |
String |
|
paymentAmount |
String |
|
estimatedCommission |
String |
calculated when the order paid success |
finalPaymentAmount |
String |
calculated when the order completed |
commission |
String |
|
PID |
String |
Publisher ID. |
extraParams |
String |
publisher parameters.Json format,include af,dp,cv and cn |
1.5.4 Error Code:
20010000 |
Call succeeds |
20020000 |
System Error |
20030000 |
Required Parameter error |
20030070 |
Unauthorized transfer request |
20030140 |
Page number input parameter error |
20030150 |
Page size input parameter error |
1.5.5 Frequency of call: 1000/day
1.5.6 Sample of Result:
{ "result": { "totalResults": 1, "orders": [ { " orderTime ": 03-18-2013, "transactionTime ": "04-18-2013", "orderNumber": 18101370817873, "product": "databank product", "orderStatus": "Completed Orders", "commissionRate": "0.85%", "paymentAmount": "0.00", "estimatedCommission": "0.00", "finalPaymentAmount": "100.00", "commission": "0.85", "pid": "1010227873" } ] }, "errorMessage": null, "errorCode": 20010000, "class": "com.alibaba.intl.affiliate.open.order.share.dto.ResultDTO" }
1.6 getOrderStatus
1.6.1 Request URL:
http://api.eshopbing.me/index.php/api/wordpress/ali_request?ApiName=api.getOrderStatus&ver=2&ApiKey=[ApiKey]&AppKey=[AppKey]&ae_method=[ae_method]&type=OrderStatus&appSignature=[appSignature]&orderNumbers=[orderNumbers]
1.6.2 Input Parameter:
Sample URL |
Description |
Remark |
api.eshopbing.me |
Domain name for AliPrice Open Platform |
|
[ae_method] |
Api request |
curl or file |
[ver] |
api version |
The default value is 2. |
api.getOrderStatus |
api name |
|
[ApiKey] |
Api Key |
When you apply the App successfully, the AliPrice will give you a key. |
[appkey] |
App Key |
When you create the App, the AliPrice open platform will generate an appKey and a secretKey. |
[type] |
Type |
OrderStatus |
[appSignature] |
Ad Center-API Setting–Digital signature |
you can see it in portals ,the path is Ad Center-API Setting–Digital signature. |
[orderNumbers] |
order numbers |
order numbers,split by [,],limit 100 |
1.6.3 Output Parameter:
Parameter |
Type |
Description |
totalResults |
Integer |
The number of the total data returned. |
orderTime |
String |
payment success time MM-dd-yyyy HH:mm. |
transactionTime |
String |
completed order time MM-dd-yyyy HH:mm. |
orderNumber |
Long |
|
product |
String |
the tittle of the product. |
orderStatus |
String |
We provide 4 types of Order Status:Order Not Exist,Completed Payments,Completed Orders,Refund Orders |
commissionRate |
String |
|
paymentAmount |
String |
|
estimatedCommission |
String |
calculated when the order paid success |
finalPaymentAmount |
String |
calculated when the order completed |
commission |
String |
|
PID |
String |
Publisher ID. |
extraParams |
String |
publisher parameters.Json format,include af,dp,cv and cn |
1.6.4 Error Code:
20010000 |
Call succeeds |
20020000 |
System Error |
20030000 |
Required Parameter error |
20030070 |
Unauthorized transfer request |
20030170 |
Exceed max order numbers |
20030160 |
Parameter input error |
1.6.5 Frequency of call: 1000/day
1.6.6 Sample of Result:
{ "result": { "totalResults": 2, "orders": [ { "orderTime": "05-20-2016 16:53", "transactionTime": "06-06-2016 18:16", "orderNumber": 75449289820000, "product": "1 Pair 3D Fashion Bushy Cross Natural False Eyelashes Mink Hair Handmade Eye Lashes Makeup Tool Free Shipping", "orderStatus": "Completed Orders", "commissionRate": "8.0%", "paymentAmount": "3.26", "estimatedCommission": "0.26", "finalPaymentAmount": "3.26", "commission": "0.26", "pid": "10222000" }, { "orderTime": "05-10-2016 04:12", "transactionTime": "06-06-2016 14:16", "orderNumber": 7520079690000, "product": "Bodycon Sheath Dress Little Black Long Sleeve Party Dresses Women Clothing Back Full Zipper Robe Sexy Femme Pencil Tight Dress", "orderStatus": "Completed Orders", "commissionRate": "8.0%", "paymentAmount": "10.20", "estimatedCommission": "0.81", "finalPaymentAmount": "10.20", "commission": "0.81", "pid": "10222000" } ] }, "errorCode": 20010000 }
1.7 listHotProducts
1.7.1 Request URL:
http://api.eshopbing.me/index.php/api/wordpress/ali_request?ApiName=api.listHotProducts&ver=2&ApiKey=[ApiKey]&AppKey=[AppKey]&ae_method=[ae_method]&type=HotProducts&localCurrency=[localCurrency]&categoryId=[categoryId]&language=[language]
1.7.2 Input Parameter:
Sample URL |
Description |
Remark |
api.eshopbing.me |
Domain name for AliPrice Open Platform |
|
[ae_method] |
Api request |
curl or file |
[ver] |
api version |
The default value is 2. |
api.listHotProducts |
api name |
|
[ApiKey] |
Api Key |
When you apply the App successfully, the AliPrice will give you a key. |
[appkey] |
App Key |
When you create the App, the AliPrice open platform will generate an appKey and a secretKey. |
[type] |
Type |
HotProducts |
[language] |
17 languages |
Lower case,total 17 languages supported(en,pt,ru,es,fr,id,it,nl,tr,vi,th,de,ko,ja,ar,pl,he). |
[categoryId] |
category ID |
The category ID for the products. Category description refer tab [Category Index]. |
[localCurrency] |
Local Currency |
USD, RUB, GBP, BRL, CAD, AUD, EUR, INR, UAH, JPY, MXN, IDR, TRY, SEK |
1.7.3 Output Parameter:
Parameter |
Type |
Description |
totalResults |
Integer |
The number of the total data returned. |
productId |
Long |
The product ID |
productTitle |
String |
The Product Title |
productUrl |
String |
The URL of the Detail Page of the product |
imageUrl |
String |
The URL of the main picture of the product |
salePrice |
String |
The current price of the product, with the dollar sign, including cents, E.g. $6.95 |
volume |
Integer |
The number of sold affiliate products within 30 days. |
validTime |
String |
The valid time of the product (yyyy-MM-dd) |
localPrice |
String |
Price in local currency |
1.7.4 Error Code:
20010000 |
Call succeeds |
20020000 |
System Error |
20030070 |
Unauthorized transfer request |
1.7.5 Frequency of call: 100000/day
1.7.6 Sample of Result:
{ "result": { "totalResults": 98, "products": [ { "localPrice": "274.98 JPY", "imageUrl": "https://ae01.alicdn.com/kf/HTB1sVsJNXXXXXcpXpXXq6xXFXXXN/Brand-NED-Universal-Kitchen-Bedroom-Living-room-Cabinet-Cupboard-Closet-Wardrobe-0-25W-Inner-Hinge-LED.jpg", "productUrl": "https://www.aliexpress.com/item/Brand-NED-Universal-Kitchen-Bedroom-Living-room-Cabinet-Cupboard-Closet-Wardrobe-0-25W-Inner-Hinge-LED/32570332328.html", "validTime": "2016-11-12", "productTitle": "Brand NED Universal Kitchen Bedroom Living room Cabinet Cupboard Closet Wardrobe 0.25W Inner Hinge LED Sensor Light System", "volume": "30", "salePrice": "US $2.63", "productId": 32570332328 }, { "localPrice": "391.04 JPY", "imageUrl": "https://ae01.alicdn.com/kf/HTB1IFG6LVXXXXXJXpXXq6xXFXXXR/High-quality-Beautiful-Design-Modern-style-Transparent-Visible-Cutaway-Practice-Padlock-Lock-Training-Skill-For-Locksmith.jpg", "productUrl": "https://www.aliexpress.com/item/High-quality-Beautiful-Design-Modern-style-Transparent-Visible-Cutaway-Practice-Padlock-Lock-Training-Skill-For-Locksmith/32615746112.html", "validTime": "2016-11-06", "productTitle": "High quality Beautiful Design Modern style Transparent Visible Cutaway Practice Padlock Lock Training Skill For Locksmith", "volume": "", "salePrice": "US $3.74", "productId": 32615746112 } ] } }
1.8 listSimilarProducts
1.8.1 Request URL:
http://api.eshopbing.me/index.php/api/wordpress/ali_request?ApiName=api.listSimilarProducts&ver=2&ApiKey=[ApiKey]&AppKey=[AppKey]&ae_method=[ae_method]&type=SimilarProducts&productId=[productId]
1.8.2 Input Parameter:
Sample URL |
Description |
Remark |
api.eshopbing.me |
Domain name for AliPrice Open Platform |
|
[ae_method] |
Api request |
curl or file |
[ver] |
api version |
The default value is 2. |
api.listSimilarProducts |
api name |
|
[ApiKey] |
Api Key |
When you apply the App successfully, the AliPrice will give you a key. |
[appkey] |
App Key |
When you create the App, the AliPrice open platform will generate an appKey and a secretKey. |
[type] |
Type |
SimilarProducts |
[productId] |
product id |
|
1.8.3 Output Parameter:
Parameter |
Type |
Description |
totalResults |
Integer |
The number of the total data returned. |
productId |
Long |
The product ID |
productTitle |
String |
The Product Title |
productUrl |
String |
The URL of the Detail Page of the product |
imageUrl |
String |
The URL of the main picture of the product |
salePrice |
String |
The current price of the product, with the dollar sign, including cents, E.g. $6.95 |
volume |
Integer |
The number of sold affiliate products within 30 days. |
validTime |
String |
The valid time of the product (yyyy-MM-dd) |
1.8.4 Error Code:
20010000 |
Call succeeds |
20020000 |
System Error |
20030070 |
Unauthorized transfer request |
20030000 |
Required parameters |
1.8.5 Frequency of call: 100000/day
1.8.6 Sample of Result:
{ "result":{ "totalResults":48, "products":[ { "imageUrl":"https://ae01.alicdn.com/kf/HTB1hqOxKXXXXXcjXpXXq6xXFXXX5/Fiio-X3-2nd-gen-X3-II-X3K-Native-DSD-Decoding-192k-Hz-24bit-Hifi-MP3-Music.jpg", "productUrl":"https://www.aliexpress.com/item/Fiio-X3-2nd-gen-X3-II-X3K-Native-DSD-Decoding-192k-Hz-24bit-Hifi-Music-Player/32506345668.html?scm=1007.14817.75079.0", "validTime":"2017-03-15", "productTitle":"Fiio X3 2nd gen / X3 II / X3K Native DSD Decoding 192k Hz / 24bit Hifi MP3 Music Player High Power Output", "volume":"15", "salePrice":"US $183.00", "productId":32506345668 }, { "imageUrl":"https://ae01.alicdn.com/kf/HTB1mT_SNpXXXXbjXXXXq6xXFXXX8/Original-ONN-X5-8GB-Full-Metal-Professional-Lossless-HIFI-Music-Player-MP3-Player-TFT-Screen-Support.jpg", "productUrl":"https://www.aliexpress.com/item/Original-ONN-X5-8GB-Full-Metal-Professional-Lossless-HIFI-Music-Player-MP3-Player-TFT-Screen-Support/32739169424.html?scm=1007.14817.75079.0", "validTime":"2017-04-05", "productTitle":"Original ONN X5 8GB Full Metal Professional Lossless HIFI Music Player MP3 Player TFT Screen Support APE/FLAC/ALAC/WAV/WMA/MP3", "volume":"19", "salePrice":"US $41.40", "productId":32739169424 } ] }, "errorCode":20010000 }
1.9 getItemByOrderNumbers
1.9.1 Request URL:
http://api.eshopbing.me/index.php/api/wordpress/ali_request?ApiName=api.getItemByOrderNumbers&ver=2&ApiKey=[ApiKey]&AppKey=[AppKey]&ae_method=[ae_method]&type=ItemByOrderNumbers&appSignature=[appSignature]&orderNumbers=[orderNumbers]
1.9.2 Input Parameter:
Sample URL |
Description |
Remark |
api.eshopbing.me |
Domain name for AliPrice Open Platform |
|
[ae_method] |
Api request |
curl or file |
[ver] |
api version |
The default value is 2. |
api.getItemByOrderNumbers |
api name |
|
[ApiKey] |
Api Key |
When you apply the App successfully, the AliPrice will give you a key. |
[appkey] |
App Key |
When you create the App, the AliPrice open platform will generate an appKey and a secretKey. |
[type] |
Type |
ItemByOrderNumbers |
[appSignature] |
Ad Center-API Setting–Digital signature |
you can see it in portals ,the path is Ad Center-API Setting–Digital signature. |
[orderNumbers] |
order number |
|
1.9.3 Output Parameter:
Parameter |
Type |
Description |
totalResults |
Integer |
The number of the total data returned. |
productId |
Long |
The product ID |
productTitle |
String |
The Product Title |
productUrl |
String |
The URL of the Detail Page of the product |
imageUrl |
String |
The URL of the main picture of the product |
salePrice |
String |
The current price of the product, with the dollar sign, including cents, E.g. $6.95 |
volume |
Integer |
The number of sold affiliate products within 30 days. |
validTime |
String |
The valid time of the product (yyyy-MM-dd) |
1.9.4 Error Code:
20010000 |
Call succeeds |
20020000 |
System Error |
20030070 |
Unauthorized transfer request |
20030000 |
Required parameters |
20030170 |
parameter input error |
1.9.5 Frequency of call: 100000/day
1.9.6 Sample of Result:
{ "result":{ "totalResults":4, "products":[ { "imageUrl":"https://ae01.alicdn.com/kf/HTB1eaApIpXXXXcFXFXXq6xXFXXXz/2015-new-DGK-camouflage-street-skateboarding-snapback-cap-hip-hop-cap-The-spring-summer-gorras-baseball.jpg", "productUrl":"https://www.aliexpress.com/item/2015-new-DGK-camouflage-street-skateboarding-snapback-cap-hip-hop-cap-The-spring-summer-gorras-baseball/32332319854.html", "validTime":"2017-03-29", "productTitle":"2015 new DGK camouflage street skateboarding snapback cap hip hop cap The spring/summer gorras baseball cap along tide bone", "volume":"0", "salePrice":"US $3.99", "productId":32332319854 } ] }, "errorCode":20010000 }
1.10 getAppPromotionProduct
1.10.1 Request URL:
http://api.eshopbing.me/index.php/api/wordpress/ali_request?ApiName=api.getAppPromotionProduct&ver=2&ApiKey=[ApiKey]&AppKey=[AppKey]&ae_method=[ae_method]&type=AppPromotionProduct&productId=[productId]
1.10.2 Input Parameter:
Sample URL |
Description |
Remark |
api.eshopbing.me |
Domain name for AliPrice Open Platform |
|
[ae_method] |
Api request |
curl or file |
[ver] |
api version |
The default value is 2. |
api.getAppPromotionProduct |
api name |
|
[AliPrice_key] |
AliPrice Key |
When you apply the App successfully, the AliPrice will give you a key. |
[appkey] |
App Key |
When you create the App, the AliPrice open platform will generate an appKey and a secretKey. |
[type] |
Type |
AppPromotionProduct |
[productId] |
product id |
|
1.10.3 Output Parameter:
Parameter |
Type |
Description |
totalResults |
Integer |
The number of the total data returned. |
productId |
Long |
The product ID |
productTitle |
String |
The Product Title |
productUrl |
String |
The URL of the Detail Page of the product |
appProductUrl |
String |
the apps product detail url |
image220 |
String |
image url ,size 220X220 |
image350 |
String |
image url ,size 350X350 |
image640 |
String |
image url ,size 640X640 |
1.10.4 Error Code:
20010000 |
Call succeeds |
20020000 |
System Error |
20030070 |
Unauthorized transfer request |
20030100 |
parameters error |
1.10.5 Frequency of call: 1000/day
1.10.6 Sample of Result:
{ "result":{ "appProductUrl":"https://m-best.aliexpress.com/s/item/2036083486.html", "productId":"2036083486", "productTitle":"Colorfly C3 4G 8G Pocket HiFi Music Player ", "productUrl":"https://www.aliexpress.com/item/Colorfly-C3-4G-8G-Pocket-HiFi-Music-Player/2036083486.html", "image350":"https://ae01.alicdn.com/kf/HTB1C8TjOXXXXXbtXVXXq6xXFXXXh/Colorfly-C3-8G-Pocket-HiFi-MP3-FLAC-Music-Player-.jpg_350x350.jpg", "image220":"https://ae01.alicdn.com/kf/HTB1C8TjOXXXXXbtXVXXq6xXFXXXh/Colorfly-C3-8G-Pocket-HiFi-MP3-FLAC-Music-Player-.jpg_220x220.jpg", "image640":"https://ae01.alicdn.com/kf/HTB1C8TjOXXXXXbtXVXXq6xXFXXXh/Colorfly-C3-8G-Pocket-HiFi-MP3-FLAC-Music-Player-.jpg_640x640.jpg" }, "errorCode":20010000 }