CJ Docs

# 7 Dispute

# 1 Select the list of disputed products（GET）

# URL

https://developers.cjdropshipping.com/api2.0/v1/disputes/disputeProducts

# CURL

curl --location --request GET 'https://developers.cjdropshipping.com/api2.0/v1/disputes/disputeProducts?orderId=CJPKL7160102171YQ' \
                --header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
Parameter Definition Type Required Length Note
orderId cj order id string yes 100

# Return

success

{
    "code": 200,
    "result": true,
    "message": "Success",
    "data": {
        "orderId": "75727832844206081",
        "orderNumber": "1627572766607937536",
        "productInfoList": [
            {
                "lineItemId": "27572784056172547",
                "cjProductId": "70030020423733248",
                "cjVariantId": "70030020612476928",
                "canChoose": true,
                "price": 23.00,
                "quantity": 1,
                "cjProductName": "Hellpoo",
                "cjImage": "http://d847fcac-392f-4168-8b06-a580a8368dff.jpg",
                "sku": "CJSJ1041743",
                "supplierName": "banggood"
            }
        ]
    },
    "requestId": "11edc6cc84254bb4b3ac74299d5db197",
    "success": true
}
Field Definition Type Length Note
orderId cj order id string 200
orderNumber customer order number string 200
productInfoList Product information list Object[]
lineItemId lineItem id string 100
cjProductId cj product id string 100
cjVariantId cj variant id string 100
canChoose Is it possible to check to open a dispute boolean true:yes, false：no
price product price BigDecimal (18,2) Unit: $ (USD）
quantity quantity integer 20
cjProductName cj product name string 200
cjImage cj product image string 100
sku sku string 100
supplierName supplier name string 200

error

{
    "code": 1600100, 
    "result": false,
    "message": "Param error",
    "data": null,
    "requestId": "323fda9d-3c94-41dc-a944-5cc1b8baf5b1"
}
Field Definition Type Length Note
code error code int 20 Reference error code
result Whether or not the return is normal boolean 1
message return message string 200
data return data object interface data return
requestId requestId string 48 Flag request for logging errors

# 2 Confirm the dispute（POST）

# URL

https://developers.cjdropshipping.com/api2.0/v1/disputes/disputeConfirmInfo

# CURL

curl --location --request POST 'https://developers.cjdropshipping.com/api2.0/v1/disputes/disputeConfirmInfo' \
                --header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
                --data-raw '{
                    "orderId": "62650625018974208",
                    "productInfoList": [
                        {
                            "lineItemId": "1626506252349808640",
                            "quantity": "1"
                        }
                      ]
                    }'
Parameter Definition Type Required Length Note
orderId cj order id string yes 100
productInfoList product information object[] yes
lineItemId lineItem id string
quantity quantity integer yes
price price BigDecimal yes (18,2) Unit: $ (USD）

# Return

success

{
    "code": 200,
    "result": true,
    "message": "Success",
    "data": {
        "orderId": "265062501897420801",
        "orderNumber": "1626506237791440896",
        "maxProductPrice": 23.00,
        "maxPostage": 0.00,
        "maxIossTaxAmount": 0,
        "maxIossHandTaxAmount": 0,
        "maxAmount": 23.00,
        "expectResultOptionList": [
            "1"
        ],
        "productInfoList": [
            {
                "lineItemId": "1626506252349808640",
                "cjProductId": "1570030020423733248",
                "cjVariantId": "1570030020612476928",
                "canChoose": false,
                "price": 23.00,
                "quantity": 1,
                "cjProductName": "Hellpoo",
                "cjImage": "https://d847fcac-392f-4168-8b06-a580a8368dff.jpg",
                "sku": "CJSJ1041743-A",
                "supplierName": "banggood"
            }
        ],
        "disputeReasonList": [
            {
                "disputeReasonId": 1,
                "reasonName": "Unfulfilled Order Cancellation"
            }
        ]
    },
    "requestId": "af336b7bdc364e6391b9d558690b1521",
    "success": true
}
Field Definition Type Length Note
orderId cj order id string 200
orderNumber order number string 200
expectResultOptionList expected result string[] 1: Refund , 2:Reissue
maxProductPrice Product price BigDecimal (18,2) Unit: $ (USD）
maxPostage Postage BigDecimal (18,2) Unit: $ (USD）
maxIossTaxAmount ioss tax amount BigDecimal (18,2) Unit: $ (USD）
maxIossHandTaxAmount ioss tax fee amount BigDecimal (18,2) Unit: $ (USD）
maxAmount Apply for refund amount BigDecimal (18,2) Unit: $ (USD）
productInfoList product information Object[]
canChoose Whether to check open dispute boolean 2 false or ture
price price BigDecimal (18,2) Unit: $ (USD）
quantity quantity integer 20
lineItemId lineItem id string 100
cjProductId cj product id string 100
cjVariantId cj variant id string 100
cjProductName cj product name string 200
cjImage cj product image string 100
sku sku string 100
supplierName supplier name string 200
disputeReasonList dispute reason object []
disputeReasonId dispute reason id integer 20
reasonName dispute reason name (EN) string 200

error

{
    "code": 1600100, 
    "result": false,
    "message": "Param error",
    "data": null,
    "requestId": "323fda9d-3c94-41dc-a944-5cc1b8baf5b1"
}
Field Definition Type Length Note
code error code int 20 Reference error code
result Whether or not the return is normal boolean 1
message return message string 200
data return data object interface data return
requestId requestId string 48 Flag request for logging errors

# 3 Create dispute（POST）

# URL

https://developers.cjdropshipping.com/api2.0/v1/disputes/create

# CURL

curl --location --request POST 'https://developers.cjdropshipping.com/api2.0/v1/disputes/create' \
                --header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
                 --data-raw '{
                    "orderId": "275727832844206081",
                    "businessDisputeId": "0000001266",
                    "disputeReasonId": 1,
                    "expectType": 1,
                    "refundType": 1,
                    "messageText": "gfhfghfghfgh",
                    "imageUrl": [],
                    "productInfoList": [
                        {
                            "lineItemId": "1627572784056172547",
                            "quantity": "1"
                        }
                    ]
                }'
Parameter Definition Type Required Length Note
businessDisputeId customer business id string yes 100
orderId cj order id string yes 100
disputeReasonId dispute reason id integer yes 10
expectType expect type integer yes 20 1: Refund , 2:Reissue
refundType Refund type integer yes 20 1:balance , 2：platform
messageText text message string yes 500
imageUrl image url string [] no 200
videoUrl video url string [] no 200
productInfoList product information object[]
price price BigDecimal yes (18,2) Unit: $ (USD）
lineItemId lineItem id string 100
quantity quantity integer yes 10

# Return

success

{
    "code": 200,
    "result": true,
    "message": "Success",
    "data": "true",
    "redirectUri": "0242ad78-eea2-481d-876a-7cf64398f07f"
}

error

{
    "code": 1600100, 
    "result": false,
    "message": "Param error",
    "data": null,
    "requestId": "323fda9d-3c94-41dc-a944-5cc1b8baf5b1"
}
Field Definition Type Length Note
code error code int 20 Reference error code
result Whether or not the return is normal boolean 1
message return message string 200
data return data object interface data return
requestId requestId string 48 Flag request for logging errors

# 4 Cancel dispute（post）

# URL

https://developers.cjdropshipping.com/api2.0/v1/disputes/cancel

# CURL

curl --location --request POST 'https://developers.cjdropshipping.com/api2.0/v1/disputes/cancel' \
                --header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
                 --data-raw '{
                        "orderId": "J1623672949997490176",
                        "disputeId": "SH1623673863466725376"
                    }'
Parameter Definition Type Required Length Note
orderId CJ order id string yes 100
disputeId CJ dispute id string yes 100

# 返回

success

{
    "code": 200,
    "result": true,
    "message": "Success",
    "data": "true",
    "redirectUri": "0242ad78-eea2-481d-876a-7cf64398f07f"
}

error

{
    "code": 1600100, 
    "result": false,
    "message": "Param error",
    "data": null,
    "requestId": "323fda9d-3c94-41dc-a944-5cc1b8baf5b1"
}
Field Definition Type Length Note
code error code int 20 Reference error code
result Whether or not the return is normal boolean 1
message return message string 200
data return data object interface data return
requestId requestId string 48 Flag request for logging errors

# 5 Query the list of disputes（GET）

# URL

https://developers.cjdropshipping.com/api2.0/v1/disputes/getDisputeList

# CURL

curl --location --request GET 'https://developers.cjdropshipping.com/api2.0/v1/disputes/getDisputeList' \
                --header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
Parameter Definition Type Required Length Note
orderId cj order id string no 100
disputeId dispute id integer no 10
orderNumber order number string no 100
pageNum page number integer no 10 default: 1
pageSize page size integer no 10 default: 10

# Return

success

{
    "code": 200,
    "result": true,
    "message": "Success",
    "data": "",
    "redirectUri": "0242ad78-eea2-481d-876a-7cf64398f07f"
}
返回字段 字段意思 字段类型 长度 备注
pageNum page number int 20
pageSize page size int 20
total total int 20
list List
status dispute status string 20
id dispute id string
disputeReason dispute reason string
replacementAmount Reissue amount BigDecimal (18,2) Unit: $ (USD）
resendOrderCode Reissue order id string
money final refund amount BigDecimal (18,2) Unit: $ (USD）
finallyDeal final negotiation result integer 1:Refund, 2: Reissue, 3: Reject
createDate create date
productList product information Object[]
image product image string
price product price
lineItemId lineItem id string 100
cjProductId product id string
cjVariantId variant id string 100
productName product name string
supplierName supplier name string

error

{
    "code": 1600100, 
    "result": false,
    "message": "Param error",
    "data": null,
    "requestId": "323fda9d-3c94-41dc-a944-5cc1b8baf5b1"
}
Field Definition Type Length Note
code error code int 20 Reference error code
result Whether or not the return is normal boolean 1
message return message string 200
data return data object interface data return
requestId requestId string 48 Flag request for logging errors

← 8 Webhook →