# 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.

# 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
categoryKeyword category keyword string No 200 Inquiry criteria
pid Product id string No 200 Inquiry criteria
productSku Product sku string No 200 Inquiry criteria

# 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
description Description string 200

Product Type

Product Type Type
ORDINARY_PRODUCT Ordinary product
SERVICE_PRODUCT Service product
PACKAGING_PRODUCT Packaging product
SUPPLIER_PRODUCT Supplier product
SUPPLIER_SHIPPED_PRODUCT Supplier shipped product

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

# 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": "....",
        "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"
            }...
        ],
        "createrTime": "2019-12-24T01:06:37+08:00"
    },
    "requestId": "d8dc0b6d-0ed8-4e19-8f63-3f207ac39832"
}
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

Product Type

Product Type Type
ORDINARY_PRODUCT Ordinary product
SERVICE_PRODUCT Service product
PACKAGING_PRODUCT Packaging product
SUPPLIER_PRODUCT Supplier product
SUPPLIER_SHIPPED_PRODUCT Supplier shipped product

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

# 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
variantName Variant name string 200
variantNameEn Variant name (EN) 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: cm
variantWidth Variant width int 200 Unit: cm
variantHeight Variant height int 200 Unit: cm
variantVolume Variant volume int 200 Unit: cm3
variantWeight Variant weight int 200 Unit: g
variantSellPrice Variant sell price BigDecimal 200 Unit: $ (USD)
createTime Create time 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.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
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: cm
variantWidth Variant width int 200 Unit: cm
variantHeight Variant height int 200 Unit: cm
variantVolume Variant volume int 200 Unit: cm3
variantWeight Variant weight int 200 Unit: g
variantSellPrice Variant sell price BigDecimal 200 Unit: $ (USD)
createTime Create time 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/sock/queryByVid?vid=7874B45D-E971-4DC8-8F59-40530B0F6B77

# CURL

curl --location --request GET 'https://developers.cjdropshipping.com/api2.0/v1/product/sock/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