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-v2

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
sku	string	yes	bodyParam	sku code
sn	string	yes	bodyParam	sn code
product_name	string	yes	bodyParam	product name
name_en	string	yes	bodyParam	product english name
name_cn	string	yes	bodyParam	product chinese name
price	float	yes	bodyParam	product price
size	string	yes	bodyParam	product size
color	string	yes	bodyParam	product color
brand	string	yes	bodyParam	product brand
material	string	no	bodyParam	product english material
material_cn	string	no	bodyParam	product chinese material
application	string	no	bodyParam	product english english
application_cn	string	no	bodyParam	product chinese application
hs_code	string	no	bodyParam	HS code

Request Example:

                                            <?php
$url = 'https://api.chinadivision.com/sku-create-v2';
$header = [
    'Content-Type:application/json',
    'apikey: your apikey',
];
$post_data = [
    'sku' => '350000001042',
    'sn' => '350000001042',
    'product_name' => 'Juniper Material Handbook',
    'name_en' => 'Juniper Material Handbook',
    'name_cn' => '手册',
    'price' => 5,
    'size' => '30*20*5',
    'color' => 'red',
    'brand' => 'Juniper',
    'material' => 'paper',
    'material_cn' => '纸',
    'application' => 'instructions',
    'application_cn' => '指南',
    'hs_code' => '611100000111'
];

$ch = curl_init();

curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

// 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_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

curl_setopt($ch, CURLOPT_URL, $url);
$res = curl_exec($ch);

var_dump(json_decode($res, true));

                                    

JSON Returns Example:

{
    "code": 0,
    "msg": "success",
    "data": null
}

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
91	Sku already exists
92	Sn already is Used
101	Sku can not be empty
102	Sku can contain only numbers, letters, and hyphens (-)
103	Sn can not be empty
104	Sn can contain only numbers, letters, and hyphens (-)
105	Product name can not be empty
106	product chinese name can not be empty
107	product english name can not be empty
108	The price must be greater than 0
109	Size can not be empty
110	Color can not be empty
111	Brand can not be empty

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/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();

        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

        $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',
						'declared_price' => '1.0', // declared price
                    ),
                    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',
						'declared_price' => '1.0', // declared price
                    ),
                    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',
						'declared_price' => '1.0', // declared price
                    ),
                ),
                '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:

{
        "code": 0,
        "msg": "success",
        "data": {
            "order_id": "#Te*****23",
            "sys_order_id": "S35******72"

        }
    }

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
7	The JSON data format is incorrect	The JSON data format is incorrect

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/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();

        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

        $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","serial_number": ["old-dog-70"]},
                {"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","serial_number": ["old-dog-71"]}
            ],
            "freight": "100.00",
            "tracking_number": "8888888888",
            "shipping_method": "DHL",
            "order_status": "1",
            "carrier":"DHL",
            "status": 10,
            "status_name": "Approved",
            "track_status": 101,
            "track_status_name": "In Transit"
        }
    }

Remark:

order_status: current order's state(Deprecated in future versions)
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.

status_name: Order status name
status: New order status
0 Approving
10 Approved
11 Uploaded
8 Picking
9 Packing
5 Packaged
2 Awaiting Shipping
3 Shipped
4 Special event
24 Processing
19 Reviewing
21 Processing
23 Canceled

track_status_name: Track status name
track_status: Track status
0 To be updated track
101 In Transit
111 Pick Up
112 Out For Delivery
121 Delivered
131 Alert
132 Expired
order_deduction_status: Order Deduction Status
0 No deduction
1 Deduction

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:

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/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
page_size	int	yes	urlParam	page size range 1-100
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();

        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

        $url = 'https://api.chinadivision.com/orders-info?page=1&page_size=250&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": 250,
            "page_count": 12,
            "order_count": "2966",
            "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",
                "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","serial_number": ["old-dog-70"]},
                        {"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","serial_number": ["old-dog-71"]}
                    ]
                "freight": "10.00",
                "tracking_number": "dhl432564",
                "shipping_method": "DHL-EXPRESS",
                "order_status": "3",
                "carrier": "DHL",
                "status": 10,
                "status_name": "Approved",
                "track_status": 101,
                "track_status_name": "In Transit"
            }, {
                "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",
                "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","serial_number": ["old-dog-70"]},
                        {"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","serial_number": ["old-dog-71"]}
                    ]
                "freight": "10.00",
                "tracking_number": "ems516546",
                "shipping_method": "EMS-EXPRESS",
                "order_status": "3",
                "carrier": "EMS",
                "status": 10,
                "status_name": "Approved",
                "track_status": 101,
                "track_status_name": "In Transit"
            }]
        }
    }

