### CJ Dropshipping API - Product Properties Example

Source: https://developers.cjdropshipping.cn/en/api/api2/api/shopping

Shows an example of product properties within the CJ Dropshipping API, including print dimensions, scaling, position, font size, and area details. This data is crucial for custom print-on-demand products.

```json
{
    "printHeight": "50",
    "scaleY": "1",
    "podType": "4",
    "top": "297.99999928474426",
    "areaName": "DIY",
    "left": "253.99999994039536",
    "areaType": "1",
    "imgicon": "",
    "angle": "0",
    "fontSize": 12,
    "fontSpace": 0,
    "sku": ""
}
```

--------------------------------

### Get Account Settings (CURL)

Source: https://developers.cjdropshipping.cn/en/api/api2/api/setting

This snippet demonstrates how to fetch account settings using a CURL command. It requires an 'CJ-Access-Token' for authentication and makes a GET request to the specified URL. The response includes details about quota limits, QPS limits, and callback configurations.

```shell
curl --location --request GET 'https://developers.cjdropshipping.com/api2.0/v1/setting/get' \
                --header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
```

--------------------------------

### GET /api2.0/v1/setting/get

Source: https://developers.cjdropshipping.cn/en/api/api2/api/setting

Retrieves account settings, including profile details, API quota limits, general API QPS limits, and sandbox account status.

```APIDOC
## GET /api2.0/v1/setting/get

### Description
Retrieves account settings, including profile details, API quota limits, general API QPS limits, and sandbox account status.

### Method
GET

### Endpoint
https://developers.cjdropshipping.com/api2.0/v1/setting/get

### Parameters
#### Headers
- **CJ-Access-Token** (string) - Required - Access token for authentication.

### Request Example
```
{
  "example": "curl --location --request GET 'https://developers.cjdropshipping.com/api2.0/v1/setting/get' \
                --header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'"
}
```

### Response
#### Success Response (200)
- **code** (int) - Response status code.
- **result** (boolean) - Indicates if the request was successful.
- **message** (string) - A message describing the result of the request.
- **data** (object) - Contains the account settings.
  - **openId** (string) - Account ID.
  - **openName** (string) - Account name.
  - **openEmail** (string) - Account Email.
  - **setting** (object) - General settings.
    - **quotaLimits** (list) - Quota limits for specific URLs.
      - **quotaUrl** (string) - The URL for which the quota limit applies.
      - **quotaLimit** (int) - The maximum allowed quota for the URL.
      - **quotaType** (byte) - The type of quota period (0-total, 1-per year, 2-per quarter, 3-per month, 4-per day, 5-per hour).
    - **qpsLimit** (int) - Account Queries per second limit.
  - **callback** (object) - Callback settings for product and order events.
    - **product** (object) - Product callback settings.
      - **type** (string) - Type of product callback (e.g., ENABLE, CANCEL).
      - **urls** (list) - List of URLs for product callbacks.
    - **order** (object) - Order callback settings.
      - **type** (string) - Type of order callback (e.g., ENABLE, CANCEL).
      - **urls** (list) - List of URLs for order callbacks.
  - **root** (string) - Root access level (e.g., NO_PERMISSION, GENERAL, VIP, ADMIN).
  - **isSandbox** (byte) - Indicates if the account is a sandbox account.
- **requestId** (string) - A unique identifier for the request.

#### Response Example
```json
{
    "code": 200,
    "result": true,
    "message": "Success",
    "data": {
        "openId": 1,
        "openName": "121 2322",
        "openEmail": "v0pjsw5t@linshiyouxiang.net",
        "setting": {
            "quotaLimits": [
                {
                    "quotaUrl": "/api2.0/v1/setting/account/get",
                    "quotaLimit": 74,
                    "quotaType": 0
                }
            ],
            "qpsLimit": 100
        },
        "callback": {
            "product": {
                "type": "ENABLE",
                "urls": ["https://your-domain.com/api2.0/"]
            },
            "order": {
                "type": "CANCEL",
                "urls": []
            }
        },
        "root": "GENERAL",
        "isSandbox": false
    },
    "requestId": "ea5896b0-273d-4b49-8c54-ad8f025a49b8"
}
```

#### Error Response (e.g., 400, 500)
- **code** (int) - Error code.
- **result** (boolean) - Indicates if the request was successful (false in case of error).
- **message** (string) - A message describing the error.
- **data** (null) - Null when there is an error.
- **requestId** (string) - A unique identifier for the request.

#### Error Response Example
```json
{
    "code": 1601000,
    "result": false,
    "message": "User not find",
    "data": null,
    "requestId": "a18c9793-7c99-42f9-970b-790eecdceba2"
}
```
```

