# Order

CJ PLATFORM allow customers to submit different store orders by products connection.

# Description

  • request parameter
Name Data Type Description
uid required , string(40) The ID of the order, used for API purposes. This is different from the orderNumber property, which is a unique identifier for the order that's used by the shop owner and customer
createdAt required , number Orders Created Date
shippingAddress1 required , string(800) Address 1
shippingAddress2 optional , string(800) Address 2
zip required , string(100) ZIP Code
city required , string(100) City
province required , string(100) Province/State
country required , string(100) Full Country Name
countryCode required , string(5) Country Code
orderNumber required , string(40) A unique identifier for the order, used by the shop owner and customer. This is different from the uid property, which is the unique identifier used for API purposes.
customerName required , string(300) Buyer Name
phone optional , string(100) phone
email optional , string(40) email
noteAttributes optional , string(2000) Message from Buyer
products required , Array Format

# request products format

"products" : [
    {
    "image" : "http://xxx.xxxxx.com/xxx/xxx.png" ,
    "quantity" : 2 ,
    "productPrice" : 5 ,
    "variantId" : "111241241" ,
    "shippingName" : "shoes"
    }
]
  • image : Variant Image. required string(300)

  • quantity : Variant Quantity required number

  • productPrice : Variant Price. required number

  • variantId : Your store variants ID, We use this Variants ID to match the one on CJ PLATFORM required string(40)

  • shippingName : Product Name required string(800)

  • response parameter

Name Data Type Description
uid string The ID of the order, used for API purposes. This is different from the orderNumber property, which is a unique identifier for the order that's used by the shop owner and customer
zip string ZIP Code
phone string Contact Number
countryCode string Country Code
shopAmount number Order Amount
orderSourceType string Order Type
shippingAddress1 string Address1
shippingAddress2 string Address2
orderWeight string Order Weight
country string Full Country Name
city string City
postage number Shipping Cost
consumerName string Buyer Name
id string CJ Order ID
orderAmount number Order Amount without Shipping Cost
email string Email
createdAt string Your Store Order Created Date
orderNumber string A unique identifier for the order, used by the shop owner and customer. This is different from the uid property, which is the unique identifier used for API purposes.
noteAttributes string Message from Buyer
logisticName string Shipping Method
province string Province/State
createDate string CJ Pulled Date
orderQuantity number Order Quantity
paymentDate string Payment Date
products Array Format

# response products format

"products" : [
    {
    "image" : "http://xxx.xxxxx.com/xxx/xxx.png" ,
    "property" : "ELECTRONIC" ,
    "sku" : "CJZBNSJX00082-Black-Male money" ,
    "variantId" : "11107223994411" ,
    "id" : "1534413588541395232" ,
    "logisticsType" : "ePacket" ,
    "CJOrderId" : "180816104726934356" ,
    "price" : 4 ,
    "grams" : 110 ,
    "quantity" : 3 ,
    "cjProductName" : "Wholesale rice men..." ,
    "productprice" : 6 ,
    }
]
  • image : Product Image
  • property : Product Attribute
  • sku : Product SKU
  • variantId : Variants SKU
  • logisticsType : Shipping Method
  • CJOrderId : CJ Order Number
  • price : CJ Product Price
  • grams : Product Weight
  • quantity : Product Quantity
  • cjProductName : CJ Product Title
  • productprice : Your Store Product Price

# Create Order

POST api/order/createOrders

Create an Order.
required parameter : Parameter

# Create order format

request parameter

[
    {
    "customerName" : "tony" ,
    "uid" : "596178796589" ,
    "zip" : "55434" ,
    "phone" : "18657849787" ,
    "countryCode" : "US" ,
    "shippingAddress1" : "address 1" ,
    "shippingAddress2" : "address 2" ,
    "city" : "Blaine" ,
    "country" : "United States" ,
    "email" : "16578787878@qq.com" ,
    "createdAt" : 1534318375082 ,
    "orderNumber" : "1234" ,
    "noteAttributes" : "note" ,
    "province" : "Minnesota" ,
    "products" : [
        {
            "image" : "http://xxx.xxxxx.com/xxx/xxx.png" ,
            "quantity" : 2 ,
            "variantId" : "12131313" ,
            "productPrice" : 5 ,
            "shippingName" : "ePacket"
        },{
            "image" : "http://xxx.xxxxx.com/xxx/xxx.png" ,
            "quantity" : 3 ,
            "sku" : "CJZBNSJX00082-Black-Male money" ,
            "productPrice" : 6 ,
            "shippingName" : "ePacket"
        }]
    }
]

response parameter HTTP/1.1 200 ok

