ChinaDivision Order Fulfillment API Integration

Services Introduction:

This document describes the integration points available to clients via the www.chinadivision.com API, which makes shipping data available for syncing the client system with the www.chinadivision.com system.

Interface Address:

https://api.chinadivision.com/sku-create

Request Method:

POST

Request Parameters (header):

Parameter Name	Types	Required	Parameter Location	Description	Defaults
apikey	string	yes	header	API Key	your apikey

Request Parameters (bodyParam):

Parameter Name	Types	Required	Parameter Location	Description	Defaults
package_number	string	yes	bodyParam	Package Number
tracking_number	string	yes	bodyParam	Tracking Number
shipping_method	string	yes	bodyParam	Shipping Method
quantity	int	yes	bodyParam	Total Quantity
info	array	yes	bodyParam	Multiple parcels SKU information
inspection	int	yes	bodyParam	inspection status code 0:no need inspection,1:need inspection	0
remark	string	no	bodyParam	remark
business_type	int	yes	bodyParam	business type	1

Request Example:

<?php
$ch = curl_init();
$url = 'https://api.chinadivision.com/sku-create';
$header = array(
        'Content-Type:application/x-www-form-urlencoded',
        'apikey: your apikey',
);
$post_data = array(
        'package_number' => 'CNSTORM-20160301-00001',
        'tracking_number' => 'NO100001',
        'shipping_method' => 'SF',
        'quantity' => 8,
        'info' => array(
            array(
                'sku' => 'sku-iv-1',
                'product_name' => 'shirt',
                'product_url' => 'https://item.taobao.com/item.htm?spm=a1z10.1-c.w5003-10229753858.1.9rA5ew&id=524430044755&scene=taobao_shop',
                'color' => 'Red Pansy',
                'size' => 'XS',
                'price' => 100,
                'supplier' => 'taobao',
                'quantity' => 4,
            ),
            array(
                'sku' => 'sku-iv-2',
                'product_name' => 'shirt',
                'product_url' => 'https://item.taobao.com/item.htm?spm=a1z10.33-c.w4002-12426177414.14.bqhm4D&id=39906160111',
                'color' => 'Pansy',
                'size' => 'XS',
                'supplier' => 'taobao',
                'quantity' => 1,
            ),
            array(
                'sku' => 'sku-iv-3',
                'product_name' => 'shirt',
                'product_url' => 'https://item.taobao.com/item.htm?spm=a1z10.33-c.w4002-12426177414.14.bqhm4D&id=39906160111',
                'color' => 'Green Pansy',
                'size' => 'XS',
                'supplier' => 'whoolala',
                'quantity' => 3,
            ),
        ),
        'inspection' => 0,
        'remark' => 'test',
        'business_type' => 1
);
// Add apikey to header
curl_setopt($ch, CURLOPT_HTTPHEADER  , $header);
// Add post_data to bodyParam
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($post_data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
// HTTP request
curl_setopt($ch , CURLOPT_URL , $url);
$res = curl_exec($ch);

var_dump(json_decode($res));
?>

JSON Returns Example:

Remark:

Repeat create SKU, execute update SKU information operation.

Error Messages:

Error Code	Error Code Returns	Description
0	success	success
1	Apikey can not be empty	apikey can not be empty
2	Apikey does not exist	apikey does not exist
3	Post data can not be empty	Post data can not be empty
4	Info data can not be empty	Info data can not be empty
5	Tracking Number and Package Number two must have a not null	Tracking Number and Package Number two must have a not null
6	service is temporarily unavailable	service is temporarily unavailable

Services Introduction:

Interface Address:

https://api.chinadivision.com/sku-info

Request Method:

GET

Request Parameters (header):

Parameter Name	Types	Required	Parameter Location	Description	Defaults
apikey	string	yes	header	API Key	your apikey

Request Parameters (urlParam):

Parameter Name	Types	Required	Parameter Location	Description
package_number	string	yes	urlParam	Package Number
tracking_number	string	yes	urlParam	Tracking Number
shipping_method	string	yes	urlParam	Shipping Mehtod

Request Example:

<?php
    $ch = curl_init();
    $url = 'https://api.chinadivision.com/sku-info?package_number=CNSTORM-20150301-00001&tracking_number=NO100001&shipping_method=SF';
    $header = array(
            'apikey: your apikey',
    );
    // Add apikey to header
    curl_setopt($ch, CURLOPT_HTTPHEADER  , $header);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
    // HTTP request
    curl_setopt($ch , CURLOPT_URL , $url);
    $res = curl_exec($ch);

    var_dump(json_decode($res));
?>

JSON Returns Example:

{
    "code": 0,
    "msg": "success",
    "data": {
        "package_number": "CNSTORM-20150301-00001",
        "tracking_number": "NO100001",
        "shipping_method": "SF",
        "quantity": "8",
        "info": "[
		{\"sku\":\"sku-iv-1\",\"product_name\":\"shirt\",\"product_url\":\"https:\\/\\/item.taobao.com\\/item.htm?spm=a1z10.1-c.w5003-10229753858.1.9rA5ew&id=524430044755&scene=taobao_shop\",\"color\":\"Red Pansy\",\"size\":\"XS\",\"price\":10,\"supplier\":\"taobao\",\"quantity\":1},
		{\"sku\":\"sku-iv-2\",\"product_name\":\"shirt\",\"product_url\":\"https:\\/\\/item.taobao.com\\/item.htm?spm=a1z10.33-c.w4002-12426177414.14.bqhm4D&id=39906160111\",\"color\":\"Pansy\",\"size\":\"XS\",\"price\":180,\"supplier\":\"taobao\",\"quantity\":2},
		{\"sku\":\"sku-iv-3\",\"product_name\":\"shirt\",\"product_url\":\"https:\\/\\/item.taobao.com\\/item.htm?spm=a1z10.33-c.w4002-12426177414.14.bqhm4D&id=39906160111\",\"color\":\"Green Pansy\",\"size\":\"XS\",\"price\":190,\"supplier\":\"whoolala\",\"quantity\":5}
		]",
        "remark": "",
        "date_added": "2016-02-18 19:40:56",
        "date_modified": "0000-00-00 00:00:00",
        "package_status": "0",
        "shelf_number": ""
    }
}

Remark:

package_status: current package's state
0: Processing, Packages are being processed;
1: Received, Packages have been received by ChinaDivision;
2: Problem, Packages-received don't match the packing list information which was offered by the customer or by the supplier;

Error Messages:

Error Code	Error Code Returns	Description
0	success	success
1	Apikey can not be empty	apikey can not be empty
2	Apikey does not exist	apikey does not exist
3	Package Number can not be empty	package number can not be empty
4	Tracking Number does not exist	tracking number does not exist
5	Shipping Method does not exist	Shipping Method does not exist
6	Packing List does not exist	Packing List does not exist

Services Introduction:

Interface Address:

https://api.chinadivision.com/sku-cancel

Request Method:

POST

Request Parameters (header):

Parameter Name	Types	Required	Parameter Location	Description	Defaults
apikey	string	yes	header	API Key	your apikey

Request Parameters (bodyParam):

Parameter Name	Types	Required	Parameter Location	Description
tracking_number	string	yes	bodyParam	Tracking Number
package_number	string	yes	bodyParam	Package Number
shipping_method	string	yes	bodyParam	Shipping Method
remark	string	no	bodyParam	remark

Request Example:

<?php
    $ch = curl_init();
    $url = 'https://api.chinadivision.com/sku-cancel';
    $header = array(
            'Content-Type:application/x-www-form-urlencoded',
            'apikey: your apikey',
    );
    $post_data = array(
            'package_number' => 'CNSTORM-20150301-00001',
            'tracking_number' => 'NO100001',
            'shipping_method' => 'SF',
            'remark' => 'test'
    );
    // Add apikey to header
    curl_setopt($ch, CURLOPT_HTTPHEADER  , $header);
    // Add post_data to bodyParam
    curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($post_data));
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
    // HTTP request
    curl_setopt($ch , CURLOPT_URL , $url);
    $res = curl_exec($ch);

    var_dump(json_decode($res));
?>

JSON Returns Example:

Remark:

The cancel API call to cancel any orders before shipment.

Error Messages:

Error Code	Error Code Returns	Description
0	success	success
1	Apikey can not be empty	apikey can not be empty
2	Apikey does not exist	apikey does not exist
3	Tracking Number and Package Number two must have a not null	Tracking Number and Package Number two must have a not null
4	Post data can not be empty	Post data can not be empty
5	service is temporarily unavailable	service is temporarily unavailable

Services Introduction:

Interface Address:

https://api.chinadivision.com/order-create

Request Method:

POST

Request Parameters (header):

Parameter Name	Types	Required	Parameter Location	Description	Defaults
apikey	string	yes	header	API Key	your apikey

Request Parameters (bodyParam):

Parameter Name	Types	Required	Parameter Location	Description	Defaults
order_id	string	yes	bodyParam	order id
first_name	string	yes	bodyParam	first name
last_name	string	yes	bodyParam	last name
ship_address1	string	yes	bodyParam	ship address1
ship_address2	string	no	bodyParam	ship address2
ship_city	string	yes	bodyParam	ship city
ship_state	string	yes	bodyParam	ship state
ship_zip	string	yes	bodyParam	ship zip
ship_country	string	yes	bodyParam	ship country
ship_phone	string	yes	bodyParam	ship phone
ship_email	string	no	bodyParam	ship email
quantity	int	yes	bodyParam	Total quantity
info	array	yes	bodyParam	Multiple parcels SKU information
shipping_method	string	no	bodyParam	Specify a shipping out method
vat	string	no	bodyParam	vat
inspection	int	yes	bodyParam	inspection status code 0:no need inspection,1:need inspection	0
remark	string	no	bodyParam	remark
business_type	int	yes	bodyParam	business type	1

Request Example:

<?php
    $ch = curl_init();
    $url = 'https://api.chinadivision.com/order-create';
    $header = array(
            'Content-Type:application/x-www-form-urlencoded',
            'apikey: your apikey',
    );
    $post_data = array(
            'order_id' => '100001',
            'first_name' => 'wang',
            'last_name' => 'xiao hong',
            'ship_address1' => '8888 Parkland',
            'ship_address2' => '',
            'ship_city' => 'Calgary',
            'ship_state' => 'AB',
            'ship_zip' => 'T2J3Y2',
            'ship_country' => 'Canada',
            'ship_phone' => '8888888888',
            'ship_email' => 'gzq@cnstorm.com',
            'quantity' => 8,
            'info' => array(
                array(
                    'sku' => 'sku-iv-1',
                    'product_name' => 'shirt',
                    'product_url' => 'https://item.taobao.com/item.htm?spm=a1z10.1-c.w5003-10229753858.1.9rA5ew&id=524430044755&scene=taobao_shop',
                    'color' => 'Red Pansy',
                    'size' => 'XS',
                    'category' => 'Fragile',
                    'supplier' => 'taobao',
                    'quantity' => 4,
                    'package_number' => 'N10001',
                    'tracking_number' => '888888888',
                    'shipping_method' => 'SF',
                ),
                array(
                    'sku' => 'sku-iv-2',
                    'product_name' => 'shirt',
                    'product_url' => 'https://item.taobao.com/item.htm?spm=a1z10.33-c.w4002-12426177414.14.bqhm4D&id=39906160111',
                    'color' => 'Pansy',
                    'size' => 'XS',
                    'category' => 'Fragile',
                    'supplier' => 'taobao',
                    'quantity' => 1,
                    'package_number' => 'N10001',
                    'tracking_number' => '888888888',
                    'shipping_method' => 'SF',
                ),
                array(
                    'sku' => 'sku-iv-3',
                    'product_name' => 'shirt',
                    'product_url' => 'https://item.taobao.com/item.htm?spm=a1z10.33-c.w4002-12426177414.14.bqhm4D&id=39906160111',
                    'color' => 'Green Pansy',
                    'size' => 'XS',
                    'category' => 'Fragile',
                    'supplier' => 'whoolala',
                    'quantity' => 3,
                    'package_number' => 'N10002',
                    'tracking_number' => '999999999',
                    'shipping_method' => 'SF',
                ),
            ),
            'shipping_method' => 'DHL',
            'vat' => '',
            'inspection' => 0,
            'remark' => 'test',
            'business_type' => 1
    );
    // Add apikey to header
    curl_setopt($ch, CURLOPT_HTTPHEADER  , $header);
    // Add post_data to bodyParam
    curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($post_data));
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
    // HTTP request
    curl_setopt($ch , CURLOPT_URL , $url);
    $res = curl_exec($ch);

    var_dump(json_decode($res));
?>

JSON Returns Example:

Remark:

Repeat create order, execute update order information operation.

Error Messages:

Error Code	Error Code Returns	Description
0	success	success
1	Apikey can not be empty	apikey can not be empty
2	Apikey does not exist	apikey does not exist
3	Post data can not be empty	Post data can not be empty
4	Info data can not be empty	Info data can not be empty
5	service is temporarily unavailable	service is temporarily unavailable
6	Order has been shipped	Order has been shipped

Services Introduction:

Interface Address:

https://api.chinadivision.com/order-info

Request Method:

GET

Request Parameters (header):

Parameter Name	Types	Required	Parameter Location	Description	Defaults
apikey	string	yes	header	API Key	your apikey

Request Parameters (urlParam):

Parameter Name	Types	Required	Parameter Location	Description	Defaults
order_id	string	yes	urlParam	order id

Request Example:

<?php
    $ch = curl_init();
    $url = 'https://api.chinadivision.com/order-info?order_id=888888';
    $header = array(
            'apikey: your apikey',
    );
    // Add apikey to header
    curl_setopt($ch, CURLOPT_HTTPHEADER  , $header);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
    // HTTP request
    curl_setopt($ch , CURLOPT_URL , $url);
    $res = curl_exec($ch);

    var_dump(json_decode($res));
?>

JSON Returns Example:

{
    "code": 0,
    "msg": "success",
    "data": {
        "order_id": "888888",
        "first_name": "Wan",
        "last_name": "XiaoEr",
        "ship_address1": "8888 Parkland",
        "ship_address2": "",
        "ship_city": "BEEVILLE",
        "ship_state": "TX",
        "ship_zip": "8888",
        "ship_country": "United States",
        "ship_phone": "8888888888",
        "ship_email": "gzq@cnstorm.com",
        "code": "1234,5678,9123",
        "quantity": "3",
        "remark": "test",
        "date_added": "2015-07-16 11:51:38",
        "info":[
            {"sku":"sku-001","sku_code":"12345601","quantity":"1","tracking_number":"LN00001","shipping_method":"SF","package_number":"N10001","product_name":"shirt","product_url":"https:\/\/item.taobao.com\/item.htm?spm=a1z10.33-c.w4002-12426177414.14.bqhm4D&id=39906160111","color":"Pansy","size":"XS","category":"Fragile","supplier":"taobao"},
            {"sku":"sku-002","sku_code":"12345602","quantity":"2","tracking_number":"LN00002","shipping_method":"SF","package_number":"N10002","product_name":"shirt","product_url":"https:\/\/item.taobao.com\/item.htm?spm=a1z10.33-c.w4002-12426177414.14.bqhm4D&id=39906160111","color":"Green Pansy","size":"XS","category":"Fragile","supplier":"taobao"}
        ]
        "freight": "100.00",
        "tracking_number": "8888888888",
        "shipping_method": "DHL",
        "order_status": "1"
    }
}

Remark:

order_status: current order's state
0: Processing, the parcel is being prepared.
1: Collected, the parcel has been collected by the courier company and the tracking number has been provided.

Error Messages:

Error Code	Error Code Returns	Description
0	success	success
1	Apikey can not be empty	apikey can not be empty
2	Apikey does not exist	apikey does not exist
3	Order ID can not be empty	order id can not be empty
4	Order does not exist	order does not exist

Services Introduction:

Interface Address:

https://api.chinadivision.com/orders-info

Request Method:

GET

Request Parameters (header):

Parameter Name	Types	Required	Parameter Location	Description	Defaults
apikey	string	yes	header	API Key	your apikey

Request Parameters (urlParam):

Parameter Name	Types	Required	Parameter Location	Description
page	int	yes	urlParam	page
start	string	yes	urlParam	Start time, query the start time of the order creation time range.
end	string	yes	urlParam	End time, query the end time of the order creation time range

Request Example:

<?php
    $ch = curl_init();
    $url = 'https://api.chinadivision.com/orders-info?page=1&start=2019-01-01&end=2019-01-31';
    $header = array(
            'apikey: your apikey',
    );
    // Add apikey to header
    curl_setopt($ch, CURLOPT_HTTPHEADER  , $header);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
    // HTTP request
    curl_setopt($ch , CURLOPT_URL , $url);
    $res = curl_exec($ch);

    var_dump(json_decode($res));
?>

JSON Returns Example:

{
	"code": 0,
	"msg": "success",
	"data": {
		"page": "1",
		"page_size": 2,
		"page_count": 100,
		"order_count": "299",
		"order_infos": [{
			"order_id": "#1010",
			"first_name": "cn",
			"last_name": "lei",
			"ship_address1": "8888 Parkland",
			"ship_address2": "",
			"ship_city": "BEEVILLE",
			"ship_state": "TX",
			"ship_zip": "8888",
			"ship_country": "United States",
			"ship_phone": "8888888888",
			"ship_email": "test@cnstorm.com",
			"quantity": "2",
			"remark": "",
			"date_added": "2019-01-28 09:32:57",
			"freight": "10.00",
			"tracking_number": "dhl432564",
			"shipping_method": "DHL-EXPRESS",
			"order_status": "3"
		}, {
			"order_id": "#1011",
			"first_name": "Yumi",
			"last_name": "Lin",
			"ship_address1": "tiezailu",
			"ship_address2": "",
			"ship_city": "sz",
			"ship_state": "Guangdong",
			"ship_zip": "518000",
			"ship_country": "China",
			"ship_phone": "13631120555",
			"ship_email": "test@chinadivision.com",
			"quantity": "2",
			"remark": "",
			"date_added": "2019-01-29 15:17:17",
			"freight": "10.00",
			"tracking_number": "ems516546",
			"shipping_method": "EMS-EXPRESS",
			"order_status": "3"
		}]
	}
}

Remark:

order_status: current order's state
0: Processing, the parcel is being prepared.
1: Collected, the parcel has been collected by the courier company and the tracking number has been provided.

Error Messages:

Error Code	Error Code Returns	Description
0	success	success
1	Apikey can not be empty	apikey can not be empty
2	Apikey does not exist	apikey does not exist
4	page can not be empty	page can not be empty
5	start can not be empty	start can not be empty
6	end can not be empty	end can not be empty
7	Order does not exist	order does not exist

Services Introduction:

Interface Address:

https://api.chinadivision.com/order-cancel

Request Method:

POST

Request Parameters (header):

Parameter Name	Types	Required	Parameter Location	Description	Defaults
apikey	string	yes	header	API Key	your apikey

Request Parameters (bodyParam):

Parameter Name	Types	Required	Parameter Location	Description	Defaults
order_id	string	yes	bodyParam	order id
remark	string	no	bodyParam	remark

Request Example:

<?php
    $ch = curl_init();
    $url = 'https://api.chinadivision.com/order-cancel';
    $header = array(
            'Content-Type:application/x-www-form-urlencoded',
            'apikey: your apikey',
    );
    $post_data = array(
            'order_id' => '100001',
            'remark' => 'test'
    );
    // Add apikey to header
    curl_setopt($ch, CURLOPT_HTTPHEADER  , $header);
    // Add post_data to bodyParam
    curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($post_data));
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
    // HTTP request
    curl_setopt($ch , CURLOPT_URL , $url);
    $res = curl_exec($ch);

    var_dump(json_decode($res));