--------------------------------

### Get Product Details

Source: https://developers.cjdropshipping.cn/en/api/api2/api/product

Retrieve detailed information about a specific product using its PID.

```APIDOC
## GET /api/products/{pid}

### Description
Retrieves detailed information about a specific product, including its name, SKU, images, pricing, variants, and inventory.

### Method
GET

### Endpoint
/api/products/{pid}

### Parameters
#### Path Parameters
- **pid** (string) - Required - The unique identifier of the product.

### Request Example
```
GET /api/products/000B9312-456A-4D31-94BD-B083E2A198E8
```

### Response
#### Success Response (200)
- **code** (integer) - The status code of the response.
- **result** (boolean) - Indicates if the request was successful.
- **message** (string) - A message describing the outcome of the request.
- **data** (object) - Contains the product details.
  - **pid** (string) - Product ID.
  - **productName** (string) - Product name in Chinese (JSON array format).
  - **productNameEn** (string) - Product name in English.
  - **productSku** (string) - Product SKU code.
  - **productImage** (string) - URL of the product's main image.
  - **productWeight** (integer) - Product weight in grams.
  - **productType** (byte) - Product type code.
  - **productUnit** (string) - Product selling unit.
  - **categoryId** (string) - Product category ID.
  - **categoryName** (string) - Product category name.
  - **entryCode** (string) - Product HS code.
  - **entryName** (string) - Product customs name in Chinese.
  - **entryNameEn** (string) - Product customs name in English.
  - **materialName** (string) - Product material in Chinese.
  - **materialNameEn** (string) - Product material in English.
  - **materialKey** (string) - Product material attribute keywords.
  - **packWeight** (integer) - Package weight in grams.
  - **packingName** (string) - Packaging material in Chinese.
  - **packingNameEn** (string) - Packaging material in English.
  - **packingKey** (string) - Packaging material attribute keywords.
  - **productKey** (string) - Product attribute keywords.
  - **variants** (array) - An array of product variants.
    - **vid** (string) - Variant ID.
    - **pid** (string) - Parent Product ID.
    - **variantNameEn** (string) - Variant name in English.
    - **variantSku** (string) - Variant SKU code.
    - **variantKey** (string) - Variant attribute keyword.
    - **variantSellPrice** (float) - Variant selling price.
    - **inventories** (array) - Inventory details for the variant.
      - **countryCode** (string) - Country code for inventory.
      - **totalInventory** (integer) - Total available inventory.
      - **stock** (array) - Stock details.
        - **inventory** (integer) - Available inventory.
        - **factoryInventory** (integer) - Factory inventory.
  - **createrTime** (string) - Product creation timestamp.

#### Response Example
```json
{
    "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,
        "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\"]",
        "packWeight": 1580,
        "packingName": "[\"\",\"塑料袋\"]",
        "packingNameEn": "[\"\",\"plastic_bag\"]",
        "packingKey": "[\"PLASTIC_BAG\"]",
        "productKey": "[\"颜色\"]",
        "variants": [
            {
                "vid": "D4057F56-3F09-4541-8461-9D76D014846D",
                "pid": "000B9312-456A-4D31-94BD-B083E2A198E8",
                "variantNameEn": "Small trailer model Black",
                "variantSku": "CJJJJTJT05843-Black",
                "variantKey": "Black",
                "variantSellPrice": 58.09,
                "inventories": [
                    {
                        "countryCode": "CN",
                        "totalInventory": 12912,
                        "stock": [
                            {
                                "inventory": 0,
                                "factoryInventory": 12912
                            }
                        ]
                    }
                ]
            }
        ],
        "createrTime": "2019-12-24T01:06:37+08:00"
    },
    "requestId": "d8dc0b6d-0ed8-4e19-8f63-3f207ac39832"
}
```
```

--------------------------------

### GET /api/product/query

Source: https://developers.cjdropshipping.cn/en/api/api2/api/product

Retrieves a list of products based on specified query parameters. Supports pagination and filtering.