[
    {
    "uid" : "596178796589",
    "message" : [],
    "result" : true
    }
]

# View Orders

POST api/order/queryOrders

Name Data Type Description
uid required , string(40) The ID of the order, used for API purposes. This is different from the orderNumber property, which is a unique identifier for the order that's used by the shop owner and customer

request parameter

[
  "987654321"
]

response parameter

  • order_status : CREATED CANCELLED IN_CART UNPAID UNSHIPPED SHIPPED

HTTP/1.1 200 ok

[
    {
        "orderNumber":"sm_987654321",
        "city":"jiulong",
        "orderWeight":1060,
        "shippingAddress2":"",
        "shippingAddress1":"jiulongyihao",
        "orderQuantity":2,
        "products":[
            {
                "image":"https://cc-west-usa.oss-us-west-1.aliyuncs.com/20190716/41478198858285.png",
                "quantity":2,
                "shippingName":"VR glasses",
                "CJOrderId":"191126100015457418",
                "cjProductName":"G300 Smart VR Glasses 3D Virtual Reality Headset",
                "price":12.3,
                "property":"ELECTRONIC",
                "id":"1574737858658173974",
                "variantId":"FE560BCD-27E8-400C-9A47-6DCAA41B0EDE",
                "sku":"CJXFBXVR00010-Black",
                "grams":530,
                "logisticsType":"",
                "productprice":12
            }
        ],
        "createdAt":"2019-11-25 09:58:34",
        "uid":"987654321",
        "order_status":"UNPAID",
        "orderAmount":24.6,
        "province":"ACT",
        "countryCode":"AU",
        "logisticInfo": [
            {
                "cast":"0",
                "price":12.63,
                "logisticName":"Australia Line",
                "remark":"",
                "discountPrice":12.63,
                "discount":0
            },
            {
                "cast":"0",
                "price":12.63,
                "logisticName":"CJPacket",
                "remark":"Shipping to Brazil takes 10 to 25 days by CJpacket.",
                "discountPrice":12.63,
                "discount":0
            },
            {
                "cast":"0",
                "price":13.29,
                "logisticName":"Pos Malaysia",
                "remark":"",
                "discountPrice":13.29,
                "discount":0
            },
            {
                "cast":"0",
                "price":13.35,
                "logisticName":"ePacket",
                "remark":"",
                "discountPrice":13.35,
                "discount":0
            },
            {
                "cast":"0",
                "price":14.79,
                "logisticName":"CJ Liquid Direct Line",
                "remark":"",
                "discountPrice":14.79,
                "discount":0
            },
            {
                "cast":"0",
                "price":16.08,
                "logisticName":"Singpost",
                "remark":"",
                "discountPrice":16.08,
                "discount":0
            },
            {
                "cast":"0",
                "price":16.56,
                "logisticName":"HKpost",
                "remark":"Countries like The USA, UK, Canada, Australia, France, Germany, Brazil etc. might be untrackable when it dispatched from China custom, we will not refund or resend for this shipping method.",
                "discountPrice":16.56,
                "discount":0
            },
            {
                "cast":"0",
                "price":16.97,
                "logisticName":"CJ Liquid",
                "remark":"",
                "discountPrice":16.97,
                "discount":0
            },
            {
                "cast":"0",
                "price":20.37,
                "logisticName":"PostNL",
                "remark":"",
                "discountPrice":20.37,
                "discount":0
            },
            {
                "cast":"0",
                "price":20.57,
                "logisticName":"Swiss Post",
                "remark":"",
                "discountPrice":20.57,
                "discount":0
            },
            {
                "cast":"0",
                "price":29.49,
                "logisticName":"DHL Official",
                "remark":"",
                "discountPrice":29.49,
                "discount":0
            },
            {
                "cast":"0",
                "price":34.54,
                "logisticName":"DHL",
                "remark":"Remote address will charge additional cost, we will contact you once found it.",
                "discountPrice":34.54,
                "discount":0
            }
        ],
        "id":"191126100015457418",
        "createDate":"2019-11-26 11:11:00",
        "shipmentsOrderID":"CJ1911262400924178",
        "zip":"713505",
        "amount":44.97,
        "shopAmount":24,
        "postage":20.37,
        "logisticName":"PostNL",
        "cancel_status":false,
        "phone":"015775061454",
        "noteAttributes":"note132323234342324test obero",
        "consumerName":"crystal",
        "status":null
    }
]

# Modify Orders

POST api/order/upOrders

Update Order.
required parameter : Parameter

# Modify order format

request parameter