Remark:

order_status: current order's state(Deprecated in future versions)
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.

status_name: Order status name
status: New order status
0 Approving
10 Approved
11 Uploaded
8 Picking
9 Packing
5 Packaged
2 Awaiting Shipping
3 Shipped
4 Special event
24 Processing
19 Reviewing
21 Processing
23 Canceled

track_status_name: Track status name
track_status: Track status
0 To be updated track
101 In Transit
111 Pick Up
112 Out For Delivery
121 Delivered
131 Alert
132 Expired
order_deduction_status: Order Deduction Status
0 No deduction
1 Deduction

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:

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/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();

        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

        $url = 'https://api.chinadivision.com/order-cancel';
        $header = array(
                'Content-Type:application/json',
                '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:

{
        "code": 0,
        "msg": "success",
        "data": null
    }

Remark:

The cancel API call to cancel any orders before shipment.

Error Messages:

Error Code	Error Code Returns	Description
0	The order was successfully cancelled	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
6	The order is processing,please contact your account manager for cancellation
11	Order has been cancelled,no need to cancel again

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/order-track-list

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_ids	string	yes	urlParam	customer order id,Multiple comma-delimited

Request Example:

                                            <?php
$url = 'http://api.chinadivision.com/order-track-list?order_ids='.urlencode('#1000101,#1000102');
$header = [
    'apikey:da8ae24ea4d2b6f3513cea5fc24e4305',
    'User-Agent: Mozilla/5.0 (compatible; MSIE 5.01; Windows NT 5.0)'
];

$ch = curl_init();

// Add apikey to header
curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// HTTP request
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

curl_setopt($ch, CURLOPT_URL, $url);
$res = curl_exec($ch);
echo '<pre>';
var_dump(json_decode($res,true));


                                    

JSON Returns Example:

{
    "code": 0,
    "msg": "ok",
    "data": [
        {
            "sys_order_id": "S460977554888036690",
            "tracking_number": "S520220419144748515",
            "order_id": "#1000101",
            "track_list": [
                [
                    "2023-08-11 10:15:00",
                    "Mainland China, CN Shipment is in transit to next facility"
                ],
                [
                    "2023-08-10 09:27:56",
                    "Mainland China, CN Departed from sort facility"
                ],
                [
                    "2023-08-10 00:34:26",
                    "Mainland China, CN Arrived at origin facility"
                ],
                [
                    "2023-08-08 18:05:03",
                    "Shipment information received"
                ]
            ],
            "track_status": 121,
            "track_status_name": "Delivered",
            "error_code": 0,
            "error_msg": ""
        },
        {
            "sys_order_id": "S461495280538718762",
            "tracking_number": "S520220419144748515",
            "order_id": "#1000102",
            "track_list": [
                [
                    "2023-08-10 10:09:53",
                    "Shipment Packing"
                ],
                [
                    "2023-08-09 18:27:03",
                    "Shipment Picked Up"
                ],
                [
                    "2023-08-08 19:41:06",
                    "Ready The Shipment"
                ]
            ],
            "track_status": 101,
            "track_status_name": "In Transit",
            "error_code": 11,
            "error_msg": "Order has been cancelled"
        }
    ]
}

Remark

Get order track info data

track_status_name: Track status name
track_status: Track status
0 To be updated track
101 In Transit
111 Pick Up
112 Out For Delivery
121 Delivered
131 Alert
132 Expired
order_deduction_status: Order Deduction Status
0 No deduction
1 Deduction

error_msg：Error message
error_code: Error code
0 OK
11 Order has been cancelled

Error Messages:

Error Code	Error Code Returns	Description
0	success	success
1	Apikey can not be empty
2	Apikey does not exist
7001	invalid order id
7002	exceed 40 numbers
7003	error order ids
7004	not found order info
7005	get track info fail

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-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();

    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
    curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

        $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:

{
        "code": 0,
        "msg": "success",
        "data": {
            "product_id": "888",
            "sku": "xxxx",
            "product_name": "SKIRT",
            "product_source": "",
            "product_color": "Red",
            "product_size": "M",
            "date_added": "2016-08-29 17:46:46",
            "product_quantity": "100",
            "sent_quantity": "6",
            "stock_quantity": "94"
        }
    }

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

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-inventory-all

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

Request Example:

                                            <?php
        $ch = curl_init();

        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

        $url = 'https://api.chinadivision.com/sku-inventory-all';
        $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": [
            {
            "product_id": "888",
            "sku": "xxxx",
            "product_name": "SKIRT",
            "product_source": "",
            "product_color": "Red",
            "product_size": "M",
            "date_added": "2016-08-29 17:46:46",
            "product_quantity": "100",
            "sent_quantity": "6",
            "stock_quantity": "94"
        },
        {
            "product_id": "889",
            "sku": "xxxx",
            "product_name": "SKIRT1",
            "product_source": "",
            "product_color": "Red",
            "product_size": "M",
            "date_added": "2016-08-29 17:46:46",
            "product_quantity": "106",
            "sent_quantity": "6",
            "stock_quantity": "100"
        }
        ]
    }