```APIDOC
## GET /api/product/query

### Description
Retrieves a list of products, supporting pagination and sorting.

### Method
GET

### Endpoint
/api/product/query

### Query Parameters
- **pageNum** (int) - Optional - The page number for the product list.
- **pageSize** (int) - Optional - The number of products to return per page.
- **productName** (string) - Optional - Filters products by name.
- **categoryId** (string) - Optional - Filters products by category ID.
- **saleStatus** (int) - Optional - Filters products by sale status (e.g., 3 for 'On Sale').
- **isFreeShipping** (boolean) - Optional - Filters products by free shipping status.

### Request Example
```
GET /api/product/query?pageNum=1&pageSize=20&saleStatus=3
```

### Response
#### Success Response (200)
- **code** (int) - The status code of the response.
- **result** (boolean) - Indicates if the request was successful.
- **message** (string) - A message describing the outcome of the request.
- **data** (object) - Contains the product list and pagination details.
  - **pageNum** (int) - The current page number.
  - **pageSize** (int) - The number of items per page.
  - **total** (int) - The total number of products matching the criteria.
  - **list** (array) - An array of product objects.
    - **pid** (string) - Unique product identifier.
    - **productName** (string) - Product's Chinese name (may be a JSON array string).
    - **productNameEn** (string) - Product's English name.
    - **productSku** (string) - Product SKU code.
    - **productImage** (string) - URL of the product's main image.
    - **productWeight** (int) - Product weight in grams.
    - **productType** (byte) - Product type code.
    - **productUnit** (string) - Product selling unit.
    - **sellPrice** (decimal) - Product selling price.
    - **categoryId** (string) - Product category ID.
    - **categoryName** (string) - Product category name.
    - **remark** (string) - Remark information for the product.
    - **createTime** (string) - Product creation time on the platform.
    - **customizationVersion** (int) - Customization version number.

#### Response Example
```json
{
    "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",
                "remark": "",
                "createTime": null,
                "customizationVersion": 1
            }
        ]
    },
    "requestId": "f95cd31d-3907-47ce-ac1a-dfdee4315960"
}
```

#### Error Response (Non-2xx)
- **code** (int) - The error code.
- **result** (boolean) - Indicates if the request was successful (false).
- **message** (string) - A message describing the error.
- **data** (null) - Null for error responses.
- **requestId** (string) - A unique identifier for the request, useful for logging.

#### Error Response Example
```json
{
    "code": 1600100,
    "result": false,
    "message": "Param error",
    "data": null,
    "requestId": "323fda9d-3c94-41dc-a944-5cc1b8baf5b1"
}
```
```

--------------------------------

### GET /api2.0/v1/product/query

Source: https://developers.cjdropshipping.cn/en/api/api2/api/product

Retrieve product details by product ID, product SKU, or variant SKU. Supports optional parameters for features and country-specific inventory.

```APIDOC
## GET /api2.0/v1/product/query

### Description
Retrieves detailed information about a specific product using its unique identifier (PID, product SKU, or variant SKU). This endpoint also supports optional parameters to include additional data such as product features, inventory levels, and availability in specific countries.

### Method
GET

### Endpoint
/api2.0/v1/product/query

### Parameters
#### Query Parameters
- **pid** (string) - Optional - Product ID. Choose one of pid, productSku, variantSku. Max length: 200. Unique product identifier.
- **productSku** (string) - Optional - Product SKU. Choose one of pid, productSku, variantSku. Max length: 200. Product SPU code.
- **variantSku** (string) - Optional - Variant SKU. Choose one of pid, productSku, variantSku. Max length: 200. Variant SKU code.
- **features** (List) - Optional - Features to include. Optional values: `enable_combine` (includes combination variants, returns combination product info when passed), `enable_video` (includes videos, returns product video info when passed), `enable_inventory` (includes inventory, returns variant inventory info (include storage id) when passed). Max length: 200.
- **countryCode** (string) - Optional - Country Code. Such as CN, US. Max length: 2. Only returns variants with inventory in that country, no restriction if not passed.

### Request Example
```json
{
  "pid": "000B9312-456A-4D31-94BD-B083E2A198E8"
}
```

### Response
#### Success Response (200)
- **data** (object) - Contains the product information.
  - **productId** (string) - The unique identifier of the product.
  - **productSku** (string) - The product SKU.
  - **productName** (string) - The name of the product.
  - **variantList** (array) - A list of product variants.
    - **variantId** (string) - The unique identifier of the variant.
    - **variantSku** (string) - The SKU of the variant.
    - **properties** (string) - The properties of the variant (e.g., size, color).
    - **inventory** (integer) - The available inventory for the variant.
    - **imageUrl** (string) - The URL of the variant's image.

#### Response Example
```json
{
  "data": {
    "productId": "000B9312-456A-4D31-94BD-B083E2A198E8",
    "productSku": "ABC-123",
    "productName": "Example Product",
    "variantList": [
      {
        "variantId": "VAR-001",
        "variantSku": "ABC-123-RED-L",
        "properties": "Red, Large",
        "inventory": 100,
        "imageUrl": "https://example.com/image.jpg"
      }
    ]
  }
}
```
```