{
    "customerName" : "tony" ,
    "uid" : "596178796589" ,
    "zip" : "55434" ,
    "phone" : "18657849787" ,
    "countryCode" : "US" ,
    "shippingAddress1" : "address 1" ,
    "shippingAddress2" : "address 2" ,
    "city" : "Blaine" ,
    "country" : "United States" ,
    "email" : "16578787878@qq.com" ,
    "createdAt" : 1534318375082 ,
    "orderNumber" : "1234" ,
    "noteAttributes" : "note" ,
    "province" : "Minnesota" ,
    "products" : [{
    "image" : "http://xxx.xxxxx.com/xxx/xxx.png" ,
    "quantity" : 2 ,
    "variantId" : "12131313" ,
    "productPrice" : 5 ,
    "shippingName" : "ePacket"
    },{
    "image" : "http://xxx.xxxxx.com/xxx/xxx.png" ,
    "quantity" : 3 ,
    "variantId" : "121312313" ,
    "productPrice" : 6 ,
    "shippingName" : "ePacket"
    }]
}

response parameter HTTP/1.1 200 ok

[
    {
    "uid" : "596178796589",
    "message" : [],
    "result" : true
    }
]

# Delete Orders

POST api/order/deleteOrders

Name Data Type Description
uid required , string(40) The ID of the order, used for API purposes. This is different from the orderNumber property, which is a unique identifier for the order that's used by the shop owner and customer

request parameter

[
  "596178796589"
]

response parameter HTTP/1.1 200 ok

{
    "result" : true
}

# View Orders By Criteria

POST api/order/queryOrdersByCriteria

Name Data Type Description
pageNum required , number Current page number
pageSize required , number Quantity can be found on this page,pageSize has to be integer pageSize maxmium is 50
id required , string(40) The id of the order in the CJ order database.
orderNumber required , string(40) A unique identifier for the order, used by the shop owner and customer. This is different from the uid property, which is the unique identifier used for API purposes..
startDate required , string(40) Start time, query the start time of the order creation time range.
endDate required , string(40) End time, query the end time of the order creation time range.
type required , string(40) The type of store to which the order belongsNotice:
Only 3 values are allowed:

all

api

ShopName

Default: all

orderBy required , string(40) Sort by order creation time

Notice: Only two values are allowed:

desc

aes

uid required , Array The ID of the order, used for API purposes. This is different from the orderNumber property, which is a unique identifier for the order that's used by the shop owner and customer.

request parameter

{
    "pageSize" : 50,
    "pageNum" : 1,
    "id" : "180522100107548547",
    "orderNumber" : "518937",
    "startDate" : "2015-05-01 00:00:00",
    "endDate" : "2018-05-01 00:00:00",
    "type" : "api",
    "orderBy" : "DESC",
    "uid" : [
        499146358889,
        498891194473
    ]
}

response parameter HTTP/1.1 200 ok

{
    "code" : true,
    "response" : {
    "total" : 2,
    "pageNum" : 1,
    "data" : [{
    "id" : "180522100107548547",
    "consumerName" : "April Pascual",
    "city" : "Beavercreek",
    "country" : "United States",
    "countryCode" : "US",
    "createDate" : "2018-05-22 14:05:05",
    "createdAt" : "2018-05-21 22:25:49",
    "logisticName" : "Bpost",
    "noteAttributes" : "null",
    "orderAmount" : 4.94,
    "orderNumber" : "518937",
    "orderQuantity" : 1,
    "orderSourceType" : "2",
    "orderWeight" : 540,
    "phone" : "(937) 306-8533",
    "postage" : 12.00,
    "province" : "Ohio",
    "shippingAddress1" : "3881 Rosecliff Drive",
    "shippingAddress2" : "",
    "shopAmount" : 19.98,
    "uid" : "499146358889",
    "zip" : "45440-3441",
    },{
    "id" : "180522100107579059",
    "consumerName" : "April Pascual",
    "city" : "Whitsett",
    "country" : "United States",
    "countryCode" : "US",
    "createDate" : "2018-05-22 14:05:05",
    "createdAt" : "2018-05-21 14:38:39",
    "logisticName" : "Bpost",
    "noteAttributes" : "null",
    "orderAmount" : 2.80,
    "orderNumber" : "517660",
    "orderQuantity" : 1,
    "orderSourceType" : "2",
    "orderWeight" : 151,
    "phone" : "3368959207",
    "postage" : 7.87,
    "province" : "North Carolina",
    "shippingAddress1" : "1937 Munn Pointe Drive",
    "shippingAddress2" : "",
    "shopAmount" : 19.99,
    "uid" : "498891194473",
    "zip" : "27377",
    }]
    }
}