# 01-Settings

# 1 Settings

# 1.1 Get Settings(GET)

Account settings include profile, API quota limits, general API QPS limits, sandbox account, etc.

# URL

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

# CURL

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

# Return

success

{
    "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": {
            "productType": ALL,
            "productCallbackUrls": [
                "http://localhsost:8080/api2.0/"
            ]
        },
        "root": "GENERAL",
        "isSandbox": false
    },
    "requestId": "ea5896b0-273d-4b49-8c54-ad8f025a49b8"
}
Field Definition Type Length Note
openId Account ID string 200
openName Account name string 200
openEmail Account Email string 200
setting Settings list 200
quotaLimits Quota limits list Applicable on specific URLs
quotaUrl Quota URL string 200
quotaLimit Quota limit int 20
quotaType Quota Type byte 4 0-total,1-per year,2-per year,3-per quarter,4-per day,5-per hour
qpsLimit QPS limit int 20 account Queries per second
root Root access string 200 root:NO_PERMISSION - not authorized
GENERAL - general account
VIP - VIP account
ADMIN - administrator
isSandbox (Whether) Sandbox account byte 4

error

{
    "code": 1601000,
    "result": false,
    "message": "User not find",
    "data": null,
    "requestId": "a18c9793-7c99-42f9-970b-790eecdceba2"
}
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 Account

# 2.1 Account Settings(PATCH)

Modifications of account settings in open platform while registered Email of CJ account and API_KEY remain valid.

# URL

https://developers.cjdropshipping.com/api2.0/v1/setting/set

# CURL

curl --location --request PATCH 'https://developers.cjdropshipping.com/api2.0/v1/setting/account/set' \
                --header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
                --header 'Content-Type: application/json' \
                --data-raw '{
                    "openEmail": "v0pjsw5t@linshiyouxiang.net"
                }'
Parameter Definition Type Required Length Note
openEmail email string yes 200 CJ Account Email (opens new window)

# Return

success

{
    "code": 200,
    "result": true,
    "message": "Success",
    "data": null,
    "requestId": "051710e0-64ba-443a-942f-b8a0f3f317d4"
}
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

error

{
    "code": 1601000,
    "result": false,
    "message": "User not find",
    "data": null,
    "requestId": "a18c9793-7c99-42f9-970b-790eecdceba2"
}
Field Definition Type Length Note
code error code int 20 Reference error code
result Whether or not the return is normal boolean 1
message return message string 200
data return data object interface data return
requestId requestId string 48 Flag request for logging errors

# 2.2 Account Delete(DEL)

Account Delete on open platform while CJ account remains valid.

# URL

https://developers.cjdropshipping.com/api2.0/v1/setting/delete

# CURL

curl --location --request DELETE 'https://developers.cjdropshipping.com/api2.0/v1/setting/account/delete' \
                --header 'CJ-Access-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'

# Return

success

{
    "code": 200,
    "result": true,
    "message": "Success",
    "data": null,
    "requestId": "051710e0-64ba-443a-942f-b8a0f3f317d4"
}
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

error

{
    "code": 1601000,
    "result": false,
    "message": "User not find",
    "data": null,
    "requestId": "a18c9793-7c99-42f9-970b-790eecdceba2"
}
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