--------------------------------

### Retrieve Global Warehouse List using CURL

Source: https://developers.cjdropshipping.cn/en/api/api2/api/product

This example demonstrates how to fetch a list of all available global warehouses using a CURL command. It requires an `CJ-Access-Token` in the request header.

```bash
curl --location --request GET 'https://developers.cjdropshipping.com/api2.0/v1/product/globalWarehouseList' \
                --header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
```

--------------------------------

### Get Account Settings (JSON Response - Success)

Source: https://developers.cjdropshipping.cn/en/api/api2/api/setting

This JSON object represents a successful response when retrieving account settings. It includes the account's openId, name, email, detailed setting information such as quota limits and QPS limits, callback configurations for products and orders, root access level, and sandbox status. Error details are not present in a success response.

```json
{
    "code": 200,
    "result": true,
    "message": "Success",
    "data": {
        "openId": 1,
        "openName": "121 2322",
        "openEmail": "v0pjsw5t@linshiyouxiang.net",
        "setting": {
            "quotaLimits": [
                {
                    "quotaUrl": "/api2.0/v1/setting/account/get",
                    "quotaLimit": 74,
                    "quotaType": 0
                }
            ],
            "qpsLimit": 100
        },
        "callback": {
            "product": {
                "type": "ENABLE",
                "urls": ["https://your-domain.com/api2.0/"]
            },
            "order": {
                "type": "CANCEL",
                "urls": []
            }
        },
        "root": "GENERAL",
        "isSandbox": false
    },
    "requestId": "ea5896b0-273d-4b49-8c54-ad8f025a49b8"
}
```

--------------------------------

### GET /api2.0/v1/product/myProduct/query

Source: https://developers.cjdropshipping.cn/en/api/api2/api/product

Retrieves a list of products from the user's 'My Products' list. Supports filtering by various parameters.

```APIDOC
## GET /api2.0/v1/product/myProduct/query

### Description
Retrieves a list of products from the user's 'My Products' list. Supports filtering by various parameters like keyword, category, and listing status.

### Method
GET

### Endpoint
https://developers.cjdropshipping.com/api2.0/v1/product/myProduct/query

### Parameters
#### Query Parameters
- **keyword** (string) - Optional - Filters products by SKU, SPU, or product name. Max length: 200.
- **categoryId** (string) - Optional - Filters products by category ID. Max length: 200.
- **startAt** (string) - Optional - Filters products added starting from this date/time. Max length: 200.
- **endAt** (string) - Optional - Filters products added up to this date/time. Max length: 200.
- **isListed** (int) - Optional - Filters by listing status (e.g., 0 for not listed, 1 for listed). Max length: 200.
- **visiable** (int) - Optional - Filters by visibility status. Max length: 200.
- **hasPacked** (int) - Optional - Filters by packing status. Max length: 200.
- **hasVirPacked** (int) - Optional - Filters by virtual packing status. Max length: 200.

### Request Example
```
curl --location --request GET 'https://developers.cjdropshipping.com/api2.0/v1/product/myProduct/query?keyword=CJWJWJYZ02543' \
                --header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
```

### Response
#### Success Response (200)
- **code** (int) - Error code. Will be 200 on success.
- **result** (boolean) - Indicates if the operation was successful.
- **message** (string) - A message describing the result of the operation.
- **data** (object) - Contains the list of products matching the query. The structure of this object is not detailed in the provided text.
- **requestId** (string) - A unique identifier for the request.
- **success** (boolean) - A boolean indicating overall success.

#### Response Example
(Note: The specific structure of the 'data' field for a successful response is not provided in the input text, but it would typically contain an array of product objects.)
```json
{
    "code": 200,
    "result": true,
    "message": "Success",
    "data": [
        // Product objects will be listed here
    ],
    "requestId": "someRequestId",
    "success": true
}
```
```

