# 12 Listing
This document is designed for AI-assisted integration
Listing involves many APIs and platform-specific rules, which makes manual integration complex. We recommend using an AI coding assistant (e.g. Claude Code, Codex, Cursor) to read this entire document and generate the integration code, or list through conversation via CJ MCP.
List a single CJ product to one of the platform stores you have authorized in CJ, plus the lookup APIs needed before listing (categories, attributes, brands, sites, shipping, templates, etc.). It works the same as the "List" dialog on the CJ product page.
# 0 Overview
# 0.1 Use cases
- After choosing a CJ product in your own ERP / sourcing tool, list it directly to a store bound to your CJ account;
- Once listed, CJ automatically connects the platform product to the CJ product, so orders from that store can be synced to CJ for fulfillment.
- All APIs are
POSTwith a JSON body and theCJ-Access-Tokenheader.- Your account and IP are identified from the Access Token. Do not (and cannot) pass identity fields in the body.
- Every API that takes
shopIdfirst checks that the store belongs to your account; otherwise it returns10001. Get the store ID from 9 Shop · 1.1 Get Shop List and only use stores withstatus = 1(enabled).- Platform-specific APIs (eBay, AliExpress, Shopify only, etc.) return
10005for stores of other platforms.
# 0.2 Supported platforms
There are two listing APIs, async and sync. Which one to use is fixed by the store platform; calling the wrong one returns 10005 and the message tells you which API to use.
| Mode | API | Platforms (type from /shop/getShops) | data |
|---|---|---|---|
| Async | /listed/publishAsync | Shopify, WooCommerce, Lazada, Shopee, TikTok, TikTok US, TikTok US Cross, Whop, Nuvemshop, AliExpress, Mercado, Temu, Temu US Local | Listing record ID (listedId); poll the result with /listed/queryPublishStatus |
| Sync | /listed/publishSync | eBay, Etsy, BigCommerce, Squarespace, Magento, PrestaShop, Wix, Shoplazza, AllValue | Platform product URL; the listing is done when the API returns |
Other platforms (Amazon, Walmart, Shein, etc.) are not supported and return 10005. Etsy, BigCommerce, Squarespace, Magento and PrestaShop are referred to as "Rutter platforms" below.
# 0.3 Recommended call sequence
- Choose a store:
GET /api2.0/v1/shop/getShops, pick a store withstatus = 1, note itsid(shopId) andtype(platform). - Check the store and get its currency (optional):
POST /api2.0/v1/listed/queryShopInfowithshopId+productId. It also tells you early whether the product is already listed (20001). - Choose destination country and calculate shipping:
POST /api2.0/v1/product/listed/getReceiverCountryInfo(body:platform,startCountryCodes) givestargetCountryCode;POST /api2.0/v1/logistic/freightCalculate(see 6 Logistic · 1.1 Freight Calculation) gives the shipping methodlogisticName→ listing fieldlogisticsWay, and the freight →variants[].shippingCost.
- Pricing: CJ does not provide a pricing API. Calculate
variants[].priceyourself (product cost + shipping + margin), in the currencypublishPriceCurrency. - Collect platform-specific data: see 0.6 Prerequisite APIs by platform.
- Submit: call
/listed/publishAsyncfor async platforms and/listed/publishSyncfor sync platforms. - Get the result (async only): poll
/listed/queryPublishStatusno more often than every 5 seconds until the status isPRODUCT_SUCCESS/PRODUCT_FAIL/PRODUCT_CANCEL.- Success: read
platformProductUrl; - Failure: read
listedFailMessage, fix the parameters, then call/listed/republishor call/listed/publishAsyncagain.
- Success: read
# 0.4 Listing status
listedStatus returned by /listed/queryPublishStatus:
| Value | Meaning | Next step |
|---|---|---|
| PRODUCT_STAY | Waiting | Keep polling |
| PRODUCT_CENTRE | Listing in progress | Keep polling |
| PRODUCT_SUCCESS | Listed | Stop, read platformProductUrl |
| PRODUCT_FAIL | Failed | Stop, read listedFailMessage |
| PRODUCT_CANCEL | Cancelled | Stop |
# 0.5 Response format and common error codes
All APIs in this chapter return:
{
"success": true,
"code": 200,
"message": "Congratulation! Well done!",
"data": {}
}
| Field | Type | Description |
|---|---|---|
| success | boolean | Whether the call succeeded |
| code | int | 200 on success (with success=true); see the table below on failure. Prefer checking success |
| message | string | Message; the reason on failure |
| requestId | string | Request ID, may be empty |
| data | object | Response data, see each API |
When parameter validation fails (e.g. a required field is empty), the API returns HTTP 400 with the common Open API format:
{
"code": 1600300,
"result": false,
"message": "shopId must be not empty.",
"data": null,
"requestId": "323fda9d-3c94-41dc-a944-5cc1b8baf5b1"
}
Common error codes:
| code | Meaning |
|---|---|
| 400 | Wrong request parameter (e.g. queryPublishStatus without listedId or shopId + productId; batch query over 100 items) |
| 10001 | Store does not exist or does not belong to your account |
| 10003 | Store is not enabled or its authorization has expired; please re-authorize it in CJ |
| 10005 | Platform not supported; or sync/async API mismatch (the message tells you which API to use); or this API does not support the platform |
| 10030 | Shopee store was not authorized with "Auth Merchant"; please re-authorize before listing |
| 20001 | This product has already been listed to this store |
| 20005 | CJ product does not exist |
| 20006 | This product is being listed to this store; do not submit again (lock lasts about 15 minutes) |
| 20024 | Store is being transferred or has been transferred |
| 20053 | This product type cannot be listed (e.g. some supplier products) |
| 100004 | Listing failed; the message contains the reason (including platform errors and listing quota limits) |
| 600 | Shopify daily variant creation limit reached; please try again tomorrow |
| 1600300 | Parameter validation failed, see above |
| 1600200 | Too many requests. Listing APIs (publishAsync, publishSync, republish) allow at most 2 requests per second per account |
Platform-specific error codes are listed in 1.1 Async Listing and 1.2 Sync Listing. When the platform API itself returns an error, its code and message are passed through.
# 0.6 Prerequisite APIs by platform
| Platform | Listing API | Prerequisite APIs (suggested order) | Listing fields filled |
|---|---|---|---|
| Shopify | publishAsync | queryProductTypes (product type) → /product/listed/queryVendors (vendor) → /product/listed/getPlatformCategoryTree (collections; create one with addCategory) → /shop/location/queryList (locations) → publishWarehouseInventory (optional, listable stock) → queryShopAvailableProfiles (delivery profiles) | categoryId (product type), platformBrandId (vendor), collectionIds, locationIds, deliveryProfileId, enableLogisticsFee, taxable, tags |
| eBay | publishSync | queryCountryList (sites, currency) → ebay/queryPolicies (quota, business policies) → queryLogisticsList (shipping services) → /product/listed/getPlatformCategoryTree or getChildCategoryList (category) → getCategoryFeatureList (UPC/EAN/ISBN requirement) → getCategorySpecificsList (item specifics) | siteCode, shopCurrency, publishPriceCurrency, ebayPolicyVO, platformShippingService, platformShippingServiceType, categoryId, categoryParentIds, attributes, upc/ean/isbn, payEmail |
| Shopee | publishAsync | /product/listed/getPlatformCategoryTree (category) → publishProductLimit (title/image/variant limits) → publishLogisticsChannel (logistics channels) → getCategorySpecificsList → getAttributeValueList (searchable attribute values) | categoryId, productCategoryAttributes, logisticsChannelConfig, publishPriceCurrency |
| Lazada | publishAsync | queryCountryList (site / GSP countries for cross-border stores) → getChildCategoryList (with countryCode) → getCategorySpecificsList (with siteCode) → queryBrand | listType, ventures, siteCode, categoryId, attributes, sourceCurrencyCode/targetCurrencyCode, variant weight/length/width/height |
| TikTok / TikTok US / TikTok US Cross | publishAsync | queryBrand (needNoBrand=true) → getChildCategoryList → getCategorySpecificsList → getProductCertifications → US stores: publishWarehouseInventory | platformBrandId, categoryId, productCategoryAttributes, needUploadImgOptionName, variants[].options[].optionNameId/optionValueId, productCertificationList; US stores sourceCountryCode=US, defaultAreaId=2 |
| AliExpress | publishAsync | getChildCategoryList → getCategorySpecificsList → queryTemplateInfo (freight/service templates, units) → queryProductGroup → querySizeTemplate | freightTemplateId, promiseTemplateId, productUnitId, productGroupIdList, sizeChartId, isNewSizeChartTemple, marketImages, packageType/lotNum, reduceStrategy, hsCode |
| WooCommerce | publishAsync | getChildCategoryList (with version=2; create with addCategory) | categoryId, scoreList |
| Mercado | publishAsync | getChildCategoryList → getCategorySpecificsList → getListingType → getListingLimit (optional, quota) | sellPrice (required), listingTypeId, productCategoryAttributes |
| Temu | publishAsync | getChildCategoryList or categorySearch → getCategorySpecificsList → queryPublishInfoByCondition (site, shipment time, freight template, size chart, model, package) → queryPublishCJWarehouseList (bindable CJ warehouses) | siteCode, categoryId, categoryParentIds, productCategoryAttributes, deliveryTime (seconds), freightTemplateId, sizeChartIdList, skcImageDTOS, productModelList, warehouseConnectionNew, outerPackageDTO, productOrigin |
| Temu US Local | publishAsync | getChildCategoryList or recommendCategory → getCategorySpecificsList → queryPublishInfoByCondition | categoryId, categoryParentIds, productCategoryAttributes, deliveryTime (days), freightTemplateId |
| Rutter platforms (Etsy / BigCommerce / Squarespace / Magento / PrestaShop) | publishSync | queryShopInfo (currency) | Common fields + tags (required); at most 5 images; Etsy requires a description |
| Wix | publishSync | None | Common fields |
| Whop | publishAsync | None | Common fields (currency is always USD) |
| Nuvemshop | publishAsync | None | Common fields (tags optional) |
| AllValue | publishSync | None | Common fields |
| Shoplazza | publishSync | /product/listed/getPlatformCategoryTree (collections; create with addCategory) | options (required), productOptionNameList, collectionId |
# 0.7 Billing
Every API in this chapter (/listed/*, 30 in total) costs 10 points per call (see API points). Calls are billed even when they fail (validation errors, store not owned by the account, unsupported platform, listing failure, etc.) and points are not refunded. Polling queryPublishStatus is billed as well, so keep the recommended interval (≥ 5 seconds).
# 1 Listing
# 1.1 Async Listing(POST)
For Shopify, WooCommerce, Lazada, Shopee, TikTok (incl. US / US Cross), Whop, Nuvemshop, AliExpress, Mercado, Temu and Temu US Local. The API returns a listing record ID right away; listing runs in the background. Get the result with 1.3 Query Listing Result.
# URL
https://developers.cjdropshipping.com/api2.0/v1/listed/publishAsync
# CURL
curl --location --request POST 'https://developers.cjdropshipping.com/api2.0/v1/listed/publishAsync' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
"shopId": "1530000000000000001",
"productId": "2508050912341600900",
"productTitle": "Women Casual Loose Shirt Dress",
"variants": [
{"variantId": "2508050912341601000", "sku": "CJLQ123456701AZ", "price": 29.99,
"options": [{"optionName": "Color", "optionValue": "Grey"}, {"optionName": "Size", "optionValue": "M"}]}
]
}'
# Request parameters
Common fields (all platforms):
| Name | Type | Required | Description |
|---|---|---|---|
| shopId | string | Y | Store ID (id from /shop/getShops); must belong to your account and be enabled |
| productId | string | Y | CJ product ID (pid) |
| productTitle | string | Y | Product title. Some platforms limit its length, see below |
| productDescription | string | N | Description (HTML). CJ description is used if empty |
| bigImg | string | N | Main image URL. CJ main image is used if empty |
| images | list<object> | N | Images [{"url": "https://..."}]. CJ images are used if empty |
| variants | list<object> | Y | Variants to list, 1–200 (platforms have their own limits, e.g. Shopify/TikTok 100, Lazada 99). See "variants fields" |
| publishPriceCurrency | string | N | Currency of variants[].price, default USD. Converted to the store currency if different |
| logisticsWay | string | N | Shipping method name, logisticName from freight calculation. Saved in the product connection and used as the default shipping method for later orders |
| defaultAreaId | string | N | Ship-from warehouse area ID, default 1 (China); 2 for TikTok US stores |
| sourceCountry | string | N | Ship-from country name |
| sourceCountryCode | string | N | Ship-from country code, default CN; must be US for TikTok US stores |
| targetCountry | string | N | Destination country name |
| targetCountryCode | string | N | Destination country code, from getReceiverCountryInfo |
| tags | string | N | Tags, comma separated |
| productOptionNameList | list<string> | N | Option names, e.g. ["Color","Size"]. CJ option names are used if empty; if passed, must match options[].optionName of every variant |
| options | list<object> | N | Option set [{"name": "Color", "values": ["Red","Blue"]}] (required for Shoplazza) |
| medias | list<object> | N | Product videos, see 1.6 Listing Request Objects |
| categoryId | string | Depends | Platform category ID; for Shopify it is the product type text |
| categoryName | string | N | Platform category name |
| categoryParentIds | list<string> | Depends | Parent category IDs along the path (eBay, Temu) |
| productCategoryAttributes | list<object> | Depends | Category attributes (TikTok / Temu / Shopee / Mercado / AliExpress), see 1.6 |
| attributes | list<object> | Depends | Attributes (eBay item specifics, Lazada attributes), see 1.6 |
| platformBrandId | string | N | Platform brand ID (brandId from queryBrand); for Shopify it is the vendor text |
| platformBrandName | string | N | Platform brand name |
variants fields:
| Name | Type | Required | Description |
|---|---|---|---|
| variantId | string | Y | CJ variant ID (vid), must belong to productId |
| price | number | Y | Store price, greater than 0, in publishPriceCurrency |
| sku | string | N | Platform variant SKU. CJ variant SKU is used if empty; must be unique. CJ connects platform variants to CJ variants by this SKU |
| variantTitle | string | N | Variant title |
| image | string | N | Variant image URL |
| weight | long | N | Weight (g) |
| length | long | Depends | Length (mm). Required for Lazada and Temu |
| width | long | Depends | Width (mm). Required for Lazada and Temu |
| height | long | Depends | Height (mm). Required for Lazada and Temu |
| inventoryCount | long | N | Listing stock. Most platforms recalculate it from actual CJ stock |
| options | list<object> | N | Option values [{"optionName": "Color", "optionValue": "Red"}]; CJ options are used if empty; combinations must be unique. TikTok / Temu also need optionNameId, optionValueId, see 1.6 |
| shippingCost | number | N | Shipping cost (USD) from freight calculation, counted in the store product cost |
| variantAttributes | list<object> | Depends | Variant-level attributes (Temu / Mercado), same structure as attributes |
Platform-specific fields:
Shopify
| Name | Type | Required | Description |
|---|---|---|---|
| categoryId | string | Y | Product type text, from queryProductTypes or your own value |
| platformBrandId | string | Y | Vendor text, from /product/listed/queryVendors or your own value (≤30 chars) |
| collectionIds | list<string> | N | Collection IDs from /product/listed/getPlatformCategoryTree or addCategory. Returns 20057 if not found |
| collectionId | string | N | A single collection ID, merged with collectionIds |
| taxable | boolean | N | Charge tax, default false |
| deliveryProfileId | string | Conditional | Delivery profile ID from queryShopAvailableProfiles. Required when it returns isNeedBindProfile = true |
| deliveryProfileName | string | N | Delivery profile name |
| locationIds | list<string> | N | Location IDs from /shop/location/queryList (locations with fromCj = true) |
| enableLogisticsFee | boolean | N | Whether the price includes shipping, default yes; when false, variant shippingCost is treated as 0 |
Shopee (CNSC stores must be authorized with "Auth Merchant", otherwise 10030)
| Name | Type | Required | Description |
|---|---|---|---|
| categoryId | string | Y | Leaf category ID (numeric) |
| productCategoryAttributes | list<object> | Required attributes | platformAttributeId is a numeric string; -1 means brand |
| logisticsChannelConfig | object | Y | Logistics channel config; channels[].platformLogisticChannelId comes from publishLogisticsChannel, see 1.6 |
Title, description, image count, variant count etc. must satisfy the limits from publishProductLimit; the description must be longer than 20 characters.
Lazada
| Name | Type | Required | Description |
|---|---|---|---|
| categoryId | string | Y | Leaf category ID (numeric) |
| listType | string | Cross-border stores | ASC / GSP, default ASC |
| siteCode | string | Required for ASC | Site: sg / my / id / th / ph / vn; use my for GSP |
| ventures | list<string> | Required for GSP | GSP countries, from queryCountryList |
| attributes | list<object> | N | Category attributes with variationSpecifics = false; No Brand is added if no brand is given |
| sourceCurrencyCode | string | N | Source currency |
| targetCurrencyCode | string | N | Target currency (SGD / MYR / IDR / THB / PHP / VND) |
| variants[].weight / length / width / height | long | Y | Weight (g) and dimensions (mm); sum of the three sides ≤ 3000 |
TikTok / TikTok US / TikTok US Cross
| Name | Type | Required | Description |
|---|---|---|---|
| categoryId | string | Y | Leaf category ID |
| platformBrandId | string | N | Brand ID from queryBrand |
| productCategoryAttributes | list<object> | Required attributes | From getCategorySpecificsList |
| needUploadImgOptionName | string | Recommended | The option name whose values get SKU images (only one, e.g. Color) |
| productCertificationList | list<object> | When the category requires it | From getProductCertifications, see 1.6; returns 20054 if missing |
| variants[].options[].optionNameId / optionValueId | string | Y | Platform option IDs; optionValueId is required when customized = false |
Title up to 255 characters (≤188 ASCII characters recommended); at most 9 main images. US stores must bind CJ warehouses in TikTok Shop Seller Center first, otherwise 10060.
AliExpress
| Name | Type | Required | Description |
|---|---|---|---|
| categoryId | string | Y | Leaf category ID (numeric) |
| productCategoryAttributes | list<object> | Required attributes | From getCategorySpecificsList |
| productOptionNameList | list<string> | Y | Sales attribute names |
| freightTemplateId | string | Y | Freight template ID (numeric) from queryTemplateInfo |
| promiseTemplateId | string | Y | Service template ID (numeric) from queryTemplateInfo |
| productUnitId | string | Y | Unit number, unitNumber from queryTemplateInfo |
| packageType | boolean | N | Sell by lot, default false |
| lotNum | int | Required when packageType=true | Pieces per lot, 2–100000 |
| reduceStrategy | string | N | Stock deduction: place_order_withhold (on order) / payment_success_deduct (on payment, default) |
| hsCode | string | N | HS code |
| photoGroupId | string | N | Photo bank group ID; empty for no group |
| productGroupIdList | list<string> | N | Product group IDs from queryProductGroup |
| sizeChartId | long | Size categories | Size chart ID from querySizeTemplate |
| isNewSizeChartTemple | boolean | N | Whether it is a new size chart template, from querySizeTemplate |
| marketImages | list<object> | Y | Marketing images, one square + one long, see 1.6 |
| logisticsWay | string | Y | Shipping method name, must be passed explicitly |
Price converted to USD must not exceed 100000; at most 256 SKU combinations.
Mercado
| Name | Type | Required | Description |
|---|---|---|---|
| categoryId | string | Y | Leaf category ID |
| sellPrice | string | Y | Selling price, same for all variants, within the category price range |
| listingTypeId | string | Y | Listing type ID from getListingType |
| productCategoryAttributes | list<object> | Required attributes | From getCategorySpecificsList |
At most 100 variants; total variant stock must not exceed the listing type maxStock; variant images at least 500×500.
Temu / Temu US Local
| Name | Type | Required | Description |
|---|---|---|---|
| categoryId | string | Y | Leaf category ID |
| categoryParentIds | list<string> | Y | Category IDs before the leaf, in level order |
| siteCode | string | Required for Temu | Site group ID, siteList[].id from queryPublishInfoByCondition (currently only 1, US) |
| productCategoryAttributes | list<object> | Required attributes | From getCategorySpecificsList |
| deliveryTime | string | Y | Shipment time: seconds for Temu (e.g. 86400, 172800), days for Temu US Local (1 or 2); use shipmentTimeList[].id |
| freightTemplateId | string | Y | Freight template ID, logisticsTemplateList[].id |
| skcImageDTOS | list<object> | Required for apparel | SKC images grouped by color, at least 3 per group, see 1.6 |
| sizeChartIdList | list<long> | Depends on category | Size chart IDs, sizeCharts[].businessId (required for apparel and shoes) |
| sizeChartGroupId | string | N | Size chart group ID |
| productModelList | list<object> | Depends on category | Model info, required when queryPublishInfoByCondition returns modelNecessary = true, see 1.6 |
| warehouseConnectionNew | object | When binding warehouses | Warehouse binding, see 1.6 |
| outerPackageDTO | object | N | Outer package; packageShape / packageType are ids from packageShapeList / packageTypeList |
| productOrigin | string | N | Origin, e.g. CN |
| language | string | N | Language, default EN |
| platformSizeAttrId | string | N | Size attribute ID |
| platformSizeAttrParentSpecId | long | N | Size attribute parent spec ID |
For Temu non-apparel products images needs at least 3; variants of the same color must have the same price; variant length ≥ width ≥ height. Temu US Local prices are always USD and productOptionNameList has at most 2 names.
WooCommerce
| Name | Type | Required | Description |
|---|---|---|---|
| categoryId | string | N | Category ID (numeric) from getChildCategoryList (version = 2); uncategorized if empty |
| scoreList | list<long> | N | Also import CJ product reviews with these ratings (1–5), up to 100 reviews |
Whop / Nuvemshop: common fields only. Whop always uses USD, title ≤80 characters, at most 8 images.
# Request example (Shopify)
{
"shopId": "1530000000000000001",
"productId": "2508050912341600900",
"productTitle": "Women Casual Loose Shirt Dress",
"productDescription": "<p>Soft and breathable.</p>",
"bigImg": "https://cf.cjdropshipping.com/main.jpg",
"images": [
{"url": "https://cf.cjdropshipping.com/a.jpg"},
{"url": "https://cf.cjdropshipping.com/b.jpg"}
],
"defaultAreaId": "1",
"sourceCountry": "China",
"sourceCountryCode": "CN",
"targetCountry": "United States",
"targetCountryCode": "US",
"logisticsWay": "CJPacket Ordinary",
"publishPriceCurrency": "USD",
"tags": "dress,summer",
"taxable": false,
"categoryId": "Dresses",
"platformBrandId": "CJ Fashion",
"collectionIds": ["438700000001"],
"deliveryProfileId": "gid://shopify/DeliveryProfile/1234567",
"locationIds": ["gid://shopify/Location/7788"],
"enableLogisticsFee": true,
"productOptionNameList": ["Color", "Size"],
"variants": [
{
"variantId": "2508050912341601000",
"sku": "CJLQ123456701AZ",
"price": 29.99,
"shippingCost": 4.35,
"image": "https://cf.cjdropshipping.com/v1.jpg",
"options": [
{"optionName": "Color", "optionValue": "Grey"},
{"optionName": "Size", "optionValue": "M"}
]
},
{
"variantId": "2508050912341601001",
"sku": "CJLQ123456702AZ",
"price": 29.99,
"shippingCost": 4.35,
"image": "https://cf.cjdropshipping.com/v2.jpg",
"options": [
{"optionName": "Color", "optionValue": "Grey"},
{"optionName": "Size", "optionValue": "L"}
]
}
]
}
# Response
Success
{
"success": true,
"code": 200,
"message": "Congratulation! Well done!",
"data": "1840000000000000001"
}
Error
{
"success": false,
"code": 10005,
"message": "Listing to ebay stores must use /listed/publishSync",
"data": null
}
| Field | Type | Description |
|---|---|---|
| data | string | Listing record ID (listedId), used by 1.3 Query Listing Result and 1.5 Republish |
A non-empty data only means CJ has accepted the request; the final result comes from queryPublishStatus.
# Error codes (async platforms)
In addition to 0.5 common error codes:
| code | Platform | Meaning |
|---|---|---|
| 7001001 | Shopify | The store requires a delivery profile, but deliveryProfileId is empty or not found |
| 7001002 | Shopify | The delivery profile has been deleted in Shopify |
| 7001003 | Shopify | The delivery profile does not include the CJ location |
| 7001012 | Shopify | The delivery profile is merchant-owned and cannot be used by this store |
| 20018 | Shopify / TikTok | Invalid number of variants (over 100) |
| 20057 | Shopify | Collection does not exist in the store |
| 20065 | Shopify | All variants of a customized product lack customization details |
| 20017 | Several | Failed to upload images to the platform |
| 20014 | TikTok | Package weight out of range |
| 20015 | TikTok | Invalid option value (e.g. over 50 characters) |
| 20016 | TikTok | Price exceeds the platform range |
| 20054 | TikTok | Required certification not uploaded |
| 20058 | TikTok | Category does not exist |
| 10060 | TikTok US | CJ warehouse not bound in TikTok Shop Seller Center |
| 20023 | Lazada | More than 99 variants |
| 20034 | Shopee | No option whose values each map to a different variant image |
| 30020 | AliExpress | lotNum not between 2 and 100000 |
| 20033 | AliExpress | Invalid number of option values (e.g. over 256 combinations) |
| 100023 | Mercado | Image smaller than 500×500 |
| 20072 | Temu | Product is bound to EU sites; supplier self-shipped products are not supported |
| 6000022 | Temu | Temu warehouse binding failed |
| 60039 | Temu | Temu listing error; the message contains the reason |
# 1.2 Sync Listing(POST)
For eBay, Etsy, BigCommerce, Squarespace, Magento, PrestaShop, Wix, Shoplazza and AllValue. The listing is finished when the API returns; on success it returns the platform product URL, no polling needed.
# URL
https://developers.cjdropshipping.com/api2.0/v1/listed/publishSync
# CURL
curl --location --request POST 'https://developers.cjdropshipping.com/api2.0/v1/listed/publishSync' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
"shopId": "1723456789012345678",
"productId": "1F2A3B4C-0000-1111-2222-333344445555",
"productTitle": "Women Casual Loose Cotton T-Shirt",
"siteCode": "US",
"platformShippingService": "USPSPriority",
"platformShippingServiceType": "Flat",
"categoryId": "53159",
"variants": [
{"variantId": "V-001", "sku": "CJNSXZTX00001-Black-S", "price": 19.99, "inventoryCount": 10,
"options": [{"optionName": "Color", "optionValue": "Black"}, {"optionName": "Size", "optionValue": "S"}]}
]
}'
# Request parameters
Common fields (all platforms):
| Name | Type | Required | Description |
|---|---|---|---|
| shopId | string | Y | Store ID; must belong to your account and be enabled |
| productId | string | Y | CJ product ID (pid) |
| productTitle | string | Y | Product title. eBay and Wix: ≤80 characters; Shoplazza truncates beyond 255 |
| productDescription | string | Depends | Description (HTML). Required for Etsy; others use the CJ description if empty |
| bigImg | string | N | Main image URL |
| images | list<object> | N | Images [{"url": "https://..."}]. Rutter platforms: at most 5 |
| variants | list<object> | Y | Variants to list, 1–200; fields are the same as "variants fields" in 1.1 |
| publishPriceCurrency | string | N | Currency of variants[].price, default USD. For eBay use the site currency |
| logisticsWay | string | N | Shipping method name (logisticName from freight calculation) |
| defaultAreaId | string | N | Ship-from warehouse area ID, default 1 |
| sourceCountry | string | N | Ship-from country name |
| sourceCountryCode | string | N | Ship-from country code, default CN |
| targetCountry | string | N | Destination country name |
| targetCountryCode | string | N | Destination country code |
| tags | string | Depends | Tags, comma separated. Required for Rutter platforms; each Etsy tag ≤20 characters |
| productOptionNameList | list<string> | Depends | Option names, must match every variant's options[].optionName. Recommended for eBay and Shoplazza |
| options | list<object> | Depends | Option set [{"name": "Color", "values": ["Black"]}], required for Shoplazza |
| medias | list<object> | N | Product videos, see 1.6 |
| categoryId | string | Depends | Platform category ID (eBay: required, leaf category) |
| categoryName | string | N | Platform category name |
| categoryParentIds | list<string> | N | Parent category IDs |
| attributes | list<object> | Depends | eBay item specifics, see 1.6 |
| productCategoryAttributes | list<object> | N | Category attributes (usually not needed for sync platforms) |
| platformBrandId | string | N | Platform brand ID |
| platformBrandName | string | N | Platform brand name |
Platform-specific fields:
eBay
| Name | Type | Required | Description |
|---|---|---|---|
| siteCode | string | Y | eBay site, countryCode from queryCountryList (e.g. US, UK, Germany, Australia; not ISO country codes) |
| platformShippingServiceType | string | Y | Shipping service type, serviceType from queryLogisticsList (e.g. Flat) |
| shopCurrency | string | N | Site currency (e.g. GBP for UK) from queryCountryList; listing currency and price-conversion target. Defaults to the store currency. eBay only |
| platformShippingService | string | N | Shipping service, shippingService from queryLogisticsList |
| ebayPolicyVO | object | N | Business policies, ebayPolicy from ebay/queryPolicies; the first of each type is used and id must be numeric. See 1.6 |
| categoryId | string | Y | Leaf category ID of the site |
| categoryParentIds | list<string> | N | Parent category IDs |
| attributes | list<object> | Required specifics | Item specifics with variationSpecifics = false from getCategorySpecificsList; also pass Brand and MPN here |
| upc | string | When required | Required when upcEnabled = Required in getCategoryFeatureList |
| ean | string | When required | Does not apply if none |
| isbn | string | When required | Does not apply if none |
| brand | string | N | Brand (prefer attributes) |
| mpn | string | N | MPN (prefer attributes) |
| payEmail | string | N | PayPal email; when set, payment method is PayPal |
| variants[].inventoryCount | long | Y | Must be greater than 0 for every variant |
eBay option names ≤40 characters, option values ≤50 characters. If the category does not support multi-variation (singleSkuListing = true from getCategoryFeatureList / getChildCategoryList), each variant is listed as a separate listing, at most 10 variants per call; data is the URL of the first listing and message is Listed N of M variants. with failure details.
Shoplazza
| Name | Type | Required | Description |
|---|---|---|---|
| options | list<object> | Y | Option set aggregated from all variants |
| productOptionNameList | list<string> | Recommended | Option names |
| collectionId | string | N | Collection ID from /product/listed/getPlatformCategoryTree or addCategory; 20057 if not found |
Only the first 3 options of each variant are used.
Rutter platforms (Etsy / BigCommerce / Squarespace / Magento / PrestaShop)
| Name | Type | Required | Description |
|---|---|---|---|
| tags | string | Y | Tags, comma separated; each Etsy tag ≤20 characters |
| images | list<object> | N | At most 5, otherwise an error is returned |
| productDescription | string | Required for Etsy | HTML tags are removed |
| publishPriceCurrency | string | Recommended | Store currency, used for price conversion |
Wix / AllValue: common fields only. Wix allows at most 100 variants and an 80-character title.
# Request example (eBay)
{
"shopId": "1723456789012345678",
"productId": "1F2A3B4C-0000-1111-2222-333344445555",
"productTitle": "Women Casual Loose Cotton T-Shirt Short Sleeve Summer Top",
"productDescription": "<p>100% cotton.</p>",
"bigImg": "https://cf.cjdropshipping.com/main.jpg",
"images": [
{"url": "https://cf.cjdropshipping.com/1.jpg"},
{"url": "https://cf.cjdropshipping.com/2.jpg"}
],
"siteCode": "US",
"publishPriceCurrency": "USD",
"platformShippingService": "USPSPriority",
"platformShippingServiceType": "Flat",
"categoryId": "53159",
"categoryParentIds": ["11450", "15724", "53159"],
"productOptionNameList": ["Color", "Size"],
"attributes": [
{"attributeName": "Brand", "attributeValue": "Unbranded", "variationSpecifics": false},
{"attributeName": "Department", "attributeValue": "Women", "variationSpecifics": false},
{"attributeName": "Type", "attributeValue": "T-Shirt", "variationSpecifics": false}
],
"upc": "",
"ean": "Does not apply",
"isbn": "",
"ebayPolicyVO": {
"fulfillmentPolicies": [{"id": "245678901011", "name": "Ship 3 days"}],
"paymentPolicies": [{"id": "245678901012", "name": "Pay"}],
"returnPolicies": [{"id": "245678901013", "name": "30 days"}]
},
"defaultAreaId": "1",
"sourceCountryCode": "CN",
"targetCountryCode": "US",
"logisticsWay": "CJPacket Ordinary",
"variants": [
{
"variantId": "V-001",
"sku": "CJNSXZTX00001-Black-S",
"image": "https://cf.cjdropshipping.com/v1.jpg",
"weight": 200,
"price": 19.99,
"inventoryCount": 10,
"options": [
{"optionName": "Color", "optionValue": "Black"},
{"optionName": "Size", "optionValue": "S"}
]
},
{
"variantId": "V-002",
"sku": "CJNSXZTX00001-Black-M",
"image": "https://cf.cjdropshipping.com/v2.jpg",
"weight": 210,
"price": 19.99,
"inventoryCount": 10,
"options": [
{"optionName": "Color", "optionValue": "Black"},
{"optionName": "Size", "optionValue": "M"}
]
}
]
}
# Response
Success
{
"success": true,
"code": 200,
"message": "Congratulation! Well done!",
"data": "https://www.ebay.com/itm/123456789012"
}
Error
{
"success": false,
"code": 100004,
"message": "Create platform product failed [minInventory fail, actual=0]",
"data": null
}
| Field | Type | Description |
|---|---|---|
| data | string | Platform product URL |
| message | string | For eBay split listings, a summary such as Listed 2 of 3 variants. plus failed SKUs |
# Error codes (sync platforms)
In addition to 0.5 common error codes:
| code | Platform | Meaning |
|---|---|---|
| 100004 | eBay | Empty platformShippingServiceType, variant stock ≤0, empty or duplicate SKU, inconsistent options, eBay verification failure, etc.; the message has the reason |
| 60070 | eBay | Brand new items cannot be listed in this category; choose another category |
| 60071 | eBay | The category does not support multi-variation; select no more than 10 variants |
| 20009 | eBay, etc. | Platform product created but connecting it to the CJ product failed (the platform product was removed) |
| 20018 | Wix | More than 100 variants |
| 10016 | Wix | Store currency mismatch |
| 20057 | Shoplazza | Collection does not exist in the store |
| 20017 | Shoplazza, etc. | Failed to upload images to the platform |
# 1.3 Query Listing Result(POST)
Query the status of one listing record, by listedId or by shopId + productId (the latest listing of that product in that store).
# URL
https://developers.cjdropshipping.com/api2.0/v1/listed/queryPublishStatus
# CURL
curl --location --request POST 'https://developers.cjdropshipping.com/api2.0/v1/listed/queryPublishStatus' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
"listedId": "1840000000000000001"
}'
| Name | Type | Required | Description |
|---|---|---|---|
| listedId | string | One of | Listing record ID (data from publishAsync) |
| shopId | string | One of | Store ID, together with productId |
| productId | string | One of | CJ product ID, together with shopId |
# Response
{
"success": true,
"code": 200,
"message": "Congratulation! Well done!",
"data": {
"listedId": 1840000000000000001,
"cjProductId": "2508050912341600900",
"listedStatus": "PRODUCT_SUCCESS",
"listedFailMessage": null,
"platformProductUrl": "https://myshop.myshopify.com/products/women-casual-loose-shirt-dress",
"hasInventory": true
}
}
| Field | Type | Description |
|---|---|---|
| listedId | long | Listing record ID |
| cjProductId | string | CJ product ID |
| listedStatus | string | Listing status, see 0.4 Listing status |
| listedFailMessage | string | Failure reason (when PRODUCT_FAIL) |
| platformProductUrl | string | Platform product URL (when PRODUCT_SUCCESS) |
| hasInventory | boolean | TikTok US: whether all listed stock is non-zero; false means some variant has zero stock |
data is null if no record is found.
# 1.4 Batch Query Listing Results(POST)
Up to 100 items per call; more returns 400.
# URL
https://developers.cjdropshipping.com/api2.0/v1/listed/queryPublishStatusBatch
# CURL
curl --location --request POST 'https://developers.cjdropshipping.com/api2.0/v1/listed/queryPublishStatusBatch' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
"batch": [
{"listedId": "1840000000000000001"},
{"shopId": "1530000000000000001", "productId": "2508050912341600900"}
]
}'
| Name | Type | Required | Description |
|---|---|---|---|
| batch | list<object> | Y | 1–100 query items; each item has the same fields as 1.3 (listedId, or shopId + productId) |
# Response
data is an array; each element has the same fields as the 1.3 response.
{
"success": true,
"code": 200,
"message": "Congratulation! Well done!",
"data": [
{
"listedId": 1840000000000000001,
"cjProductId": "2508050912341600900",
"listedStatus": "PRODUCT_CENTRE",
"listedFailMessage": null,
"platformProductUrl": null,
"hasInventory": true
}
]
}
# 1.5 Republish(POST)
Republish a failed (PRODUCT_FAIL) record with its original parameters. Only for async platforms. To change parameters, call publishAsync again instead.
# URL
https://developers.cjdropshipping.com/api2.0/v1/listed/republish
# CURL
curl --location --request POST 'https://developers.cjdropshipping.com/api2.0/v1/listed/republish' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
"shopId": "1530000000000000001",
"listedProductId": 1840000000000000001
}'
| Name | Type | Required | Description |
|---|---|---|---|
| shopId | string | Y | Store ID |
| listedProductId | long | Y | Listing record ID (listedId) |
# Response
{
"success": true,
"code": 200,
"message": "Congratulation! Well done!",
"data": true
}
| Field | Type | Description |
|---|---|---|
| data | boolean | Whether it was resubmitted. Then poll with 1.3 |
# 1.6 Listing Request Objects
Structure of object fields in publishAsync / publishSync.
images[]
| Field | Type | Required | Description |
|---|---|---|---|
| url | string | Y | Image URL |
options[] (product-level option set)
| Field | Type | Description |
|---|---|---|
| name | string | Option name |
| values | list<string> | Option values |
variants[].options[] (variant option values)
| Field | Type | Required | Description |
|---|---|---|---|
| optionName | string | Y | Option name |
| optionValue | string | Y | Option value |
| optionNameId | string | Depends | Platform option name ID (required for TikTok and Temu; for TikTok -1 means product identifier code) |
| optionValueId | string | Depends | Platform option value ID (required when customized = false) |
| optionValueUnit | string | N | Option value unit |
| customized | boolean | N | Whether the value is custom, default true |
| spec | int | N | Sales attribute display order (AliExpress) |
medias[]
| Field | Type | Required | Description |
|---|---|---|---|
| mediaId | string | Y | CJ video ID |
| mediaTitle | string | N | Video title |
| mediaUrl | string | N | Video URL |
| mediaSize | long | N | Size (bytes) |
| width | long | N | Width (px) |
| height | long | N | Height (px) |
| mediaType | string | N | Type, default MAP4 (mp4) |
attributes[] / variants[].variantAttributes[]
| Field | Type | Description |
|---|---|---|
| attributeId | string | Attribute ID |
| attributeName | string | Attribute name |
| attributeType | string | Attribute type (e.g. normal for Lazada) |
| attributeValueId | string | Attribute value ID |
| attributeValue | string | Attribute value |
| attributeValueUnit | string | Attribute value unit |
| variationSpecifics | boolean | Whether it is a variation attribute. Use false for eBay / Lazada product attributes |
productCategoryAttributes[]
| Field | Type | Description |
|---|---|---|
| platformAttributeId | string | Platform attribute ID (id from getCategorySpecificsList) |
| platformAttributeName | string | Platform attribute name |
| attributeValueList | list<object> | Values; pass several for multi-select |
| attributeValueList[].platformAttributeValueId | string | Platform value ID; omit for custom values |
| attributeValueList[].platformAttributeValue | string | Value or custom value (Shopee: pass the original value) |
| attributeValueList[].inputValue | string | Input value (e.g. material percentage) |
| attributeValueList[].platformAttributeValueUnit | string | Value unit |
ebayPolicyVO (eBay)
| Field | Type | Description |
|---|---|---|
| fulfillmentPolicies | list<object> | Shipping policies [{"id": "...", "name": "..."}] |
| paymentPolicies | list<object> | Payment policies |
| returnPolicies | list<object> | Return policies |
logisticsChannelConfig (Shopee)
| Field | Type | Description |
|---|---|---|
| channels | list<object> | Logistics channels |
| channels[].platformLogisticChannelId | string | Channel ID (logisticsChannelId from publishLogisticsChannel) |
| channels[].platformSizeId | string | Size ID, required when the channel feeType = SIZE_SELECTION |
| channels[].shippingFee | number | Shipping fee, required when feeType = CUSTOM_PRICE |
| channels[].shippingFeeForBuyer | boolean | Whether the buyer pays shipping |
| channels[].enabled | boolean | Enabled, default true |
productCertificationList[] (TikTok)
| Field | Type | Description |
|---|---|---|
| platformCertificationId | string | Platform certification ID (id from getProductCertifications) |
| platformCertificationName | string | Platform certification name |
| cjCertificationId | string | CJ certification ID (numeric string); CJ fills in the certification files from it |
| fileFormatType | int | File format type |
| imageUrls | list<string> | Certification image URLs |
| productCertificationFileDTOS | list<object> | Certification files [{"url": "...", "name": "..."}] |
marketImages[] (AliExpress)
| Field | Type | Description |
|---|---|---|
| imageType | int | 2 square (1:1, 800×800 suggested); 1 long (3:4, 750×1000 suggested); ≤5MB each |
| url | string | Image URL |
skcImageDTOS[] (Temu)
| Field | Type | Description |
|---|---|---|
| valueId | string | Color value ID |
| value | string | Color value |
| imageUrls | list<string> | Images of this color, 3:4, 3 to 10 images |
outerPackageDTO (Temu)
| Field | Type | Description |
|---|---|---|
| packageShape | int | Package shape, packageShapeList[].id from queryPublishInfoByCondition |
| packageType | int | Package type, packageTypeList[].id |
productModelList[] (Temu)
| Field | Type | Description |
|---|---|---|
| modelId | long | Model ID (modelInfoPageResult.list[].id) |
| tryOnSizeId | string | Try-on size (must be one of the selected variant sizes) |
| tryOnSizeName | string | Try-on size name |
| tryOnSizeSpecId | long | Try-on size spec ID |
| tryOnResult | int | Fit: 1 comfortable, 2 tight, 3 loose |
| modelType | int | Model type: 1 clothing model, 2 shoe model |
| modelName | string | Model name |
| modelProfileUrl | string | Model avatar |
| modelFeature | int | Model feature: 1 real model |
| modelHeight / modelBust / modelWaist / modelHip | string | Height / bust / waist / hip (empty for shoe models) |
| modelFootLength / modelFootWidth | string | Foot length / width (empty for clothing models) |
warehouseConnectionNew (Temu, binds warehouses while listing; can only bind to the store being listed)
| Field | Type | Description |
|---|---|---|
| syncInventory | int | Stock sync: 0 none, 1 CJ stock, 3 private stock, 5 private first then CJ |
| syncFrequency | int | Frequency: 1 real time, 3 every 6 h, 5 every 12 h, 7 every 24 h |
| multiWarehouse | int | Multi-warehouse per product: 0 no, 1 yes |
| y1SyncInventory | int | Stock sync for Y1 (US local warehouse), same values as syncInventory |
| y2SyncInventory | int | Stock sync for Y2 (transit warehouse), same values as syncInventory |
| warehouseConnectionNewVOS | list<object> | Warehouse mappings |
| warehouseConnectionNewVOS[].platformWarehouseId | string | Platform warehouse ID (warehouseInfoList[].warehouseId from queryPublishInfoByCondition) |
| warehouseConnectionNewVOS[].platformWarehouseName | string | Platform warehouse name |
| warehouseConnectionNewVOS[].managementType | string | Platform warehouse type |
| warehouseConnectionNewVOS[].cjWarehouseId | string | CJ warehouse ID (warehouseList[].id from queryPublishCJWarehouseList) |
| warehouseConnectionNewVOS[].cjWarehouseName | string | CJ warehouse name |
| warehouseConnectionNewVOS[].cjWarehouseType | int | CJ warehouse type |
| warehouseConnectionNewVOS[].areaId | string | Warehouse area ID |
| warehouseConnectionNewVOS[].countryCode | string | Country code |
# 2 Category / Attribute / Brand
# 2.1 Get Child Categories(POST)
Browse platform categories level by level: pass parentCategoryId = 0 for top-level categories, then drill down with the returned categoryId until leafCategory = true. Works for eBay, Lazada, TikTok, AliExpress, WooCommerce, Mercado, Temu, Temu US Local, etc.
# URL
https://developers.cjdropshipping.com/api2.0/v1/listed/getChildCategoryList
# CURL
curl --location --request POST 'https://developers.cjdropshipping.com/api2.0/v1/listed/getChildCategoryList' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
"shopId": "1723456789012345678",
"parentCategoryId": "0",
"countryCode": "US"
}'
| Name | Type | Required | Description |
|---|---|---|---|
| shopId | string | Y | Store ID |
| parentCategoryId | string | Y | Parent category ID; 0 for top level |
| countryCode | string | Depends | Site: eBay siteCode; Lazada cross-border site |
| cjProductId | string | N | CJ product ID |
| title | string | N | Product title |
| pageNum | int | N | Page number, default 1 |
| refreshCategory | int | N | Refresh category cache (WooCommerce): 1 current parent; 2 with parentCategoryId = 0 whole store |
| version | int | Depends | Version; 2 for WooCommerce |
| language | string | N | Language |
# Response
{
"success": true,
"code": 200,
"message": "Congratulation! Well done!",
"data": [
{
"shopId": "1723456789012345678",
"categoryParentId": "0",
"categoryId": "11450",
"categoryName": "Clothing, Shoes & Accessories",
"categoryLevel": 1,
"leafCategory": false,
"has_children": true,
"singleSkuListing": false
}
]
}
data is an array of categories (CategoryVO, also returned by 2.2, 2.3, 2.4):
| Field | Type | Description |
|---|---|---|
| shopId | string | Store ID |
| categoryParentId | string | Parent category ID |
| categoryId | string | Category ID |
| categoryName | string | Category name |
| categoryLevel | int | Level (Shopify collections: 0 custom, 1 smart) |
| leafCategory | boolean | Whether it is a leaf (Lazada: products can be added) |
| has_children | boolean | Whether it has children (note the snake_case name) |
| children | list<object> | Children, same structure |
| categoryType | int | Whether it is an apparel category |
| matchingCjCategoryIds | list<string> | Matched CJ category IDs |
| defaultMatching | boolean | Whether it is the default match |
| matchedPlatformCategoryIds | list<string> | Recommended category path (top level to leaf) |
| singleSkuListing | boolean | eBay: the category does not support multi-variation; each variant is listed separately |
| categorySettingVO | object | Category settings (Mercado, etc.): maxTitleLength, minimumPrice / maximumPrice, maxPicturesPerItem, maxVariationsAllowed, currencies, etc. |
# 2.2 Search Categories(POST)
Search platform categories by keyword. Temu only.
# URL
https://developers.cjdropshipping.com/api2.0/v1/listed/categorySearch
# CURL
curl --location --request POST 'https://developers.cjdropshipping.com/api2.0/v1/listed/categorySearch' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
"shopId": "1600000000000000001",
"searchText": "dress"
}'
| Name | Type | Required | Description |
|---|---|---|---|
| shopId | string | Y | Temu store ID |
| searchText | string | Y | Keyword |
# Response
{
"success": true,
"code": 200,
"message": "Congratulation! Well done!",
"data": {
"categoryList": [
[
{"categoryId": "100", "categoryName": "Women's Clothing", "leafCategory": false},
{"categoryId": "1001", "categoryName": "Dresses", "leafCategory": true}
]
]
}
}
| Field | Type | Description |
|---|---|---|
| categoryList | list<list<object>> | Results; each item is a category path from top level to leaf, elements are CategoryVO (see 2.1) |
# 2.3 Recommend Category(POST)
Recommend a platform category from the product title. Temu US Local only.
# URL
https://developers.cjdropshipping.com/api2.0/v1/listed/recommendCategory
# CURL
curl --location --request POST 'https://developers.cjdropshipping.com/api2.0/v1/listed/recommendCategory' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
"shopId": "1600000000000000002",
"title": "Women Casual Loose Shirt Dress"
}'
| Name | Type | Required | Description |
|---|---|---|---|
| shopId | string | Y | Temu US Local store ID |
| title | string | Y | Product title |
| cjProductId | string | N | CJ product ID |
# Response
{
"success": true,
"code": 200,
"message": "Congratulation! Well done!",
"data": {
"categoryId": "1001",
"categoryName": "Dresses",
"matchedPlatformCategoryIds": ["100", "1001"]
}
}
data is a CategoryVO (see 2.1). matchedPlatformCategoryIds is the recommended path; the last one is the leaf (use as categoryId), the rest are categoryParentIds.
# 2.4 Create Category / Collection(POST)
Create a category in the store (collection for Shopify / Shoplazza, product category for WooCommerce).
# URL
https://developers.cjdropshipping.com/api2.0/v1/listed/addCategory
# CURL
curl --location --request POST 'https://developers.cjdropshipping.com/api2.0/v1/listed/addCategory' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
"shopId": "1530000000000000001",
"categoryName": "Summer Dresses",
"parentCategoryId": "0"
}'
| Name | Type | Required | Description |
|---|---|---|---|
| shopId | string | Y | Store ID |
| categoryName | string | Y | Category name |
| parentCategoryId | string | N | Parent category ID (WooCommerce sub-category); 0 for top level |
# Response
{
"success": true,
"code": 200,
"message": "Congratulation! Well done!",
"data": {
"categoryId": "438700000002",
"categoryName": "Summer Dresses"
}
}
data is the created category (CategoryVO, see 2.1).
# 2.5 Get Category Attributes(POST)
Get attributes of a platform category (eBay item specifics; TikTok / Temu / Shopee / Lazada / Mercado / AliExpress category attributes).
# URL
https://developers.cjdropshipping.com/api2.0/v1/listed/getCategorySpecificsList
# CURL
curl --location --request POST 'https://developers.cjdropshipping.com/api2.0/v1/listed/getCategorySpecificsList' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
"shopId": "1723456789012345678",
"categoryId": "53159",
"productId": "1F2A3B4C-0000-1111-2222-333344445555",
"siteCode": "US",
"parentCategoryIds": ["11450", "15724"]
}'
| Name | Type | Required | Description |
|---|---|---|---|
| shopId | string | Y | Store ID |
| categoryId | string | Y | Leaf category ID |
| productId | string | Y | CJ product to list, used to match variant options |
| parentCategoryIds | list<string> | Depends | Parent category IDs (required for Temu) |
| siteCode | string | Depends | Site (required for eBay and Lazada) |
| language | string | N | Language |
# Response
{
"success": true,
"code": 200,
"message": "Congratulation! Well done!",
"data": [
{
"id": "100000",
"name": "Department",
"label": "Department",
"type": "singleSelect",
"isRequired": true,
"variationSpecifics": false,
"isSupportCustomizedValue": true,
"maxInputValueNumber": 1,
"valueRecommendations": ["Women", "Men"],
"values": [{"id": "1", "value": "Women"}]
}
]
}
data is an array of attributes. Main fields:
| Field | Type | Description |
|---|---|---|
| id | string | Attribute ID (needed by TikTok, Temu, etc.), use as platformAttributeId |
| name | string | Attribute name |
| label | string | Display name |
| type | string | Input type: text, richText, enumInput, multiEnum, InputmultiSelect, singleSelect, numeric, date |
| isRequired | boolean | Required or not |
| variationSpecifics | boolean | Whether it is a variation attribute |
| variationAttribute | boolean | Whether it is a variant-level attribute (Temu / Mercado, goes to variants[].variantAttributes) |
| formatType | string | NORMAL / QUANTITATIVE |
| inputValidationType | string | INT_TYPE / STRING_TYPE / ENUM_TYPE / FLOAT_TYPE / DATE_TYPE / TIMESTAMP_TYPE |
| inputType | string | Text input format (AliExpress): STRING / NUMBER |
| dateFormatType | string | YEAR_MONTH_DATE / YEAR_MONTH |
| maxInputValueNumber | int | Max number of values |
| unit | string | Value unit |
| units | list<string> | Available units (Shopee) |
| allowedUnits | list<object> | Available units [{id, name}] |
| valueRecommendations | list<string> | Recommended values |
| values | list<object> | Options, structure see 2.6 |
| value | string | Default value |
| selectionMode | string | Selection mode |
| isDuplicate | boolean | Whether duplicate values are allowed |
| isSupportCustomizedValue | boolean | Whether custom values are allowed |
| supportEnumInput | boolean | Whether "type or choose from list" is supported |
| supportSearchValue | boolean | Whether values are searchable (Shopee; use 2.6 when true) |
| mandatoryRegion | list<string> | Regions where it is required (Shopee) |
| isOem | boolean | Whether it is an OEM attribute (Shopee) |
| isCanMountPictures | boolean | Whether images can be attached (TikTok) |
| spec | int | Sales attribute display order |
| valueMaxLength | int | Max input length |
| maxValue | string | Max input value (Temu) |
| valuePrecision | int | Allowed decimal places; 0 means no decimals |
| mainSale | boolean | Whether it is the main sales attribute |
| templatePid / refPid / pid / parentSpecId / parentTemplatePid | long | Temu attribute template IDs |
| showType / valueRule / controlType / feature | int | Temu display and input rules |
| chooseTitle / inputTitle | string | Dropdown / input box title |
| platformName / platformUnit | string | Original platform name / unit |
| variantSpecificsVOS | list<object> | Matching between CJ variant options and platform options: vid, optionName, optionNameId, optionValue, optionValueId, optionParentSpecId, optionSpecId, etc. |
# 2.6 Search Attribute Values(POST)
Search values of a category attribute, for Shopee attributes with supportSearchValue = true.
# URL
https://developers.cjdropshipping.com/api2.0/v1/listed/getAttributeValueList
# CURL
curl --location --request POST 'https://developers.cjdropshipping.com/api2.0/v1/listed/getAttributeValueList' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
"shopId": "1700000000000000001",
"categoryId": "100017",
"attributeId": "100000",
"searchValue": "cotton",
"pageNum": 1,
"pageSize": 20
}'
| Name | Type | Required | Description |
|---|---|---|---|
| shopId | string | Y | Store ID |
| categoryId | string | Y | Platform category ID |
| attributeId | string | Y | Platform attribute ID |
| searchValue | string | N | Keyword; returns the first page of default values if empty |
| language | string | N | Language |
| pageNum | long | N | Page number, default 1 |
| pageSize | long | N | Page size, default 20 |
# Response
{
"success": true,
"code": 200,
"message": "Congratulation! Well done!",
"data": {
"pageNum": 1,
"pageSize": 20,
"total": 1,
"list": [
{"id": "6789", "value": "Cotton", "originalValue": "Cotton"}
]
}
}
| Field | Type | Description |
|---|---|---|
| pageNum / pageSize / total | long | Page number / page size / total |
| list[].id | string | Value ID |
| list[].value | string | Value |
| list[].originalValue | string | Original value (pass this one for Shopee) |
| list[].valueUnit | string | Value unit |
| list[].parentId | string | Parent attribute ID |
| list[].specId | long | Spec ID |
| list[].parentVidList | list<long> | Parent value IDs |
| list[].brandId | long | Brand ID |
| list[].extendInfo | string | Extra info |
| list[].group | object | Size group {id, name, values} |
| list[].subCategorySpecifics | list<object> | Linked sub-attributes, same structure as 2.5 |
# 2.7 Get Category Features(POST)
Get eBay category requirements for UPC / EAN / ISBN and whether multi-variation is supported. eBay only.
# URL
https://developers.cjdropshipping.com/api2.0/v1/listed/getCategoryFeatureList
# CURL
curl --location --request POST 'https://developers.cjdropshipping.com/api2.0/v1/listed/getCategoryFeatureList' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
"shopId": "1723456789012345678",
"categoryId": "53159",
"siteCode": "US"
}'
| Name | Type | Required | Description |
|---|---|---|---|
| shopId | string | Y | eBay store ID |
| categoryId | string | Y | Leaf category ID |
| siteCode | string | Y | Site |
# Response
{
"success": true,
"code": 200,
"message": "Congratulation! Well done!",
"data": [
{
"upcEnabled": "Disabled",
"eanEnabled": "Required",
"isbnEnabled": "Disabled",
"isBrandMPNIEnabled": false,
"isVariant": true,
"singleSkuListing": false
}
]
}
| Field | Type | Description |
|---|---|---|
| upcEnabled | string | UPC requirement; Required means required |
| eanEnabled | string | EAN requirement; Required means required |
| isbnEnabled | string | ISBN requirement; Required means required |
| isBrandMPNIEnabled | boolean | Whether GTIN or Brand + MPN is required |
| isVariant | boolean | Whether the category supports multi-variation |
| singleSkuListing | boolean | Whether variants are listed separately (max 10 variants per call) |
# 2.8 Get Category Certifications(POST)
Get the product certifications required by a TikTok category.
# URL
https://developers.cjdropshipping.com/api2.0/v1/listed/getProductCertifications
# CURL
curl --location --request POST 'https://developers.cjdropshipping.com/api2.0/v1/listed/getProductCertifications' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
"shopId": "1800000000000000001",
"categoryId": "601226",
"productId": "2508050912341600900"
}'
| Name | Type | Required | Description |
|---|---|---|---|
| shopId | string | Y | TikTok store ID |
| categoryId | string | Y | Leaf category ID |
| productId | string | Y | CJ product ID |
# Response
{
"success": true,
"code": 200,
"message": "Congratulation! Well done!",
"data": [
{
"id": "7000000000000000001",
"name": "CE Certificate",
"isBindCj": true,
"isApply": false,
"sampleImageUrl": "https://example.com/sample.jpg"
}
]
}
| Field | Type | Description |
|---|---|---|
| id | string | Platform certification ID, use as productCertificationList[].platformCertificationId |
| name | string | Certification name |
| isBindCj | boolean | Whether it matches a CJ certification |
| isApply | boolean | Whether an application has been submitted |
| sampleImageUrl | string | TikTok sample image |
# 2.9 Query Brands(POST)
Query platform brands, for TikTok, Lazada and AliExpress.
# URL
https://developers.cjdropshipping.com/api2.0/v1/listed/queryBrand
# CURL
curl --location --request POST 'https://developers.cjdropshipping.com/api2.0/v1/listed/queryBrand' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
"shopId": "1800000000000000001",
"needNoBrand": true,
"pageNum": 1,
"pageSize": 10
}'
| Name | Type | Required | Description |
|---|---|---|---|
| shopId | string | Y | Store ID |
| countryCode | string | N | Country / site code |
| categoryId | string | N | Category ID |
| needNoBrand | boolean | N | Include the "No brand" option, default false |
| language | string | N | Language |
| pageNum | long | N | Page number, default 1 |
| pageSize | long | N | Page size, default 10 |
# Response
{
"success": true,
"code": 200,
"message": "Congratulation! Well done!",
"data": [
{"brandId": "7082000000000000001", "brandName": "No brand", "value": "No brand"}
]
}
| Field | Type | Description |
|---|---|---|
| brandId | string | Brand ID, use as platformBrandId |
| brandName | string | Brand name |
| value | string | Brand name (deprecated, use brandName) |
# 2.10 Query Product Types(POST)
Query existing Shopify product types of the store. Shopify only.
# URL
https://developers.cjdropshipping.com/api2.0/v1/listed/queryProductTypes
# CURL
curl --location --request POST 'https://developers.cjdropshipping.com/api2.0/v1/listed/queryProductTypes' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
"shopId": "1530000000000000001"
}'
| Name | Type | Required | Description |
|---|---|---|---|
| shopId | string | Y | Shopify store ID |
# Response
{
"success": true,
"code": 200,
"message": "Congratulation! Well done!",
"data": [
{"product_type": "Dresses", "categoryId": null, "type": null}
]
}
| Field | Type | Description |
|---|---|---|
| product_type | string | Product type name, use as categoryId when listing |
| categoryId | string | Category ID |
| type | string | Type |
# 3 Store / Site / Shipping / Templates
# 3.1 Query Store Listing Info(POST)
Get the store currency, quota and other listing info. With productId, it also checks whether the product is already listed to this store (20001 if so).
# URL
https://developers.cjdropshipping.com/api2.0/v1/listed/queryShopInfo
# CURL
curl --location --request POST 'https://developers.cjdropshipping.com/api2.0/v1/listed/queryShopInfo' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
"shopId": "1530000000000000001",
"productId": "2508050912341600900"
}'
| Name | Type | Required | Description |
|---|---|---|---|
| shopId | string | Y | Store ID |
| productId | string | N | CJ product ID; checks whether it is already listed |
| shopStatus | int | N | Store status, default 1 (enabled) |
# Response
{
"success": true,
"code": 200,
"message": "Congratulation! Well done!",
"data": [
{
"shopId": "1530000000000000001",
"shopName": "myshop",
"aliasName": "My Shop",
"type": "shopify",
"shopStatusCode": 1,
"isCb": true,
"country": {"countryCode": "US", "countryName": "United States"},
"defaultCurrency": "USD",
"symbol": "$",
"amountLimit": 0,
"platformLogoUrl": "https://example.com/shopify.png",
"businessType": 0
}
]
}
| Field | Type | Description |
|---|---|---|
| shopId | string | Store ID |
| shopName | string | Store name |
| aliasName | string | Store alias |
| type | string | Platform type |
| shopStatusCode | int | Store status code: 1 enabled |
| shopStatus | string | Store status enum |
| isCb | boolean | Whether it is a cross-border store |
| country | object | Store country {countryCode, countryName} |
| countries | list<object> | Site countries of the store |
| defaultCurrency | string | Store currency, suggested as publishPriceCurrency |
| symbol | string | Currency symbol |
| amountLimit | number | Minimum price (Etsy) |
| etsyV3 | boolean | Whether it is an Etsy V3 store |
| platformLogoUrl | string | Platform logo |
| businessType | int | Platform type: 0 ERP, 1 cross-border |
| MarketplaceId | string | Site info (Temu); note the capital M |
| lastListedShopId | string | Store ID of the last listing |
| sourceCountryCode | string | Destination country chosen in the last listing |
| logisticsName | string | Shipping method chosen in the last listing |
| areaId | int | Warehouse chosen in the last listing |
# 3.2 Query Listing Sites(POST)
Get the sites / countries and currencies the store can list to, for eBay, Lazada, Shopee and Temu. The platform is taken from the store.
# URL
https://developers.cjdropshipping.com/api2.0/v1/listed/queryCountryList
# CURL
curl --location --request POST 'https://developers.cjdropshipping.com/api2.0/v1/listed/queryCountryList' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
"shopId": "1723456789012345678"
}'
| Name | Type | Required | Description |
|---|---|---|---|
| shopId | string | Y | Store ID |
# Response
{
"success": true,
"code": 200,
"message": "Congratulation! Well done!",
"data": [
{
"countryCode": "US",
"countryName": "United States",
"registeredCountry": true,
"currencyList": [{"currencyCode": "USD", "currencySymbol": "$"}]
}
]
}
| Field | Type | Description |
|---|---|---|
| countryCode | string | Site / country code. For eBay it is the site value (e.g. US, UK, Germany), use as siteCode; for Lazada GSP use in ventures |
| countryName | string | Name |
| registeredCountry | boolean | Whether it is the registered site (default site) |
| currencyList | list<object> | Site currencies [{currencyCode, currencySymbol}]; for eBay use the first one as publishPriceCurrency |
# 3.3 Query eBay Quota and Business Policies(POST)
Get the eBay listing quota and shipping / payment / return business policies. eBay only.
# URL
https://developers.cjdropshipping.com/api2.0/v1/listed/ebay/queryPolicies
# CURL
curl --location --request POST 'https://developers.cjdropshipping.com/api2.0/v1/listed/ebay/queryPolicies' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
"shopId": "1723456789012345678",
"siteCode": "US"
}'
| Name | Type | Required | Description |
|---|---|---|---|
| shopId | string | Y | eBay store ID |
| siteCode | string | Y | eBay site (e.g. US, UK, Germany), from 3.2 |
# Response
{
"success": true,
"code": 200,
"message": "Congratulation! Well done!",
"data": {
"quantityLimit": 100,
"amountLimit": 5000.00,
"currency": "USD",
"currencySymbol": "$",
"ebayPolicy": {
"fulfillmentPolicies": [{"id": "245678901011", "name": "Ship 3 days"}],
"paymentPolicies": [{"id": "245678901012", "name": "Pay"}],
"returnPolicies": [{"id": "245678901013", "name": "30 days"}]
}
}
}
| Field | Type | Description |
|---|---|---|
| quantityLimit | long | Remaining quantity quota |
| amountLimit | number | Remaining amount quota |
| currency | string | Quota currency |
| currencySymbol | string | Currency symbol |
| ebayPolicy | object | Business policies; can be passed as ebayPolicyVO directly. See 1.6 |
# 3.4 Query eBay Shipping Services(POST)
Get the shipping services available on an eBay site. eBay only (platform taken from the store).
# URL
https://developers.cjdropshipping.com/api2.0/v1/listed/queryLogisticsList
# CURL
curl --location --request POST 'https://developers.cjdropshipping.com/api2.0/v1/listed/queryLogisticsList' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
"shopId": "1723456789012345678",
"siteCode": "US"
}'
| Name | Type | Required | Description |
|---|---|---|---|
| shopId | string | Y | eBay store ID |
| siteCode | string | Y | eBay site |
# Response
{
"success": true,
"code": 200,
"message": "Congratulation! Well done!",
"data": [
{
"shippingService": "USPSPriority",
"serviceType": "Flat",
"shippingDescription": "USPS Priority Mail"
}
]
}
| Field | Type | Description |
|---|---|---|
| shippingService | string | Shipping service, use as platformShippingService |
| serviceType | string | Shipping service type, use as platformShippingServiceType (required) |
| shippingDescription | string | Description |
# 3.5 Query Listing Limits(POST)
Get Shopee limits on title, description, images, variants, price, stock, etc.
# URL
https://developers.cjdropshipping.com/api2.0/v1/listed/publishProductLimit
# CURL
curl --location --request POST 'https://developers.cjdropshipping.com/api2.0/v1/listed/publishProductLimit' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
"shopId": "1700000000000000001",
"cjProductId": "2508050912341600900"
}'
| Name | Type | Required | Description |
|---|---|---|---|
| shopId | string | Y | Shopee store ID |
| cjProductId | string | N | CJ product ID |
| categoryId | string | N | Platform category ID |
| forceFlush | boolean | N | Force refresh the cache |
# Response
{
"success": true,
"code": 200,
"message": "Congratulation! Well done!",
"data": {
"shopId": "1700000000000000001",
"cjProductId": "2508050912341600900",
"productNameLength": {"minLimit": 10, "maxLimit": 120},
"productDescriptionLength": {"minLimit": 20, "maxLimit": 3000},
"productImageCount": {"minLimit": 1, "maxLimit": 9},
"variantNameLength": {"minLimit": 1, "maxLimit": 14},
"variantOptionLength": {"minLimit": 1, "maxLimit": 30},
"price": {"minLimit": 0.1, "maxLimit": 100000},
"stock": {"minLimit": 1, "maxLimit": 999999}
}
}
Each limit is {minLimit, maxLimit, value, isValid} (empty or 0 minLimit / maxLimit means no limit):
| Field | Description |
|---|---|
| productCount | Product count limit |
| productNameLength | Title length |
| productImageCount | Image count |
| productDescriptionLength | Description length |
| variantNameLength | Option name length |
| variantOptionLength | Option value length |
| price | Price range |
| wholesalePriceThresholdPercentage | Wholesale price as a percentage of the original price |
| stock | Stock range |
| descriptionTextLength / descriptionImageCount / descriptionImageWidth / descriptionImageHeight / descriptionImageAspectRatio | Extended description text length, image count, width, height, aspect ratio |
| textLengthMultiplier | Length factor for Chinese characters: length = Chinese length × factor + English length |
| extendedDescription | Extended description limit |
| dtsLimit | Days-to-ship: supportPreOrder, nonPreOrderDaysToShip, daysToShipLimit |
| weightLimit | Weight limit, weightMandatory whether required |
| dimensionLimit | Dimension limit, dimensionMandatory whether required |
| sizeChartLimit | Size chart: sizeChartMandatory, supportImageSizeChart, supportTemplateSizeChart |
# 3.6 Query Logistics Channels(POST)
Get the logistics channels of a Shopee store, used for logisticsChannelConfig.
# URL
https://developers.cjdropshipping.com/api2.0/v1/listed/publishLogisticsChannel
# CURL
curl --location --request POST 'https://developers.cjdropshipping.com/api2.0/v1/listed/publishLogisticsChannel' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
"shopId": "1700000000000000001",
"cjProductId": "2508050912341600900"
}'
| Name | Type | Required | Description |
|---|---|---|---|
| shopId | string | Y | Shopee store ID |
| cjProductId | string | N | CJ product ID |
| forceFlush | boolean | N | Force refresh the cache |
# Response
{
"success": true,
"code": 200,
"message": "Congratulation! Well done!",
"data": [
{
"logisticsChannelId": "18025",
"logisticsChannelName": "Standard Delivery",
"preferred": true,
"codEnabled": false,
"feeType": "SIZE_SELECTION",
"sizeList": [{"sizeId": "1", "name": "Small", "defaultPrice": 2.50}]
}
]
}
| Field | Type | Description |
|---|---|---|
| logisticsChannelId | string | Channel ID, use as channels[].platformLogisticChannelId |
| logisticsChannelName | string | Channel name |
| logisticsChannelDescription | string | Channel description |
| preferred | boolean | Preferred channel |
| codEnabled | boolean | Cash on delivery supported |
| feeType | string | Fee mode: SIZE_SELECTION (needs platformSizeId), SIZE_INPUT, FIXED_DEFAULT_PRICE, CUSTOM_PRICE (needs shippingFee) |
| sizeList | list<object> | Size fees [{sizeId, name, defaultPrice}] |
| weightLimit / volumeLimit / heightLimit / widthLimit / lengthLimit / dimensionSumLimit | object | Weight (g), volume (cm³), height / width / length (cm), sum of sides (cm) limits, {minLimit, maxLimit} |
| forceEnable | boolean | Force-enabled (seller cannot turn it off) |
| sellerLogisticHasConfiguration | boolean | Whether the seller channel is configured |
| logisticsDescription | string | Fulfillment channel of a checkout channel |
| logisticsCapability | object | Capability: sellerLogistics, directDelivery, spxInstant |
| supportCrossBorder | boolean | Cross-border supported |
| blockSellerCoverShippingFee | boolean | Seller cannot cover shipping fee |
| supportPreOrder | boolean | Pre-order supported |
# 3.7 Query Listable Inventory(POST)
Get listable stock of each CJ variant in each warehouse and whether it can be listed, for Shopify, TikTok US, etc.
# URL
https://developers.cjdropshipping.com/api2.0/v1/listed/publishWarehouseInventory
# CURL
curl --location --request POST 'https://developers.cjdropshipping.com/api2.0/v1/listed/publishWarehouseInventory' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
"shopId": "1530000000000000001",
"cjProductId": "2508050912341600900"
}'
| Name | Type | Required | Description |
|---|---|---|---|
| shopId | string | Y | Store ID |
| cjProductId | string | Y | CJ product ID |
| cjVariantIds | list<string> | N | Only these variants; all if empty |
# Response
{
"success": true,
"code": 200,
"message": "Congratulation! Well done!",
"data": {
"shopId": "1530000000000000001",
"shopType": "shopify",
"cjProductId": "2508050912341600900",
"canPublish": true,
"publishInventory": 1200,
"variantWarehouseInventories": [
{
"cjVariantId": "2508050912341601000",
"cjVariantSku": "CJLQ123456701AZ",
"canPublish": true,
"publishInventory": 600,
"inventories": [
{"cjWarehouseId": "CN", "cjWarehouseName": "China Warehouse", "publishInventory": 600,
"shopWarehouseId": "gid://shopify/Location/7788", "shopWarehouseName": "CJ Location"}
]
}
]
}
}
| Field | Type | Description |
|---|---|---|
| shopId / shopType | string | Store ID / platform |
| cjProductId / cjProductType | string | CJ product ID / product type |
| usInventoryUsers / onlyUsInventoryUsers | boolean | Uses US warehouse stock / uses only US warehouse stock |
| canPublish | boolean | Whether it can be listed |
| canNotPublishMessage | string | Why it cannot be listed |
| publishInventory | int | Total listable stock |
| variantWarehouseInventories[].cjVariantId / cjVariantSku | string | CJ variant ID / SKU |
| variantWarehouseInventories[].canPublish / canNotPublishMessage | boolean / string | Whether the variant can be listed and why not |
| variantWarehouseInventories[].publishInventory | int | Listable stock of the variant |
| variantWarehouseInventories[].inventories[] | list<object> | Per-warehouse stock: cjWarehouseId, cjWarehouseName, isCjSupplierWarehouse, isSelfPickup, publishInventory, shopWarehouseId, shopWarehouseName, shopGlobalWarehouseId, syncType, subType, cjPrivateQuantity (private), cjCommonQuantity (public), cjDepositQuantity (deposit) |
# 3.8 Query Available Delivery Profiles(POST)
Get the Shopify delivery profiles available for listing, and whether this listing must bind one. Shopify only.
# URL
https://developers.cjdropshipping.com/api2.0/v1/listed/queryShopAvailableProfiles
# CURL
curl --location --request POST 'https://developers.cjdropshipping.com/api2.0/v1/listed/queryShopAvailableProfiles' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
"shopId": "1530000000000000001",
"shopLocationIds": ["gid://shopify/Location/7788"],
"sources": "PUBLISH",
"collectionIds": ["438700000001"]
}'
| Name | Type | Required | Description |
|---|---|---|---|
| shopId | string | Y | Shopify store ID |
| shopLocationIds | list<string> | N | Locations chosen for this listing (locationIds); profiles must cover them |
| sources | string | N | Scenario: PUBLISH (listing, default) / CONNECTION (connection) |
| collectionIds | list<string> | N | Collections chosen for this listing |
| forceRefresh | boolean | N | Skip cache |
# Response
{
"success": true,
"code": 200,
"message": "Congratulation! Well done!",
"data": {
"isNeedBindProfile": true,
"notNeedBindProfileReasonCode": null,
"notNeedBindProfileReason": null,
"marketDrivenShipping": false,
"profiles": [
{
"id": "gid://shopify/DeliveryProfile/1234567",
"name": "CJ Shipping",
"hasZeroFeeRate": false,
"locations": [{"id": "gid://shopify/Location/7788", "name": "CJ Location", "fromCj": true}]
}
]
}
}
| Field | Type | Description |
|---|---|---|
| isNeedBindProfile | boolean | Whether a delivery profile must be bound. Only when false can deliveryProfileId be omitted |
| notNeedBindProfileReasonCode | string | Reason code when not needed |
| notNeedBindProfileReason | string | Reason (English, for troubleshooting) |
| marketDrivenShipping | boolean | Whether the store uses market-driven shipping (MDS); null if unknown |
| profiles[].id | string | Profile ID, use as deliveryProfileId |
| profiles[].name | string | Profile name |
| profiles[].hasZeroFeeRate | boolean | Whether the profile has a zero-fee rate |
| profiles[].locations[] | list<object> | Covered locations {id, name, fromCj} |
# 3.9 Query Freight / Service Templates and Units(POST)
AliExpress only.
# URL
https://developers.cjdropshipping.com/api2.0/v1/listed/queryTemplateInfo
# CURL
curl --location --request POST 'https://developers.cjdropshipping.com/api2.0/v1/listed/queryTemplateInfo' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
"shopId": "1900000000000000001",
"templateType": 0
}'
| Name | Type | Required | Description |
|---|---|---|---|
| shopId | string | Y | AliExpress store ID |
| templateType | int | N | 0 all (default), 1 freight templates, 2 service templates |
# Response
{
"success": true,
"code": 200,
"message": "Congratulation! Well done!",
"data": {
"freightTemplateList": [{"templateId": 1000001, "templateName": "Default", "isDefault": true}],
"promiseTemplateList": [{"id": 2000001, "name": "Service Template"}],
"productUnitList": [{"unitNumber": 100000015, "unit": "piece"}]
}
}
| Field | Type | Description |
|---|---|---|
| freightTemplateList[] | list<object> | Freight templates: templateId (use as freightTemplateId), templateName, isDefault |
| promiseTemplateList[] | list<object> | Service templates: id (use as promiseTemplateId), name |
| productUnitList[] | list<object> | Units: unitNumber (use as productUnitId), unit |
# 3.10 Query Size Chart Templates(POST)
AliExpress only.
# URL
https://developers.cjdropshipping.com/api2.0/v1/listed/querySizeTemplate
# CURL
curl --location --request POST 'https://developers.cjdropshipping.com/api2.0/v1/listed/querySizeTemplate' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
"shopId": "1900000000000000001",
"leafCategoryId": "200000346",
"currentPage": 1
}'
| Name | Type | Required | Description |
|---|---|---|---|
| shopId | string | Y | AliExpress store ID |
| leafCategoryId | string | Y | Leaf category ID |
| currentPage | long | N | Page number, from 1 |
# Response
{
"success": true,
"code": 200,
"message": "Congratulation! Well done!",
"data": {
"total": 1,
"sizePage": 20,
"currentPage": 1,
"isNewSizeChartTemple": false,
"sizeChartList": [
{"sizeChartId": 3000001, "modelName": "Women Tops", "categoryId": 200000346, "isDefault": "Y"}
]
}
}
| Field | Type | Description |
|---|---|---|
| total | long | Total records |
| sizePage | long | Max records per page |
| currentPage | long | Current page |
| isNewSizeChartTemple | boolean | Whether the category uses new size chart templates; pass it in the listing request |
| sizeChartList[].sizeChartId | long | Size chart ID, use as sizeChartId |
| sizeChartList[].modelName | string | Template name |
| sizeChartList[].categoryId | long | Leaf category of the template |
| sizeChartList[].isDefault | string | Default template (Y / N) |
# 3.11 Query Product Groups(POST)
AliExpress only.
# URL
https://developers.cjdropshipping.com/api2.0/v1/listed/queryProductGroup
# CURL
curl --location --request POST 'https://developers.cjdropshipping.com/api2.0/v1/listed/queryProductGroup' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
"shopId": "1900000000000000001"
}'
| Name | Type | Required | Description |
|---|---|---|---|
| shopId | string | Y | AliExpress store ID |
# Response
{
"success": true,
"code": 200,
"message": "Congratulation! Well done!",
"data": {
"productGroupList": [
{
"groupId": 500001,
"groupName": "Women",
"childGroupList": [{"groupId": 500011, "groupName": "Dresses"}]
}
]
}
}
| Field | Type | Description |
|---|---|---|
| productGroupList[].groupId | long | Group ID |
| productGroupList[].groupName | string | Group name |
| productGroupList[].childGroupList[] | list<object> | Sub-groups {groupId, groupName}. If a group has sub-groups, use the sub-group ID in productGroupIdList |
# 3.12 Query Listing Configuration(POST)
Get site, shipment time, freight templates, platform warehouses, size charts, models, outer package options, etc., for Temu, Temu US Local and Mercado.
# URL
https://developers.cjdropshipping.com/api2.0/v1/listed/queryPublishInfoByCondition
# CURL
curl --location --request POST 'https://developers.cjdropshipping.com/api2.0/v1/listed/queryPublishInfoByCondition' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
"shopId": "1600000000000000001",
"siteId": "1",
"categoryId": "1001",
"parentCategoryIds": ["100"],
"language": "EN"
}'
| Name | Type | Required | Description |
|---|---|---|---|
| shopId | string | Y | Store ID |
| siteId | string | N | Site ID. Without it, only basic info (sites, shipment time, package, warehouses) is returned; freight templates need it |
| categoryId | string | N | Leaf category ID; size charts and models need it |
| parentCategoryIds | list<string> | N | Parent category IDs |
| language | string | N | Language |
| queryOperationType | string | N | Query only one part: WAREHOUSE_INFO, LOGISTICS_TEMPLATE, SIZE_CHART_TEMPLATE, MODEL; all if empty |
| modelName | string | N | Model name (for the model list) |
| pageNo | long | N | Model list page number |
| pageSize | long | N | Model list page size |
# Response
{
"success": true,
"code": 200,
"message": "Congratulation! Well done!",
"data": {
"siteList": [{"id": "1", "name": "US"}],
"shipmentTimeList": [{"id": "86400", "name": "24"}, {"id": "172800", "name": "48"}],
"packageShapeList": [{"id": "0", "name": "Irregular"}],
"packageTypeList": [{"id": "0", "name": "Hard"}],
"logisticsTemplateList": [{"id": "LT001", "name": "Default"}],
"warehouseInfoList": [{"warehouseId": "WH001", "warehouseName": "US Warehouse", "warehouseDisable": false, "managementType": "0"}],
"sizeCharts": [],
"shoeCategory": false,
"suitCategory": false,
"needSizeCharts": false,
"modelNecessary": false,
"modelEnableCategory": false,
"modelType": 0,
"modelInfoPageResult": null
}
}
| Field | Type | Description |
|---|---|---|
| siteList | list<object> | Sites {id, name}; id is used as siteCode |
| shipmentTimeList | list<object> | Shipment time {id, name}; id is used as deliveryTime (seconds for Temu, days for Temu US Local) |
| logisticsTemplateList | list<object> | Freight templates {id, name}; id is used as freightTemplateId |
| packageShapeList / packageTypeList | list<object> | Package shape / type {id, name}, used in outerPackageDTO |
| warehouseInfoList | list<object> | Platform warehouses: warehouseId, warehouseName, warehouseDisable, managementType (0 third-party, 1 self-built, 2 home, 3 other) |
| siteWarehouseInfoList | list<object> | Warehouses grouped by site {siteId, siteName, warehouseInfoList} |
| sizeCharts | list<object> | Size charts {businessId, groups[{id, name, values}]}; businessId is used in sizeChartIdList |
| shoeCategory / suitCategory | boolean | Shoe / suit category (suits need 2 size charts) |
| needSizeCharts | boolean | Whether size charts are required |
| modelNecessary / modelEnableCategory | boolean | Whether a model is required / allowed for the category |
| modelType | int | Model type: 0 clothing, 1 shoes |
| modelInfoPageResult | object | Model page {pageNum, pageSize, total, list[]}; list[] has id, modelName, modelType, headPortrait, clothesModel{height, bust, waist, hipline}, shoeModel{footLength, footWidth} |
| importDesignationList | list<object> | Import designation {id, name} |
| fulfillmentTypeList | list<object> | Fulfillment channels {id, name} |
# 3.13 Query Bindable CJ Warehouses(POST)
Get the CJ warehouses and stock each variant can bind to when listing to Temu.
# URL
https://developers.cjdropshipping.com/api2.0/v1/listed/queryPublishCJWarehouseList
# CURL
curl --location --request POST 'https://developers.cjdropshipping.com/api2.0/v1/listed/queryPublishCJWarehouseList' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
"shopId": "1600000000000000001",
"productId": "2508050912341600900",
"countryCode": "US",
"deliveryTime": "172800"
}'
| Name | Type | Required | Description |
|---|---|---|---|
| shopId | string | Y | Temu store ID |
| productId | string | Y | CJ product ID |
| countryCode | string | N | Country code |
| deliveryTime | string | N | Shipment time (seconds), same as the listing request |
# Response
{
"success": true,
"code": 200,
"message": "Congratulation! Well done!",
"data": [
{
"productId": "2508050912341600900",
"cjVid": "2508050912341601000",
"warehouseList": [
{"id": "US-EAST-01", "areaId": "2", "countryCode": "US", "country": "United States",
"inventory": 120, "isSelfPickup": 0, "cjWarehouseType": 1, "status": 1}
]
}
]
}
| Field | Type | Description |
|---|---|---|
| productId | string | CJ product ID |
| cjVid | string | CJ variant ID |
| warehouseList[].id | string | CJ warehouse ID, use as warehouseConnectionNewVOS[].cjWarehouseId |
| warehouseList[].inventory | long | Warehouse stock |
| warehouseList[].areaId / region / regionCode | string | Warehouse area |
| warehouseList[].country / countryCode / state / city / district / town / zipcode / fullAddress | string | Warehouse address |
| warehouseList[].contactPerson / phone | string | Contact / phone |
| warehouseList[].status | int | Warehouse status |
| warehouseList[].isSelfPickup | int | Self pickup: 0 no, 1 yes |
| warehouseList[].managementType | string | Warehouse type |
| warehouseList[].cjWarehouseType | int | Whether it is a Y2 warehouse |
| warehouseList[].warehouseKey | string | Warehouse key |
# 3.14 Query Listing Types(POST)
Get the listing types available for a Mercado category.
# URL
https://developers.cjdropshipping.com/api2.0/v1/listed/getListingType
# CURL
curl --location --request POST 'https://developers.cjdropshipping.com/api2.0/v1/listed/getListingType' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
"shopId": "2000000000000000001",
"categoryId": "MLM1055"
}'
| Name | Type | Required | Description |
|---|---|---|---|
| shopId | string | Y | Mercado store ID |
| categoryId | string | Y | Leaf category ID |
| siteId | string | N | Site ID |
# Response
{
"success": true,
"code": 200,
"message": "Congratulation! Well done!",
"data": [
{"siteId": "MLM", "id": "gold_special", "name": "Classic", "maxStock": 9999}
]
}
| Field | Type | Description |
|---|---|---|
| siteId | string | Site ID |
| id | string | Listing type ID, use as listingTypeId |
| name | string | Name |
| maxStock | long | Max stock per product (total variant stock must not exceed it) |
# 3.15 Query Listing Quota(POST)
Get the listing quota of a Mercado store.
# URL
https://developers.cjdropshipping.com/api2.0/v1/listed/getListingLimit
# CURL
curl --location --request POST 'https://developers.cjdropshipping.com/api2.0/v1/listed/getListingLimit' \
--header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
"shopId": "2000000000000000001"
}'
| Name | Type | Required | Description |
|---|---|---|---|
| shopId | string | Y | Mercado store ID |
| siteId | string | N | Site ID |
# Response
{
"success": true,
"code": 200,
"message": "Congratulation! Well done!",
"data": {
"userId": 123456789,
"siteId": "MLM",
"logisticType": "remote",
"quota": 1000,
"totalItems": 120
}
}
| Field | Type | Description |
|---|---|---|
| userId | long | Platform user ID |
| siteId | string | Site ID |
| logisticType | string | Logistic type / status |
| quota | int | Max number of listings |
| totalItems | int | Number of listings so far |