Remark:

The SKU Inventory API: Get your all 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

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/inventory-log

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
sku	string	yes	urlParam	sku
date_start	string	no	urlParam	Start time, query the start time of the log creation time range.
date_end	string	no	urlParam	End time, query the end time of the log creation time range
type	string	no	urlParam	Log category: 1 inbound,2 outbound
sub_type	int	no	urlParam	Log subcategory:1: "Incoming goods warehousing"; 2: "Order cancellation warehousing"; 3: "Returned items warehousing"; 4: "Inventory surplus warehousing"; 5: "Moved in of the warehouse"; 6: "Other warehousing"; 7: "Destruction warehousing"; 8: "Transfer Inbound"; 9: "Transfer Outbound"; 10: "Order outbound"; 11: "Inventory Shortage outbound"; 12: "Moved out of the warehouse"; 13: "Destroy outbound"; 14: "Miscellaneous outbound"
page	string	no	urlParam	page
limit	string	no	urlParam	limit range 1-100

Request Example:

                                            <?php
        $ch = curl_init();

        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

        $url = 'https://api.chinadivision.com/inventory-log?sku=XXXX&date_start=2016-08-29&date_end=2016-08-30&type=1&sub_type=1&page=1&limit=10';
        $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": {
        "count": 4,
        "limit": 10,
        "page": 1,
        "ext_data": [],
        "list": [
            {
                "id": "444215057602154508",
                "qty": -31, //Operation quantity
                "total_surplus_qty": 10000, //Current inventory
                "create_date": "2023-05-10 20:45:04", //Operation time
                "product_id": 368702534887964672, //product id
                "business_no": "P62135001", //Operation number
                "main_type_name": "outbound",//Operation type name
                "type_name": "Inventory Shortage outbound",//Operation sub type name
                "product_name": "厨师刀",
                "name_en": "chef knife"
            }
        ]
    }
}

Remark:

qty:Operation quantity
total_surplus_qty: Current inventory
create_date: Operation time
product_id: product id
business_no: Operation number
main_type_name: Operation type name
type_name: Operation sub type name

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

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/editSku

Request Method:

POST

Request Parameters (header):

Parameter Name	Types	Required	Parameter Location	Description	Defaults
apikey	string	yes	header	API Key	your apikey
Content-Type	string	yes	header	Content Type	application/json

Request Parameters (urlParam):

Parameter Name	Types	Required	Parameter Location	Description
product_id	integer	yes	bodyParam	Product ID
product_name	string	yes	bodyParam	Product name
name_cn	string	no	bodyParam	Product name in Chinese
name_en	string	yes	bodyParam	Product name in English
product_url	string	yes	bodyParam	Product image link
product_color	string	yes	bodyParam	Color of the product
product_size	string	yes	bodyParam	Product size
price	string	yes	bodyParam	Product price
ability	interger	yes	bodyParam	Product property value.You can obtain the corresponding product Property value through the Property List API.
hs_code	string	yes	bodyParam	HS Code
material	string	yes	bodyParam	Material name in English
material_cn	string	no	bodyParam	Material name in Chinese
application	string	yes	bodyParam	Application name in English
application_cn	string	no	bodyParam	Application name in Chinese
brand	string	yes	bodyParam	Brand
warning_quantity	interger	no	bodyParam	Inventory warning quantity
scan_sku_code	interger	no	bodyParam	Scan serial number: 0 indicates no and 1 indicates yes
is_pack_material	interger	no	bodyParam	Whether consumables are used: 0 indicates no and 1 indicates yes
pack_material	array	no	bodyParam	Product consumables array