?>

JSON Returns Example:

Remark:

The cancel API call to cancel any orders before shipment.

Error Messages:

Error Code	Error Code Returns	Description
0	success	success
1	Apikey can not be empty	apikey can not be empty
2	Apikey does not exist	apikey does not exist
3	Order ID can not be empty	Order ID can not be empty
4	Post data can not be empty	Post data can not be empty
5	service is temporarily unavailable	service is temporarily unavailable

Services Introduction:

Interface Address:

https://api.chinadivision.com/sku-inventory

Request Method:

GET

Request Parameters (header):

Parameter Name	Types	Required	Parameter Location	Description	Defaults
apikey	string	yes	header	API Key	your apikey

Request Parameters (urlParam):

Parameter Name	Types	Required	Parameter Location	Description	Defaults
sku	string	yes	urlParam	SKU

Request Example:

<?php
    $ch = curl_init();
    $url = 'https://api.chinadivision.com/sku-inventory?sku=XXXX';
    $header = array(
            'apikey: your apikey',
    );
    // Add apikey to header
    curl_setopt($ch, CURLOPT_HTTPHEADER  , $header);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
    // HTTP request
    curl_setopt($ch , CURLOPT_URL , $url);
    $res = curl_exec($ch);

    var_dump(json_decode($res));
?>

JSON Returns Example:

Remark:

The SKU Inventory API: Get your product inventory

Error Messages:

Error Code	Error Code Returns	Description
0	success	success
1	Apikey can not be empty	apikey can not be empty
2	Apikey does not exist	apikey does not exist
3	SKU can not be empty	SKU can not be empty
4	SKU Inventory does not exist	SKU Inventory does not exist

Power your website with our simple API

Services Introduction:

Interface Address:

Request Method:

Request Parameters (header):

Request Parameters (bodyParam):

Request Example:

php

JSON Returns Example:

JSON

Remark:

Error Messages:

Services Introduction:

Interface Address:

Request Method:

Request Parameters (header):

Request Parameters (urlParam):

Request Example:

php

JSON Returns Example:

JSON

Remark:

Error Messages:

Services Introduction:

Interface Address:

Request Method:

Request Parameters (header):

Request Parameters (bodyParam):

Request Example:

php

JSON Returns Example:

JSON

Remark:

Error Messages:

Services Introduction:

Interface Address:

Request Method:

Request Parameters (header):

Request Parameters (bodyParam):

Request Example:

php

JSON Returns Example:

JSON

Remark:

Error Messages:

Services Introduction:

Interface Address:

Request Method:

Request Parameters (header):

Request Parameters (urlParam):

Request Example:

php

JSON Returns Example:

JSON

Remark:

Error Messages:

Services Introduction:

Interface Address:

Request Method:

Request Parameters (header):

Request Parameters (urlParam):

Request Example:

php

JSON Returns Example:

JSON

Remark:

Error Messages:

Services Introduction:

Interface Address:

Request Method:

Request Parameters (header):

Request Parameters (bodyParam):

Request Example:

php

JSON Returns Example:

JSON

Remark:

Error Messages:

Services Introduction:

Interface Address: