# 3 Product
# 1 Products
# 1.1 Category List(GET)
Get all category products from CJ.
# URL
https://developers.cjdropshipping.com/api2.0/v1/product/getCategory
# CURL
curl --location --request GET 'https://developers.cjdropshipping.com/api2.0/v1/product/getCategory' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
# Return
success
{
"code": 200,
"result": true,
"message": "Success",
"data": [
{
"categoryFirstName": "Computer & Office",
"categoryFirstList": [
{
"categorySecondName": "Office Electronics",
"categorySecondList": [
{
"categoryId": "2252588B-72E3-4397-8C92-7D9967161084",
"categoryName": "Office & School Supplies"
},
]...
}
]
}
],
"requestId": "ae543fd1-cdd7-4a61-974a-1340fea678c6"
}
Field | Definition | Type | Length | Note |
---|---|---|---|---|
categoryFirstName | First level catalog name | string | 200 | |
categoryFirstList | First level catalog list | string | 200 | |
categorySecondName | Second level catalog name | string | 200 | |
categorySecondList | Second level catalog name | string | 200 | |
categoryId | Third level catalog name | string | 200 | |
categoryName | Third level catalog name | string | 200 |
error
{
"code": 1600100,
"result": false,
"message": "Param error",
"data": null,
"requestId": "323fda9d-3c94-41dc-a944-5cc1b8baf5b1"
}
Field | Definition | Type | Length | Note |
---|---|---|---|---|
code | error code | int | 20 | Reference error code |
result | Whether or not the return is normal | boolean | 1 | |
message | return message | string | 200 | |
data | return data | object | interface data return | |
requestId | requestId | string | 48 | Flag request for logging errors |
# 1.2 Product List(GET)
Get all available products from CJ, criteria inquiry supported. 20 results for each page, fixed.
Note:
- Maximum return of 200 data per page.
- Free users or v1 users are limited to a maximum of 1000 requests per day.(2024-09-30 update)
- One IP is limited to a maximum of three users.(2024-09-30 update)
- Query the product list and add "deliveryTime" field (hours). The values are 24, 48, 72, or null (2024-11-15 update)
# URL
https://developers.cjdropshipping.com/api2.0/v1/product/list
# CURL
curl --location --request GET 'https://developers.cjdropshipping.com/api2.0/v1/product/list' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
Parameter | Definition | Type | Required | Length | Note |
---|---|---|---|---|---|
pageNum | Page number | int | No | 20 | Default 1 |
pageSize | Quantity of results on each page | int | No | 20 | Default 20 |
categoryId | category id | string | No | 200 | Inquiry criteria |
pid | Product id | string | No | 200 | Inquiry criteria |
productSku | Product sku | string | No | 200 | Inquiry criteria |
productName | Product name | string | No | 200 | Inquiry criteria |
productNameEn | Product name(en) | string | No | 200 | Inquiry criteria |
productType | Product type | string | No | 200 | values: ORDINARY_PRODUCT SUPPLIER_PRODUCT |
countryCode | countryCode | string | No | 200 | eg: CN, US |
deliveryTime | Delivery Time (hours) | string | No | 200 | available values: 24,48,72 (Expected to ship within 24 hours,48 hours,72 hours) |
verifiedWarehouse | Verified Inventory Type | number | 否 | 1 | Verified Inventory Type,1=Verified,2=unverified, Not passing values means not restricting queries based on that type |
startInventory | the minimum inventory | number | No | eg: 2 | |
endInventory | the highest inventory | number | No | eg: 10 | |
createTimeFrom | create time(start) | string | No | 200 | format: yyyy-MM-dd hh:mm:ss |
createTimeTo | create time(end) | string | No | 200 | format: yyyy-MM-dd hh:mm:ss |
brandOpenId | brand id | long | No | 200 | Inquiry criteria |
minPrice | minimum price | number | No | 200 | eg: 1.0 |
maxPrice | maximum price | number | No | 200 | eg: 2.5 |
searchType | Search Type | number | No | 5 | Search type: 0=All products, 2=Trending Products, 21=Trending Products View More, default is 0 |
minListedNum | Minimum Listed Num | number | No | 10 | eg: 1 |
maxListedNum | Maximum Listed Num | number | No | 10 | eg: 10 |
sort | Sort Type | string | No | 4 | Sort Type, ignoring case: desc/asc, default: desc |
orderBy | Sort field | string | No | 20 | Sort field, ignoring case: createAt/listedNum, default: createAt |
# Return
success
{
"code": 200,
"result": true,
"message": "Success",
"data": {
"pageNum": 1,
"pageSize": 20,
"total": 1,
"list": [
{
"pid": "04A22450-67F0-4617-A132-E7AE7F8963B0",
"productName": "[\"猫耳朵卫衣\",\"定制卫衣\",\"个性化定制\"]",
"productNameEn": "Personalized Belly-baring Cat Ear Hoody Coat",
"productSku": "CJNSSYWY01847",
"productImage": "https://cc-west-usa.oss-us-west-1.aliyuncs.com/20210129/2167381084610.png",
"productWeight": 0,
"productType": null,
"productUnit": "unit(s)",
"sellPrice": 11.85,
"categoryId": "5E656DFB-9BAE-44DD-A755-40AFA2E0E686",
"categoryName": "Women's Clothing / Tops & Sets / Hoodies & Sweatshirts",
"sourceFrom": 0,
"remark": "",
"createTime": null
}
]
},
"requestId": "f95cd31d-3907-47ce-ac1a-dfdee4315960"
}
Field | Definition | Type | Length | Note |
---|---|---|---|---|
pageNum | Page number | int | 20 | |
pageSize | Quantity of results on each page | int | 20 | |
total | Total quantity of results | int | 20 | |
list | List | |||
pid | Product ID | string | 200 | |
productName | Product name | list | 20 | |
productNameEn | Product name(EN) | string | 200 | |
productSku | Product sku | string | 200 | |
productImage | Product image | string | 200 | |
productWeight | Product weight | int | 200 | Unit: g |
productType | Product type | byte | 200 | |
productUnit | Product unit | string | 48 | |
categoryId | Category id | string | 200 | |
categoryName | Category name | string | 200 | |
addMarkStatus | (Whether) the package mailed | boolean | 1 | |
listingCount | listing count | int | 200 | |
sellPrice | sell price | string | 200 | |
createTime | create time | date | ||
isVideo | Is there a video | long | 2 | |
saleStatus | sale status | int | 20 | |
listedNum | listed number | int | 20 | |
supplierName | supplier name | string | 200 | |
supplierId | supplier id | string | 200 | |
sourceFrom | source | string | 200 |
Product Type
Product Type | Description |
---|---|
ORDINARY_PRODUCT | Ordinary product, managed by CJ for inventory management |
SERVICE_PRODUCT | Service product, If you need to transfer your own goods to CJ warehouse and CJ provides warehousing services, we will mark it as a service item; |
PACKAGING_PRODUCT | Packaging product are used for packaging when shipped from the warehouse. They do not support separate shipping and need to be shipped together with other goods; |
SUPPLIER_PRODUCT | Supplier product, It is a merchant that collaborates with CJ to manage inventory of goods |
SUPPLIER_SHIPPED_PRODUCT | shipped by supplier management |
Product Status
ProductStatus | Description |
---|---|
0 | Deleted |
1 | To be submitted |
2 | Pending |
3 | On sale |
4 | Audit failure |
5 | Off sale |
6 | To be reviewed |
error
{
"code": 1600100,
"result": false,
"message": "Param error",
"data": null,
"requestId": "323fda9d-3c94-41dc-a944-5cc1b8baf5b1"
}
Field | Definition | Type | Length | Note |
---|---|---|---|---|
code | error code | int | 20 | Reference error code |
result | Whether or not the return is normal | boolean | 1 | |
message | return message | string | 200 | |
data | return data | object | interface data return | |
requestId | requestId | string | 48 | Flag request for logging errors |
# 1.3 Product Details(GET)
# URL
https://developers.cjdropshipping.com/api2.0/v1/product/query
# CURL
curl --location --request GET 'https://developers.cjdropshipping.com/api2.0/v1/product/query?pid=000B9312-456A-4D31-94BD-B083E2A198E8' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
Parameter | Definition | Type | Required | Length | Note |
---|---|---|---|---|---|
pid | Product id | string | Choose one of two | 200 | Inquiry criteria |
productSku | Product sku | string | Choose one of two | 200 | Inquiry criteria |
variantSku | variant sku | string | Choose one of two | 200 | Inquiry criteria |
features | features | List | No | 200 | support: enable_combine |
# Return
success
{
"code": 200,
"result": true,
"message": "Success",
"data": {
"pid": "000B9312-456A-4D31-94BD-B083E2A198E8",
"productName": "[\"攀爬车 拖斗车 \",\"攀爬车 \",\"拖斗车 \"]",
"productNameEn": "Small trailer model",
"productSku": "CJJJJTJT05843",
"productImage": "https://cc-west-usa.oss-us-west-1.aliyuncs.com/2054/1672872416690.jpg",
"productWeight": "1500.0",
"productUnit": "unit(s)",
"productType": "ORDINARY_PRODUCT",
"categoryId": "87CF251F-8D11-4DE0-A154-9694D9858EB3",
"categoryName": "Home & Garden, Furniture / Home Storage / Home Office Storage",
"entryCode": "8712008900",
"entryName": "模型",
"entryNameEn": "model",
"materialName": "[\"\",\"金属\"]",
"materialNameEn": "[\"\",\"metal\"]",
"materialKey": "[\"METAL\"]",
"packingWeight": "1580.0",
"packingName": "[\"\",\"塑料袋\"]",
"packingNameEn": "[\"\",\"plastic_bag\"]",
"packingKey": "[\"PLASTIC_BAG\"]",
"productKey": "[\"颜色\"]",
"productKeyEn": "Color",
"sellPrice": 58.09,
"sourceFrom": 1,
"description": "....",
"suggestSellPrice": "0.97-4.08",
"listedNum": 392,
"status": "3",
"supplierName": "",
"supplierId": "",
"variants": [
{
"vid": "D4057F56-3F09-4541-8461-9D76D014846D",
"pid": "000B9312-456A-4D31-94BD-B083E2A198E8",
"variantName": null,
"variantNameEn": "Small trailer model Black",
"variantSku": "CJJJJTJT05843-Black",
"variantUnit": null,
"variantProperty": null,
"variantKey": "Black",
"variantLength": 300,
"variantWidth": 200,
"variantHeight": 100,
"variantVolume": 6000000,
"variantWeight": 1580.00,
"variantSellPrice": 58.09,
"createTime": "2019-12-31T11:14:12.000+00:00"
"variantStandard": "long=110,width=110,height=30",
"variantSugSellPrice": 0.97
"combineVariants":[{}]
}...
],
"createrTime": "2019-12-24T01:06:37+08:00"
},
"requestId": "d8dc0b6d-0ed8-4e19-8f63-3f207ac39832"
}
product
Field | Definition | Type | Length | Note |
---|---|---|---|---|
pid | Product ID | string | 200 | |
productName | Product name | list | 20 | |
productNameEn | Product name(EN) | string | 200 | |
productSku | Product sku | string | 200 | |
productImage | Product image | string | 200 | |
productWeight | Product weight | int | 200 | Unit: g |
productType | Product type | byte | 200 | |
productUnit | Product unit | string | 48 | |
categoryId | Category id | string | 200 | |
categoryName | Category name | string | 200 | |
entryCode | HS code | string | 200 | |
entryName | Customs name | string | 200 | |
entryNameEn | Customs name (EN) | string | 200 | |
materialName | Material | string | 200 | |
materialNameEn | Material (EN) | string | 200 | |
materialKey | Material attribute | string | 200 | |
packWeight | Package weight | int | 200 | Unit: g |
packingName | Package name | string | 200 | |
packingNameEn | Package name (EN) | string | 200 | |
packingKey | Package attribute | string | 200 | |
productKey | Product attribute | string | 200 | |
productKeyEn | Product attribute (EN) | string | 200 | |
addMarkStatus | (Whether) the package mailed | boolean | 1 | |
description | Description | string | 200 | |
sellPrice | sell price | string | 200 | |
sourceFrom | source | string | 20 | |
createrTime | creater time | string | 20 | |
sellPrice | sell price | string | 200 | |
productVideo | product video | string | 200 | |
status | status | string | 20 | |
suggestSellPrice | suggest sell price | string | 20 | |
listedNum | listed number | int | 20 | |
supplierName | supplier name | string | 20 | |
supplierId | supplier Id | string | 20 | |
variants | Variants | List |
variant
Field | Definition | Type | Length | Note |
---|---|---|---|---|
vid | Variant Id | string | 200 | |
pid | Product Id | string | 20 | |
variantName | Variant Name | string | 200 | |
variantNameEn | Variant Name(en) | string | 200 | |
variantSku | Variant SKU | string | 200 | |
variantImage | Variant Image | string | 200 | |
variantStandard | Variant Standard | string | 200 | |
variantUnit | Variant Unit | string | 200 | |
variantProperty | Variant Property | string | 200 | |
variantKey | Variant Key | string | 200 | |
variantLength | Variant Length | int | 200 | Unit: mm |
variantWidth | Variant Width | int | 200 | Unit: mm |
variantHeight | Variant Height | int | 200 | Unit: mm |
variantVolume | Variant Volume | int | 200 | Unit: mm3 |
variantWeight | Variant Weight | double | 200 | Unit: g |
variantSellPrice | Variant SellPrice | double | 200 | unit: $ (USD) |
variantSugSellPrice | Variant Suggest SellPrice | double | 200 | unit: $ (USD) |
createTime | Vreater Time | string | 200 | |
combineNum | number of Combine Variants | int | ||
combineVariants | Combine Variants | List | 200 |
Product Type
Product Type | Description |
---|---|
ORDINARY_PRODUCT | Ordinary product |
SERVICE_PRODUCT | Service product |
PACKAGING_PRODUCT | Packaging product |
SUPPLIER_PRODUCT | Supplier product |
SUPPLIER_SHIPPED_PRODUCT | Supplier shipped product |
Product Status
product status | remark |
---|---|
0 | Deleted |
1 | To be submitted |
2 | Pending |
3 | On sale |
4 | Audit failure |
5 | Off sale |
6 | To be reviewed |
error
{
"code": 1600100,
"result": false,
"message": "Param error",
"data": null,
"requestId": "323fda9d-3c94-41dc-a944-5cc1b8baf5b1"
}
Field | Definition | Type | Length | Note |
---|---|---|---|---|
code | error code | int | 20 | Reference error code |
result | Whether or not the return is normal | boolean | 1 | |
message | return message | string | 200 | |
data | return data | object | interface data return | |
requestId | requestId | string | 48 | Flag request for logging errors |
# 1.4 Add to My Product (POST)
# URL
https://developers.cjdropshipping.com/api2.0/v1/product/addToMyProduct
# CURL
curl --location 'http://localhost:8081/api2.0/v1/product/addToMyProduct' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
"productId": "1658748072937136128"
}'
Parameter | Definition | Type | Required | Length | Note |
---|---|---|---|---|---|
productId | cj product id | string | Yes | 100 |
# Return
success
{
"code": 200,
"result": true,
"message": "Success",
"data": true,
"requestId": "a7d4d01b1eed4db9ac2cc1ab7903c98c",
"success": true
}
error
{
"code": 1600000,
"result": false,
"message": "The product has been added to My Products.",
"data": null,
"requestId": "b626475ff68242c3abfea562f9d4f899",
"success": false
}
Field | Definition | Type | Length | Note |
---|---|---|---|---|
code | error code | int | 20 | Reference error code |
result | Whether or not the return is normal | boolean | 1 | |
message | return message | string | 200 | |
data | return data | object | interface data return | |
requestId | requestId | string | 48 | Flag request for logging errors |
# 1.3 My Product List(GET)
# URL
https://developers.cjdropshipping.com/api2.0/v1/product/myProduct/query
# CURL
curl --location --request GET 'https://developers.cjdropshipping.com/api2.0/v1/product/myProduct/query?keyword=CJWJWJYZ02543' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
Parameter | Definition | Type | Required | Length | Note |
---|---|---|---|---|---|
keyword | sku/spu/product name | string | No | 200 | |
categoryId | category id | string | No | 200 | |
startAt | start time | string | No | 200 | |
endAt | ent time | string | No | 200 | |
isListed | isListed | int | No | 200 | |
visiable | visiable | int | No | 200 | |
hasPacked | hasPacked | int | No | 200 | |
hasVirPacked | hasVirPacked | int | No | 200 |
# Return
success
{
"code": 200,
"result": true,
"message": "Success",
"data": {
"pageSize": 10,
"pageNumber": 1,
"totalRecords": 536,
"totalPages": 54,
"content": [
{
"productId": "01118E21-A8B9-45CE-A16C-75232FB8A14A",
"packWeight": "530.0",
"weight": "480.0",
"productType": "0",
"propertyKeyList": [
"COMMON"
],
"bigImage": "https://cf.cjdropshipping.com/15926688/9714688036284.jpg",
"nameEn": "3D wooden three-dimensional puzzle",
"sku": "CJWJWJJM00719",
"hasPacked": 0,
"sellPrice": "2.4",
"discountPrice": null,
"discountPriceRate": null,
"defaultArea": "China Warehouse",
"shopMethod": "CAI NIAO",
"trialFreight": "0",
"totalPrice": "2.40",
"listedShopNum": "0",
"vid": "7986724D-7214-4B4B-A184-493E7BD78F47",
"areaId": "1",
"areaCountryCode": "CN",
"freightDiscount": "0",
"createAt": 1743218214000,
"lengthList": [
335,
335
],
"heightList": [
200,
200
],
"widthList": [
225,
225
],
"volumeList": [
15075000,
15075000
],
"hasVirPacked": 1
}
]
},
"requestId": "b0f251412bd0446cb56ba5988706d964",
"success": true
}
product
Field | Definition | Type | Length | Note |
---|---|---|---|---|
productId | Product ID | string | 200 | |
productName | Product name | list | 20 | |
nameEn | Product name(EN) | string | 200 | |
sku | Product sku | string | 200 | |
bigImage | Product image | string | 200 | |
totalPrice | Product weight | double | 200 | unit: $ (USD) |
productType | Product type | byte | 200 | |
listedShopNum | listed Shop Num | string | 48 | |
createAt | Added Time | string | 200 | |
trialFreight | trial Freight | string | 200 |
error
{
"code": 1600100,
"result": false,
"message": "Param error",
"data": null,
"requestId": "323fda9d-3c94-41dc-a944-5cc1b8baf5b1"
}
Field | Definition | Type | Length | Note |
---|---|---|---|---|
code | error code | int | 20 | Reference error code |
result | Whether or not the return is normal | boolean | 1 | |
message | return message | string | 200 | |
data | return data | object | interface data return | |
requestId | requestId | string | 48 | Flag request for logging errors |
# 2 Variant
# 2.1 Inquiry Of All Variants (GET)
# URL
https://developers.cjdropshipping.com/api2.0/v1/product/variant/query
# CURL
curl --location --request GET 'https://developers.cjdropshipping.com/api2.0/v1/product/variant/query?pid=00006BC5-E1F5-4C65-BE2B-3FE0956DA21C' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
Parameter | Definition | Type | Required | Length | Note |
---|---|---|---|---|---|
pid | Product id | string | Choose one of two | 200 | Inquiry criteria |
productSku | Product sku | string | Choose one of two | 200 | Inquiry criteria |
variantSku | variant sku | string | Choose one of two | 200 | Inquiry criteria |
# Return
success
{
"code": 200,
"result": true,
"message": "Success",
"data": [
{
"vid": "1D72A20A-D113-4FAB-B4BA-6FE1A6A14A3A",
"pid": "77501FB4-7146-452E-9889-CDF41697E5CF",
"variantName": null,
"variantNameEn": "Wwerwieurieowursdklfjskldjfklsdjfksljfklsdjfkldsjfksdjfksljfksdlfsfdfgf XS",
"variantSku": "CJJSBGBG01517-XS",
"variantNum": "1598445624293",
"variantStandard": "long=5,width=5,height=5",
"variantUnit": null,
"variantProperty": null,
"variantKey": "[\"XS\"]",
"variantLength": 5,
"variantWidth": 5,
"variantHeight": 5,
"variantVolume": 27,
"variantWeight": 3.00,
"variantSellPrice": 3.00,
"createTime": null
}
],
"requestId": "00765963-35d0-4a6a-b5cf-aa6731793b10"
}
Field | Definition | Type | Length | Note |
---|---|---|---|---|
vid | Variant ID | string | 200 | |
pid | Product ID | string | 200 | |
variantName | Variant name | string | 200 | |
variantNameEn | Variant name (EN) | string | 200 | |
variantImage | Variant image | string | 200 | |
variantSku | Variant sku | string | 200 | |
variantUnit | Variant unit | string | 200 | |
variantProperty | Variant property | string | 200 | |
variantKey | Variant Key | string | 200 | |
variantLength | Variant length | int | 200 | Unit: mm |
variantWidth | Variant width | int | 200 | Unit: mm |
variantHeight | Variant height | int | 200 | Unit: mm |
variantVolume | Variant volume | int | 200 | Unit: mm3 |
variantWeight | Variant weight | int | 200 | Unit: g |
variantSellPrice | Variant sell price | BigDecimal | 200 | Unit: $ (USD) |
createTime | Create time | string | 200 | |
variantStandard | variant standard | string | 200 | |
variantSugSellPrice | variant suggest sell price | BigDecimal | 200 | Unit: $ (USD) |
error
{
"code": 1600100,
"result": false,
"message": "Param error",
"data": null,
"requestId": "323fda9d-3c94-41dc-a944-5cc1b8baf5b1"
}
Field | Definition | Type | Length | Note |
---|---|---|---|---|
code | error code | int | 20 | Reference error code |
result | Whether or not the return is normal | boolean | 1 | |
message | return message | string | 200 | |
data | return data | object | interface data return | |
requestId | requestId | string | 48 | Flag request for logging errors |
# 2.2 Variant Id Inquiry (GET)
# URL
https://developers.cjdropshipping.com/api2.0/v1/product/variant/queryByVid
# CURL
curl --location --request GET 'https://developers.cjdropshipping.com/api2.0/v1/product/variant/queryByVid?vid=1371342252697325568' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
Parameter | Definition | Type | Required | Length | Note |
---|---|---|---|---|---|
vid | Variant ID | string | Yes | 200 | Inquiry criteria |
# Return
success
{
"code": 200,
"result": true,
"message": "Success",
"data": {
"vid": "1371342252697325568",
"pid": "00006BC5-E1F5-4C65-BE2B-3FE0956DA21C",
"variantName": null,
"variantNameEn": "a-Baby pacifier chain test1 Grey",
"variantSku": "CJJSBGDY00002-Grey",
"variantUnit": null,
"variantProperty": "[]",
"variantKey": "Grey",
"variantLength": 3,
"variantWidth": 3,
"variantHeight": 3,
"variantVolume": 27,
"variantWeight": 3.00,
"variantSellPrice": 3.00,
"createTime": "2021-03-15T14:07:26.000+00:00"
},
"requestId": "9b86a5e2-40c3-492c-92b2-4634fa4c4a21"
}
Field | Definition | Type | Length | Note |
---|---|---|---|---|
vid | Variant id | string | 200 | |
pid | Product id | string | 200 | |
variantName | Variant name | string | 200 | |
variantNameEn | Variant name (EN) | string | 200 | |
variantImage | Variant image | string | 200 | |
variantSku | Variant sku | string | 200 | |
variantNum | Variant num | int | 200 | Unit: g |
variantUnit | Variant unit | string | 200 | |
variantProperty | Variant property | string | 200 | |
variantKey | Variant key | string | 200 | |
variantLength | Variant length | int | 200 | Unit: mm |
variantWidth | Variant width | int | 200 | Unit: mm |
variantHeight | Variant height | int | 200 | Unit: mm |
variantVolume | Variant volume | int | 200 | Unit: mm3 |
variantWeight | Variant weight | int | 200 | Unit: g |
variantSellPrice | Variant sell price | BigDecimal | 200 | Unit: $ (USD) |
createTime | Create time | string | 200 | |
variantStandard | Variant standard | string | 200 |
error
{
"code": 1600100,
"result": false,
"message": "Param error",
"data": null,
"requestId": "323fda9d-3c94-41dc-a944-5cc1b8baf5b1"
}
Field | Definition | Type | Length | Note |
---|---|---|---|---|
code | error code | int | 20 | Reference error code |
result | Whether or not the return is normal | boolean | 1 | |
message | return message | string | 200 | |
data | return data | object | interface data return | |
requestId | requestId | string | 48 | Flag request for logging errors |
# 3 Inventory
# 3.1 Inventory Inquiry(GET)
# URL
https://developers.cjdropshipping.com/api2.0/v1/product/stock/queryByVid?vid=7874B45D-E971-4DC8-8F59-40530B0F6B77
# CURL
curl --location --request GET 'https://developers.cjdropshipping.com/api2.0/v1/product/stock/queryByVid?vid=7874B45D-E971-4DC8-8F59-40530B0F6B77' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
Parameter | Definition | Type | Required | Length | Note |
---|---|---|---|---|---|
vid | Variant id | string | Yes | 200 | Inquiry criteria |
# Return
success
{
"code": 200,
"result": true,
"message": "Success",
"data": [
{
"vid": "7874B45D-E971-4DC8-8F59-40530B0F6B77",
"areaId": "1",
"areaEn": "China Warehouse",
"countryCode": "CN",
"storageNum": 10877
}...
],
"requestId": "bcde45ac-da31-4fc7-a05e-e3b23a1e6694"
}
Field | Definition | Type | Length | Note |
---|---|---|---|---|
vid | Variant id | bigint | 200 | |
areaId | Warehouse id | int | 20 | |
areaEn | Warehouse name | string | 200 | |
countryCode | Country code(EN) | string | 200 | |
storageNum | Storage num | string | 200 |
error
{
"code": 1600100,
"result": false,
"message": "Param error",
"data": null,
"requestId": "323fda9d-3c94-41dc-a944-5cc1b8baf5b1"
}
Field | Definition | Type | Length | Note |
---|---|---|---|---|
code | error code | int | 20 | Reference error code |
result | Whether or not the return is normal | boolean | 1 | |
message | return message | string | 200 | |
data | return data | object | interface data return | |
requestId | requestId | string | 48 | Flag request for logging errors |
# 3.2 Query Inventory by SKU (GET)
# URL
https://developers.cjdropshipping.com/api2.0/v1/product/stock/queryBySku?sku=CJDS2012593
# CURL
curl --location --request GET 'https://developers.cjdropshipping.com/api2.0/v1/product/stock/queryBySku?sku=CJDS2012593' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
Parameter | Definition | Type | Required | Length | Note |
---|---|---|---|---|---|
sku | SKU or SPU | string | Yes | 200 |
# Return
success
{
"code": 200,
"result": true,
"message": "Success",
"data": [
{
"areaEn": "China Warehouse",
"areaId": 1,
"countryCode": "CN",
"totalInventoryNum": 777566,
"cjInventoryNum": 0,
"factoryInventoryNum": 777566,
"countryNameEn": "China"
},
{
"areaEn": "US Warehouse",
"areaId": 2,
"countryCode": "US",
"totalInventoryNum": 36,
"cjInventoryNum": 36,
"factoryInventoryNum": 0,
"countryNameEn": "United States of America (the)"
}
],
"requestId": "dd4c7d122df24b80a094a4aba073724f",
"success": true
}
Field | Definition | Type | Length | Note |
---|---|---|---|---|
vid | Variant id | bigint | 200 | |
areaId | Warehouse id | int | 20 | |
areaEn | Warehouse name | string | 200 | |
countryCode | Country code(EN) | string | 200 | |
countryNameEn | Country name | string | 200 | |
totalInventoryNum | total inventory number | int | 20 | |
cjInventoryNum | Inventory management in CJ warehouse | int | 20 | |
factoryInventoryNum | Inventory management in CJ factory | int | 20 |
error
{
"code": 1600100,
"result": false,
"message": "Param error",
"data": null,
"requestId": "323fda9d-3c94-41dc-a944-5cc1b8baf5b1"
}
Field | Definition | Type | Length | Note |
---|---|---|---|---|
code | error code | int | 20 | Reference error code |
result | Whether or not the return is normal | boolean | 1 | |
message | return message | string | 200 | |
data | return data | object | interface data return | |
requestId | requestId | string | 48 | Flag request for logging errors |
# 4 Product Reviews
# 4.1 Inquiry Reviews (GET)
# URL
https://developers.cjdropshipping.com/api2.0/v1/product/comments
Will be deprecated on June 1, 2024, Please use the new api Inquiry Reviews
# CURL
curl --location --request GET 'https://developers.cjdropshipping.com/api2.0/v1/product/comments?pid=7874B45D-E971-4DC8-8F59-40530B0F6B77' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
Parameter | Definition | Type | Required | Length | Note |
---|---|---|---|---|---|
pid | Product id | string | Yes | 200 | Inquiry criteria |
score | score | integer | No | 20 | Inquiry criteria |
pageNum | page number | int | No | 20 | default: 1 |
pageSize | page size | int | No | 20 | default: 20 |
# Return
success
{
"success": true,
"code": 0,
"message": null,
"data": {
"pageNum": "1",
"pageSize": "1",
"total": "285",
"list": [
{
"commentId": 1536993287524069376,
"pid": "1534092419615174656",
"comment": "excelente estado, llegó en una semana, cumple con lo descrito.\nBuena calidad de audio.",
"commentDate": "2022-06-13T00:00:00+08:00",
"commentUser": "F***o",
"score": "5",
"commentUrls": [
"https://cc-west-usa.oss-us-west-1.aliyuncs.com/comment/additional/0001/image/2022-06-15/1126211e-ca15-45ed-95f2-880567ebba37.jpg",
"https://cc-west-usa.oss-us-west-1.aliyuncs.com/comment/additional/0001/image/2022-06-15/291ab894-068f-4f4e-b01f-57df72902f58.jpg"
],
"countryCode": "MX",
"flagIconUrl": "https://cc-west-usa.oss-us-west-1.aliyuncs.com/national-flags/phone/US.png"
}
],
"requestId": "bcde45ac-da31-4fc7-a05e-e3b23a1e6694"
}
Field | Definition | Type | Length | Note |
---|---|---|---|---|
pid | Product id | String | 200 | |
commentId | Comment id | long | 20 | |
comment | Comment | string | 200 | |
commentUrls | Comment url | string[] | 200 | |
commentUser | Comment user | string | 200 | |
score | score | int | 20 | |
countryCode | Country code | string | 20 | |
commentDate | Comment date | string | 200 | |
flagIconUrl | FlagIcon url | string | 200 |
error
{
"code": 1600100,
"result": false,
"message": "Param error",
"data": null,
"requestId": "323fda9d-3c94-41dc-a944-5cc1b8baf5b1"
}
Field | Definition | Type | Length | Note |
---|---|---|---|---|
code | error code | int | 20 | Reference error code |
result | Whether or not the return is normal | boolean | 1 | |
message | return message | string | 200 | |
data | return data | object | interface data return | |
requestId | requestId | string | 48 | Flag request for logging errors |
# 4.2 Inquiry Reviews (GET)
# URL
https://developers.cjdropshipping.com/api2.0/v1/product/productComments
# CURL
curl --location --request GET 'https://developers.cjdropshipping.com/api2.0/v1/product/productComments?pid=7874B45D-E971-4DC8-8F59-40530B0F6B77' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
Parameter | Definition | Type | Required | Length | Note |
---|---|---|---|---|---|
pid | Product id | string | Yes | 200 | Inquiry criteria |
score | score | integer | No | 20 | Inquiry criteria |
pageNum | page number | int | No | 20 | default: 1 |
pageSize | page size | int | No | 20 | default: 20 |
# Return
success
{
"success": true,
"code": 0,
"message": null,
"data": {
"pageNum": "1",
"pageSize": "1",
"total": "285",
"list": [
{
"commentId": 1536993287524069376,
"pid": "1534092419615174656",
"comment": "excelente estado, llegó en una semana, cumple con lo descrito.\nBuena calidad de audio.",
"commentDate": "2022-06-13T00:00:00+08:00",
"commentUser": "F***o",
"score": "5",
"commentUrls": [
"https://cc-west-usa.oss-us-west-1.aliyuncs.com/comment/additional/0001/image/2022-06-15/1126211e-ca15-45ed-95f2-880567ebba37.jpg",
"https://cc-west-usa.oss-us-west-1.aliyuncs.com/comment/additional/0001/image/2022-06-15/291ab894-068f-4f4e-b01f-57df72902f58.jpg"
],
"countryCode": "MX",
"flagIconUrl": "https://cc-west-usa.oss-us-west-1.aliyuncs.com/national-flags/phone/US.png"
}
],
"requestId": "bcde45ac-da31-4fc7-a05e-e3b23a1e6694"
}
Field | Definition | Type | Length | Note |
---|---|---|---|---|
pid | Product id | String | 200 | |
commentId | Comment id | long | 20 | |
comment | Comment | string | 200 | |
commentUrls | Comment url | string[] | 200 | |
commentUser | Comment user | string | 200 | |
score | score | int | 20 | |
countryCode | Country code | string | 20 | |
commentDate | Comment date | string | 200 | |
flagIconUrl | FlagIcon url | string | 200 |
error
{
"code": 1600100,
"result": false,
"message": "Param error",
"data": null,
"requestId": "323fda9d-3c94-41dc-a944-5cc1b8baf5b1"
}
Field | Definition | Type | Length | Note |
---|---|---|---|---|
code | error code | int | 20 | Reference error code |
result | Whether or not the return is normal | boolean | 1 | |
message | return message | string | 200 | |
data | return data | object | interface data return | |
requestId | requestId | string | 48 | Flag request for logging errors |
# 5 Sourcing
# 5.1 Create Sourcing (POST)
# URL
https://developers.cjdropshipping.com/api2.0/v1/product/sourcing/create
# CURL
curl --location --request POST 'https://developers.cjdropshipping.com/api2.0/v1/product/sourcing/create' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
--header 'Content-Type: application/json' \
--data-raw '{
"thirdProductId": "",
"thirdVariantId": "",
"thirdProductSku": "",
"productName": "",
"productImage": "",
"productUrl": "",
"remark": "",
"price": ""
}'
Parameter | Definition | Type | Required | Length | Note |
---|---|---|---|---|---|
thirdProductId | third product id | string | No | 200 | |
thirdVariantId | third variant id | string | No | 200 | |
thirdProductSku | third product sku | string | No | 200 | |
productName | product name | string | Yes | 200 | |
productImage | product image | string | Yes | 200 | |
productUrl | product url | string | No | 200 | |
remark | remark | string | No | 200 | |
price | price | BigDecimal | 200 | Unit: $ (USD) |
# Return
success
{
"success": true,
"code": 0,
"message": null,
"data": {
"cjSourcingId": "285",
"result":"success",
}
"requestId": "bcde45ac-da31-4fc7-a05e-e3b23a1e6694"
}
Field | Definition | Type | Length | Note |
---|---|---|---|---|
cjSourcingId | cj sourcing id | string | 50 | |
result | search results | string | 20 |
error
{
"code": 1600100,
"result": false,
"message": "Param error",
"data": null,
"requestId": "323fda9d-3c94-41dc-a944-5cc1b8baf5b1"
}
Field | Definition | Type | Length | Note |
---|---|---|---|---|
code | error code | int | 20 | Reference error code |
result | Whether or not the return is normal | boolean | 1 | |
message | return message | string | 200 | |
data | return data | object | interface data return | |
requestId | requestId | string | 48 | Flag request for logging errors |
# 5.2 Query Sourcing(POST)
# URL
https://developers.cjdropshipping.com/api2.0/v1/product/sourcing/query
# CURL
curl --location --request POST 'https://developers.cjdropshipping.com/api2.0/v1/product/sourcing/query' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
--header 'Content-Type: application/json' \
--data-raw '{
"sourceIds": []
}'
Parameter | Definition | Type | Required | Length | Note |
---|---|---|---|---|---|
sourceIds | cj sourcing id | string[] | Yes | 200 |
# Return
success
{
"success": true,
"code": 0,
"message": null,
"data": {
"sourceId": "285",
"sourceNumber":"223333",
"productId": "3324343434",
"variantId":"4545456",
"shopId": "285",
"shopName":"aaaaaaa",
"sourceStatus": "5",
"sourceStatusStr":"搜品失败",
"cjProductId": "285",
"cjVariantSku":"CJ287690900",
}
"requestId": "bcde45ac-da31-4fc7-a05e-e3b23a1e6694"
}
Field | Definition | Type | Length | Note |
---|---|---|---|---|
sourceId | cj sourcing id | string | 50 | |
sourceNumber | Search short code | string | 20 | |
productId | product id | string | 50 | |
variantId | variant id | string | 50 | |
shopId | shop id | string | 50 | |
shopName | shop name | string | 50 | |
sourceStatus | status | string | 10 | |
sourceStatusStr | status (chinese) | string | 50 | |
cjProductId | cj product id | string | 50 | |
cjVariantSku | cj variant sku | string | 50 |
error
{
"code": 1600100,
"result": false,
"message": "Param error",
"data": null,
"requestId": "323fda9d-3c94-41dc-a944-5cc1b8baf5b1"
}
Field | Definition | Type | Length | Note |
---|---|---|---|---|
code | error code | int | 20 | Reference error code |
result | Whether or not the return is normal | boolean | 1 | |
message | return message | string | 200 | |
data | return data | object | interface data return | |
requestId | requestId | string | 48 | Flag request for logging errors |