Data content in the product consumables array

Parameter Name	Types	Required	Parameter Location	Description	Defaults
pack_id	ingerger	yes	bodyParam	Consumable ID.You can obtain the corresponding consumable ID through the Material List API
qty	ingerger	yes	bodyParam	Quantity of consumables required for the corresponding product

Request Example:

                                            <?php
    $url = 'https://api.chinadivision.com/editSku';
    $header = [
        'Content-Type:application/json',
        'apikey: your apikey',
    ];
    $post_data = [
        "product_id" => 9771,
        "product_name" => "test",
        "name_cn" => "千纸鹤",
        "name_en" => "QZH",
        "product_url" => "https://ossus.cnstorm.com/public/20231201/20231201183121_26.png",
        "product_color" => "blue",
        "product_size" => 10,
        "price" => 10.00,
        "ability" => 65536,
        "hs_code" => "1231231",
        "material" => "test",
        "material_cn" => "test",
        "application" => "test",
        "application_cn" => "test",
        "brand" => "test",
        "warning_quantity" => 0,
        "scan_sku_code" => 0,
        "is_pack_material" => 1,
        "pack_material" => [
            [
                "pack_id" => 1,
                "qty" => 1,
            ],
            [
                "pack_id" => 2,
                "qty" => 2,
            ],
        ],
    ];

    $ch = curl_init();

    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
    curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

    // 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_SSL_VERIFYPEER, FALSE);
    curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

    curl_setopt($ch, CURLOPT_URL, $url);
    $res = curl_exec($ch);

    var_dump(json_decode($res, true));
?>

                                    

JSON Returns Example:

{
    "code": 0,
    "msg": "success",
    "data": null
}

Remark:

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

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/deleteSku

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
product_id	integer	yes	urlParam	Product ID

Request Example:

                                            <?php
    $url = 'https://api.chinadivision.com/deleteSku?product_id=123';
    $header = [
        'apikey: your apikey',
    ];

    $ch = curl_init();

    // 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, true));
?>

                                    

JSON Returns Example:

{
    "code": 0,
    "msg": "success",
    "data": null
}

Remark:

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

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/getMaterialList

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
product_id	integer	no	urlParam	Product ID

Request Example:

                                            <?php
    $url = 'https://api.chinadivision.com/getMaterialList?product_id=0';
    $header = [
        'apikey: your apikey',
    ];

    $ch = curl_init();

    // 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, true));
?>

                                    

JSON Returns Example:

{
  "code": 0,
  "msg": "success",
  "data": [
    {
      "pack_id": "271",
      "packing_name": "60*40*50CM",
      "packing_name_en": "60*40*50CM",
      "specs": "60*40*50",
      "unit": "",
      "fee": "1.00",
      "img_url": "http://ossus.cnstorm.com/chinadivision/image/no_image.jpg",
      "weight": "1.00",
      "is_charge": "1",
      "material_count": 0
    },
    {
      "pack_id": "150",
      "packing_name": "纸箱",
      "packing_name_en": "carton",
      "specs": "60*50*40",
      "unit": "个",
      "fee": "1.34",
      "img_url": "http://ossus.cnstorm.com/chinadivision/image/no_image.jpg",
      "weight": "1029.00",
      "is_charge": "1",
      "material_count": 0
    }
  ]
}

Remark:

Parameter Name	Types	Description
pack_id	interger	Consumable ID
packing_name	string	Consumable name
packing_name_en	string	Consumable name(EN)
specs	string	Consumable size
unit	string	Consumable unit
fee	string	Consumable price
img_url	string	Consumables image
weight	string	Consumable weight
is_charge	string	whether charge or not
material_count	string	Quantity of consumables required for the corresponding product

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

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/getPropertyList

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

Request Example:

                                            <?php
    $url = 'https://api.chinadivision.com/getPropertyList';
    $header = [
        'apikey: your apikey',
    ];

    $ch = curl_init();

    // 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, true));
?>

                                    

JSON Returns Example:

{
    "code": 0,
    "msg": "success",
    "data": [
        {
            "property_id": 1,
            "property_name": "普货",
            "property_value": 1,
            "property_name_en": "Genral products",
            "property_name_tw": "普貨"
        },
        {
            "property_id": 2,
            "property_name": "内电/带磁",
            "property_value": 2,
            "property_name_en": "Products with built-in Battery/Magnet",
            "property_name_tw": "内电/带磁"
        }
    ]
}

Remark:

Parameter Name	Types	Description
property_id	interger	Property ID
property_name	string	Property name
property_value	interger	Property value
property_name_en	string	Property name(EN)

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

Services Introduction:

Warehouse inbound basic information: You can obtain the basic data of the inbound reservation application through this interface, including the warehouse list, the express company list, the value-added service list, etc.

Interface Address:

https://api.chinadivision.com/package/getBasicData

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

Request Example:

                                            <?php
    $url = 'https://api.chinadivision.com/getBasicData';
    $header = [
        'apikey: your apikey',
    ];

    $ch = curl_init();

    // 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, true));
?>

                                    

JSON Returns Example:

{
    "code": 0,
    "msg": "success",
    "data": {
        "warehouseList": [
            {
                "warehouse_id": 2,
                "warehouse_name": "新安仓",
                "warehouse_code": "XA",
                "warehouse_en": "Shenzhen China"
            },
            {
                "warehouse_id": 3,
                "warehouse_name": "义乌仓库",
                "warehouse_code": "YW",
                "warehouse_en": "Yiwu China"
            }
        ],
        "expressList": [
            {
                "id": 1,
                "name": "顺丰",
                "name_en": "SF Express",
                "code": "SF"
            },
            {
                "id": 2,
                "name": "百世",
                "name_en": "Best Express",
                "code": "HTKY"
            }
        ],
        "planTimeSlotList": [
            {
                "time_type": "am",
                "time_name": "09:00~12:00"
            },
            {
                "time_type": "pm",
                "time_name": "14:00~18:00"
            }
        ],
        "valueAddedList": [
            {
                "name": "SKU贴标",
                "name_en": "SKU labeling",
                "value": 2,
                "type": 2
            },
            {
                "name": "商品组装",
                "name_en": "Assembling",
                "value": 4,
                "type": 2
            }
        ]
    }
}

Warehouse List

Parameter Name	Types	Description
warehouse_id	interger	The warehouse ID to be received
warehouse_name	string	Warehouse's Chinese name
warehouse_code	interger	Warehouse Code
warehouse_en	string	Warehouse's English name

Warehouse List

Parameter Name	Types	Description
warehouse_id	interger	The warehouse ID to be received
warehouse_name	string	Warehouse's Chinese name
warehouse_code	interger	Warehouse Code
warehouse_en	string	Warehouse's English name

Courier Company List

Parameter Name	Types	Description
id	interger	Courier company ID
name	string	Courier company's Chinese name
name_en	interger	Courier company's English name
code	string	Courier Company Code

Estimated Time of Arrival Range

Parameter Name	Types	Description
id	interger	Courier company ID
name	string	Courier company's Chinese name
name_en	interger	Courier company's English name
code	string	Courier Company Code

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

Services Introduction:

You can use this interface to create a warehousing reservation form.

Interface Address:

https://api.chinadivision.com/package/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
express_id	interval	yes	bodyParam	Courier company ID	The express_id can be retrieved through the warehouseList field in the Godown Entry Basic Data API interface.
tracking_number	string	yes	bodyParam	Tracking number for the package
square_number	interval	yes	bodyParam	Cubic volume of goods
warehouse_id	interval	yes	bodyParam	The warehouse ID to be received	The warehouse_id can be retrieved through the warehouseList field in the Godown Entry Basic Data API interface.
plan_arrival_date	string	yes	bodyParam	Estimated Arrival Date
plan_time_slot	string	yes	bodyParam	Estimated Time of Arrival	The plan_time_slot can be retrieved through the planTimeSlotList field in the Godown Entry Basic Data API interface.
remark	string	no	bodyParam	Remark
skuList	array	yes	bodyParam	The sku list of the warehousing reservation form to be deposited	The plan_time_slot can be retrieved through the planTimeSlotList field in the Godown Entry Basic Data API interface.
value_added	array	no	bodyParam	Value-added service value
other_remark	array	no	bodyParam	Other Remark	When choosing the value-added services of other, it is required to fill in
insurance	array	no	bodyParam	Commodity insurance value-added service declaration data