--------------------------------

### CJ Dropshipping Get Balance API Error Response

Source: https://developers.cjdropshipping.cn/en/api/api2/api/shopping

Example of an error response from the CJ Dropshipping Get Balance API, typically indicating parameter errors. It includes an error code, a descriptive message, and a requestId for tracking.

```json
{
   "code": 1600100,
   "result": false,
   "message": "Param error",
   "data": null,
   "requestId": "323fda9d-3c94-41dc-a944-5cc1b8baf5b1"
}

```

--------------------------------

### CJ Dropshipping Get Balance API Success Response

Source: https://developers.cjdropshipping.cn/en/api/api2/api/shopping

Example of a successful response from the CJ Dropshipping Get Balance API. It includes the account balance, no withdrawal amount, and freeze amount, along with standard response fields like code, message, and requestId.

```json
{
    "code": 200,
    "result": true,
    "message": "Success",
    "data": {
        "amount": 87247.32,
        "noWithdrawalAmount": null,
        "freezeAmount": null
    },
    "requestId": "36fc030a-a110-4318-bc83-f39f9d3e5484"
}

```

--------------------------------

### CJ Dropshipping API - Product Variant Example

Source: https://developers.cjdropshipping.cn/en/api/api2/api/shopping

Demonstrates a product variant object within the CJ Dropshipping API response, showing different color options and their corresponding image sources. This data is typically found within the product list.

```json
{
    "color": "1pcs",
    "imgSrc": "https://oss-cf.cjdropshipping.com/product/2025/04/22/01/00e2483-b3b2-4873-80ac-e71f4d760e1f.jpg"
}
```

--------------------------------

### Upload Shipping Info using CURL

Source: https://developers.cjdropshipping.cn/en/api/api2/api/shopping

This example demonstrates how to upload shipping information using a CURL command. It requires a CJ-Access-Token for authentication and uses multipart/form-data to send order details, shipping company name, tracking number, and the waybill file. This endpoint is used after CJ order payment.

```bash
curl --location 'https://developers.cjdropshipping.com/api2.0/v1/shopping/order/uploadWaybillInfo' \
                --header 'CJ-Access-Token:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx ' \
                --form 'orderId="2511111146000642900"' \
                --form 'waybillFile=@"/C:/Users/Desktop/abcd.pdf"' \
                --form 'cjOrderId="DP2511111145580643400"' \
                --form 'cjShippingCompanyName="USPS"' \
                --form 'trackNumber="123123"'
```

--------------------------------

### Get Product List using CURL

Source: https://developers.cjdropshipping.cn/en/api/api2/api/product

This snippet demonstrates how to fetch a list of products from the CJdropshipping API using CURL. It includes an example request with authentication and query parameters for searching products.

```bash
curl --location --request GET 'https://developers.cjdropshipping.com/api2.0/v1/product/listV2?page=1&size=20&keyWord=hoodie' \
                --header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
```

--------------------------------

### Create Order with CURL

Source: https://developers.cjdropshipping.cn/en/api/api2/api/shopping

This snippet demonstrates how to create an order using the CJ Dropshipping API v1 via CURL. It includes necessary headers like CJ-Access-Token and platformToken, and a JSON payload with order details, shipping information, and product data. Ensure to replace placeholder tokens with your actual credentials.

```shell
curl --location --request POST 'https://developers.cjdropshipping.com/api2.0/v1/shopping/order/createOrderV3' \
                --header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
                --header 'platformToken: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
                --header 'Content-Type: application/json' \
                --data-raw '{
    "orderNumber": "1234",
    "shippingZip": "123",
    "shippingCountry": "123",
    "shippingCountryCode": "US",
    "shippingProvince": "123",
    "shippingCity": "132",
    "shippingCounty": "",
    "shippingPhone": "111",
    "shippingCustomerName": "123213",
    "shippingAddress": "123213",
    "shippingAddress2": "123213",
    "taxId": "123",
    "remark": "note",
    "email": "",
    "consigneeID": "",
    "shopAmount": "",
    "logisticName": "PostNL",
    "fromCountryCode": "CN",
    "houseNumber": "123",
    "iossType": "",
    "platform": "shopify",
    "iossNumber": "",
    "shopLogisticsType": 1,
    "storageId": "201e67f6ba4644c0a36d63bf4989dd70",
    "products": [
        {
            "vid": "92511400-C758-4474-93CA-66D442F5F787",
            "quantity": 1,
            "storeLineItemId": "test-lineItemId-1111"
        }
    ]
}'
```

--------------------------------

### Webhook Listener Example

Source: https://developers.cjdropshipping.cn/en/api/start/webhook

Example implementation of a webhook listener for CJ Dropshipping events, demonstrating how to receive and process incoming messages.

```APIDOC
## POST /webhookListener/productMessage

### Description
This is an example endpoint for a webhook listener that receives product-related messages from CJ Dropshipping.

### Method
POST

### Endpoint
/webhookListener/productMessage

### Parameters
#### Request Body
- **messageId** (string) - Required - The unique identifier for the message.
- **type** (string) - Required - The type of data, e.g., 'PRODUCT'.
- **params** (object) - Required - An object containing message-specific parameters.

### Request Example
```json
{
  "messageId": "some-message-id",
  "type": "PRODUCT",
  "params": {
    "orderId": "12345",
    "productId": "abcde"
  }
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.
- **message** (string) - A message describing the result of the operation.

#### Response Example
```json
{
    "success": true,
    "message": "Webhook received successfully."
}
```
```

--------------------------------

### CJ Dropshipping API - Basic Debugging Methods

Source: https://developers.cjdropshipping.cn/en/api/start/development

Utilize tools like Postman for troubleshooting API-related issues.

```APIDOC
## Basic Debugging Methods

Tools such as Postman can be used to troubleshoot API integration problems. Refer to the relevant documentation for detailed guidance.
```

--------------------------------

### Get Balance API CURL Request

Source: https://developers.cjdropshipping.cn/en/api/api2/api/shopping

Demonstrates how to use CURL to send a GET request to the CJ Dropshipping API to retrieve account balance information. Requires an `CJ-Access-Token` for authentication.

```bash
curl --location --request GET 'https://developers.cjdropshipping.com/api2.0/v1/shopping/pay/getBalance' \
                --header 'CJ-Access-Token: 0580277abfe24bcc9fccdc3ede57d334'

```

--------------------------------

### GET /shipping/options

Source: https://developers.cjdropshipping.cn/en/api/api2/api/logistic

Retrieves a list of available shipping options. This endpoint can be used to get details about different shipping channels, their pricing, and estimated delivery times.

```APIDOC
## GET /shipping/options

### Description
Retrieves a list of available shipping options based on the provided query parameters. This endpoint provides details on various shipping channels, including their costs, estimated arrival times, and any associated fees or rules.

### Method
GET

### Endpoint
/shipping/options

### Parameters
#### Query Parameters
- **originCountryId** (string) - Required - The ID of the origin country.
- **destinationCountryId** (string) - Required - The ID of the destination country.
- **weight** (number) - Required - The weight of the package.
- **volume** (number) - Optional - The volume of the package.

### Request Example
```json
{
  "originCountryId": "48",
  "destinationCountryId": "233",
  "weight": 0.5,
  "volume": 0.001
}
```

### Response
#### Success Response (200)
- **code** (integer) - The status code of the response. Expected to be 200 for success.
- **result** (boolean) - Indicates if the operation was successful. True for success.
- **message** (string) - A message describing the outcome of the operation. e.g., "Success".
- **data** (array) - An array of shipping option objects.
  - **arrivalTime** (string) - Estimated arrival time for the shipping option.
  - **discountFee** (BigDecimal) - The discounted shipping fee in USD.
  - **discountFeeCNY** (BigDecimal) - The discounted shipping fee in CNY.
  - **volumeWeight** (BigDecimal) - The volume weight of the package in USD.
  - **channelId** (string) - The unique identifier for the shipping channel.
  - **error** (string) - Error message in Chinese if any.
  - **errorEn** (string) - Error message in English if any.
  - **optionId** (string) - The unique identifier for the specific shipping option.
  - **postage** (BigDecimal) - The standard postage fee in USD.
  - **postageCNY** (BigDecimal) - The standard postage fee in CNY.
  - **priceIncreases** (string) - Information about price increases.
  - **reSort** (string) - Sorting order for the option.
  - **remoteFee** (BigDecimal) - Fee for remote areas in USD.
  - **remoteFeeCNY** (BigDecimal) - Fee for remote areas in CNY.
  - **tip** (string) - Additional tips or information.
  - **uid** (string) - User ID associated with the option.
  - **orderId** (string) - Order ID if applicable.
  - **unWeightChargeTarget** (BigDecimal) - Unweighted charge target in USD.
  - **floatMaxPrice** (BigDecimal) - Maximum float price in USD.
  - **floatMinPrice** (BigDecimal) - Minimum float price in USD.
  - **logisticsParamRespDTO** (string) - Logistics parameter response DTO.
  - **message** (string) - A descriptive message about the shipping option, e.g., tracking limitations.
  - **wrapPostage** (BigDecimal) - Postage for wrapping in USD.
  - **wrapPostageCNY** (BigDecimal) - Postage for wrapping in CNY.
  - **wrapWeight** (BigDecimal) - Weight for wrapping in USD.
  - **stopWords** (array) - Array of stop words associated with the option.
  - **channel** (object) - Details about the shipping channel.
    - **cnName** (string) - Channel name in Chinese.
    - **enName** (string) - Channel name in English.
    - **id** (string) - Channel ID.
  - **cjRespDTO** (object) - CJ specific response data.
    - **postage** (string) - Postage fee from CJ in USD.
    - **postageCNY** (string) - Postage fee from CJ in CNY.
    - **remoteFee** (string) - Remote fee from CJ in USD.
    - **remoteFeeCNY** (string) - Remote fee from CJ in CNY.
  - **destArea** (object) - Destination area details.
    - **cnName** (string) - Destination area name in Chinese.
    - **countryId** (string) - Destination country ID.
    - **enName** (string) - Destination area name in English.
    - **id** (string) - Destination area ID.
    - **parentId** (string) - Parent ID of the destination area.
    - **postCode** (string) - Postal code for the destination area.
    - **shortCode** (string) - Short code for the destination area.
  - **srcArea** (object) - Source area details.
    - **cnName** (string) - Source area name in Chinese.
    - **countryId** (string) - Source country ID.
    - **enName** (string) - Source area name in English.
    - **id** (string) - Source area ID.
    - **parentId** (string) - Parent ID of the source area.
    - **postCode** (string) - Postal code for the source area.
    - **shortCode** (string) - Short code for the source area.
  - **dump** (boolean) - Indicates if the option is dumped.
  - **zonePrice** (array) - Zone pricing information.
  - **allRuleTips** (array) - All rule tips associated with the shipping option.
    - **expression** (string) - Regular expression for validation.
    - **interceptType** (string) - Type of interception.
    - **max** (any) - Maximum value.
    - **min** (any) - Minimum value.
    - **msgCode** (string) - Message code for validation rules.
    - **msgEn** (string) - Error message in English.
    - **type** (string) - Type of rule.
  - **taxesFee** (any) - Applicable taxes fee.
  - **clearanceOperationFee** (any) - Clearance operation fee.
- **requestId** (string) - The unique identifier for the request.
- **success** (boolean) - Indicates if the overall operation was successful.

#### Response Example
```json
{
    "code": 200,
    "result": true,
    "message": "Success",
    "data": [
        {
            "arrivalTime": "12-50",
            "discountFee": 4.09,
            "discountFeeCNY": 25.30,
            "volumeWeight": null,
            "option": {
                "arrivalTime": "12-50",
                "cnName": "CJ航空挂号小包",
                "enName": "CJPacket Postal",
                "id": "1564849338719199233"
            },
            "ruleTips": [
                {
                    "expression": "^[\\s\\d\\-（）()+]{6,32}$",
                    "interceptType": "0",
                    "max": null,
                    "min": null,
                    "msgCode": "1001",
                    "msgEn": "Must be a 6-32 digit number (only numbers, symbols and spaces are supported).",
                    "type": "phone"
                }
            ],
            "ruleTipTypes": [
                "phone"
            ],
            "channelId": "1564543005939785730",
            "error": "",
            "errorEn": "",
            "optionId": "1564849338719199233",
            "postage": 3.55,
            "postageCNY": 22.00,
            "priceIncreases": "115",
            "reSort": "62",
            "remoteFee": 0,
            "remoteFeeCNY": 0,
            "tip": "",
            "uid": "",
            "orderId": null,
            "unWeightChargeTarget": null,
            "floatMaxPrice": null,
            "floatMinPrice": null,
            "logisticsParamRespDTO": null,
            "message": "Hi, CJ will not accept any disputes when you choose the shipping method, which is not trackable when orders arrived at some countries, states, or cities.",
            "wrapPostage": 4.09,
            "wrapPostageCNY": 25.30,
            "wrapWeight": 0,
            "stopWords": [],
            "channel": {
                "cnName": "促佳燕文航空挂号小包特货",
                "enName": "燕文航空挂号小包特货",
                "id": "1564543005939785730"
            },
            "cjRespDTO": {
                "postage": "3.55",
                "postageCNY": "22.00",
                "remoteFee": "0.00",
                "remoteFeeCNY": "0"
            },
            "destArea": {
                "cnName": "美国",
                "countryId": "233",
                "enName": "United States of America (the)",
                "id": "233",
                "parentId": null,
                "postCode": "",
                "shortCode": "US"
            },
            "srcArea": {
                "cnName": "中国",
                "countryId": "48",
                "enName": "China",
                "id": "48",
                "parentId": null,
                "postCode": "",
                "shortCode": "CN"
            },
            "dump": false,
            "zonePrice": [],
            "allRuleTips": [
                {
                    "expression": "^[\\s\\d\\-（）()+]{6,32}$",
                    "interceptType": "0",
                    "max": null,
                    "min": null,
                    "msgCode": "1001",
                    "msgEn": "Must be a 6-32 digit number (only numbers, symbols and spaces are supported).",
                    "type": "phone"
                }
            ],
            "taxesFee": null,
            "clearanceOperationFee": null
        }
    ],
    "requestId": "55c4708d15d44a499f061582ddbd989b",
    "success": true
}
```
```

--------------------------------

### GET /api2.0/v1/logistic/getTrackInfo (Deprecated)

Source: https://developers.cjdropshipping.cn/en/api/api2/api/logistic

Retrieves shipping information using tracking numbers. This endpoint is deprecated and should not be used for new implementations. Use the 'Get Tracking Information' endpoint instead.

```APIDOC
## GET /api2.0/v1/logistic/getTrackInfo (Deprecated)

### Description
Retrieves shipping information using tracking numbers. This endpoint is deprecated and should not be used for new implementations. Use the 'Get Tracking Information' endpoint instead.

### Method
GET

### Endpoint
https://developers.cjdropshipping.com/api2.0/v1/logistic/getTrackInfo

### Parameters
#### Query Parameters
- **trackNumber** (string) - Required - The tracking number for the shipment. Batch queries are supported.

### Request Example
```
GET https://developers.cjdropshipping.com/api2.0/v1/logistic/getTrackInfo?trackNumber=CJPKL7160102171YQ
```

### Response
#### Success Response (200)
- **trackingNumber** (string) - The tracking number.
- **logisticName** (string) - The name of the logistics provider.
- **trackingFrom** (string) - The country of origin for tracking.
- **trackingTo** (string) - The destination country for tracking.
- **deliveryDay** (string) - The estimated number of delivery days.
- **deliveryTime** (string) - The timestamp of the delivery.
- **trackingStatus** (string) - The current status of the tracking.
- **lastMileCarrier** (string) - The carrier for the last mile of delivery.
- **lastTrackNumber** (string) - The tracking number for the last mile.

#### Response Example
```json
{
    "code": 200,
    "result": true,
    "message": "Success",
    "data": [
        {
            "trackingNumber": "CJPKL7160102171YQ",
            "logisticName": "CJPacket Sensitive",
            "trackingFrom": "CN",
            "trackingTo": "US",
            "deliveryDay": "13",
            "deliveryTime": "2021-06-17 07:04:04",
            "trackingStatus": "In transit",
            "lastMileCarrier": "CJPacket",
            "lastTrackNumber": "926112903032124"
        }
    ],
    "requestId": "3426e927-8c50-4687-9ced-623e77d55bd0"
}
```

#### Error Response (e.g., 1600100)
```json
{
    "code": 1600100,
    "result": false,
    "message": "Param error",
    "data": null,
    "requestId": "323fda9d-3c94-41dc-a944-5cc1b8baf5b1"
}
```
```

--------------------------------

### Get Disputed Products List (GET)

Source: https://developers.cjdropshipping.cn/en/api/api2/api/dispute

Retrieves a list of products from a CJdropshipping order that are eligible for dispute. Requires a CJ order ID and an access token. Returns product details including ID, name, price, and quantity.

```curl
curl --location --request GET 'https://developers.cjdropshipping.com/api2.0/v1/disputes/disputeProducts?orderId=CJPKL7160102171YQ' \
                --header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
```