skuList Data

Parameter Name	Types	Required	Parameter Location	Description
box_no	interval	yes	bodyParam	Case number
sku	string	yes	bodyParam	SKU
quantity	string	yes	bodyParam	Current quantity of sku in the box
total	string	yes	bodyParam	The total quantity of all skus in the current box

insurance Data

Parameter Name	Types	Required	Parameter Location	Description
declared_value	interval	yes	bodyParam	SKU declaration price
product_id	interval	yes	bodyParam	Product ID
quantity	interval	yes	bodyParam	Current total number of reservation orders for skus

Request Example:

                                        <?php
    $url = 'https://api.chinadivision.com/package/create';
    $header = [
        'Content-Type:application/json',
        'apikey: your apikey',
    ];
    $postJson = '{
        "express_id": 1,
        "tracking_number": "test1231233",
        "square_number": 12,
        "warehouse_id": 2,
        "plan_arrival_date": "2024-01-04",
        "plan_time_slot": "am",
        "remark": "fugiat mollit occaecat irure nulla",
        "skuList": [
            {
                "box_no": "1",
                "sku": "SON1",
                "quantity": 10,
                "total": 21
            },
            {
                "box_no": "1",
                "sku": "TSKU1",
                "quantity": 11,
                "total": 21
            },
            {
                "box_no": "2",
                "sku": "SON1",
                "quantity": 22,
                "total": 22
            }
        ],
        "value_added": [
            "2",
            "4",
            "8",
            "16384"
        ],
        "other_remark": "do anim cillum elit",
        "insurance": [
            {
                "declared_value": "10",
                "product_id": "52923",
                "quantity": "30"
            },
            {
                "declared_value": "15",
                "product_id": "502",
                "quantity": "10"
            }
        ]
    }';

    $ch = curl_init();

    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
    curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

    // Add apikey to header
    curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
    // Add post_data to bodyParam
    curl_setopt($ch, CURLOPT_POSTFIELDS, $postJson);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

    // HTTP request

    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
    curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

    curl_setopt($ch, CURLOPT_URL, $url);
    $res = curl_exec($ch);

    var_dump(json_decode($res, true));

?>
                                            
                                    

JSON Returns Example:

{
    "code": 0,
    "msg": "success",
    "data": null
}

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

Services Introduction:

The purpose of this document is to explain that after enabling the webhook hook and setting up the webhook URL, when there is a change in the order status or fee status in the ChinaDivision system, the order information will be pushed to the set webhook URL. The maximum number of push times for the message is 10 times. When pushing, a HTTP status code of 200 is returned within 5 seconds to represent successful receipt, otherwise it will be considered a failure, and the message will be re-pushed until 10 times, after which the pushing will stop.

Setting up Webhook URL

Enter the www.chinadivision.com system and log in to your account. Go to the back end and click on the "Webhook URL" in the top right corner "Settings button". Fill in your webhook URL in the pop-up window and select the specified update events. Save the settings and a test message will be pushed by the system, you can receive the pushed message at the webhook URL.

Request Method:

POST

Response Parameters (header)

Parameter Name	Types	Required	Parameter Location	Description	Defaults
apikey	string	yes	header	API Key	your apikey
chinadivision-topic	string	yes	header	webhook event, eg. order.updated \| order.deductionStatusUpdated

JSON Returns Example:

{
    "order_info": {
        "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,
        "order_deduction_status": 0,
        "carrier":"DHL",
        "status": 10,
        "status_name": "Approved",
        "track_status": 101,
        "track_status_name": "In Transit"
    }
}

Remark:

order_status: current order's state(Deprecated in future versions)
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.

status_name: Order status name
status: New order status
0 Approving
10 Approved
11 Uploaded
8 Picking
9 Packing
5 Packaged
2 Awaiting Shipping
3 Shipped
4 Special event
24 Processing
19 Reviewing
21 Processing
23 Canceled

track_status_name: Track status name
track_status: Track status
0 To be updated track
101 In Transit
111 Pick Up
112 Out For Delivery
121 Delivered
131 Alert
132 Expired
order_deduction_status: Order Deduction Status
0 No deduction
1 Deduction

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	start can not be empty	start can not be empty
4	end can not be empty	end can not be empty

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 (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:

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: