Shipforwarder API

shipforwarder API

Login shipforwarder.com and get API key in User center->My account(top right)->API

Develop with test account: test@qq.com password: 123456

Need more custom functions or API? contact : jiang@shipforwarder.com

2026-07-21 updated, Add webhook

Get a waybill by ID

URL	https://www.shipforwarder.com/api/readwaybill.php
Method	GET
Request example	https://www.shipforwarder.com/api/readwaybill.php?key=&id=
Request parameter	key (Required. The API key you can get in user center) ID (Required. The waybill ID that create by shipforwarder system
Success return example	{ "status": 200, "waybill": { "id": "3806", //waybill ID "st": "20", //status. 1-pending,20-arrived warehouse,21-combining,22-spliting,23-repacking,25-combined_new,26-spilt_new, 27-combined_old,28-split_old,29-spliting_old 30-submited to ship,40-shipping,41-shipped,5-received, 70-trashed "time1": "1515319769", //Time for the waybill create or arrive warehouse "time2": "0", //Time that you submit to ship "time3": "0", //Time that we start shipping "wei": "0", //weight/g "len": "0", //length/cm "wid": "0", //width/cm "hei": "0", //height/cm "shfee": "0.00", //Shipping fee / USD "refee": "0.00", //Base fee(service fee) / USD "trno": "0", //Tracking number "trno2": "0", //Some shipping option may have second tracking number "cnote": "Do not open the parcel", //Your note for this waybill "name": "test name", //recipient "comp": "Mibab Orthodontics", //company "stre": "3005 Old Alabama Rd， Suite 6000", //street "city": "Johns Creek", "state": "Georgia", "coid": "239", //country ID in our system, not country code "zipc": "30022", //zip code "phone": "770-552-6800", "shid": "1", //Shipping method ID in our system "orderid": "1552", //Your own order ID which is custom filled by you "sen": "1", //Product type. 1-(default)normal. 2-level-2 brand product; 3- level-1 brand product; //4- With battery; 5- Pure battery; 6- Liquid or Powder "items": [ { "nm": "shirt", //English product name for custom declaration "nm2": "衬衫", //Chinese product name for custom declaration "qt": "5", //quantity for custom declaration "val": "4.00" //value of one unit for custom declaration }, { "nm": "Coat", "nm2": "外套", "qt": "2", "val": "43.00" } ], "piece": "2", // There are 2 boxes in this waybill, if more than 1 box in the waybill, pieces data will show the detail weight and size of each box. If only 1 box, there is no pieces data "pieces": [ { "wei": "1334", //weight /g "len": "13", //length /cm "wid": "12", //width /cm "hei": "11" // height /cm }, { "wei": "1334", //weight /g "len": "13", //length /cm "wid": "12", //width /cm "hei": "11" // height /cm } ], "imgs": [{ "path": "res\/wbimg\/0\/50\/", // waybill big photo URL = "https://staff.shipforwarder.com/"+path+name "name": "152903624710.jpg", // waybill thumbnail URL = "https://staff.shipforwarder.com/"+"res/wbimg2/"+Math.floor(waybill_ID/1000)+"/"+(waybill_ID%1000)+"-0.jpg"; "trno": "773432185368434" //if the photo contain shipping label barcode, we will scan and save the barcode number here, usually this is the local tracking number }, { "path": "res\/wbimg\/0\/50\/", "name": "152903624711.jpg", "trno": "0" }] } }
Fail return example	{"status":500} -- Other error {"status":501} -- API key is not correct {"status":505} -- Miss required parameter

Get waybills by status

URL	https://www.shipforwarder.com/api/readwaybills.php
Method	GET
Request example	https://www.shipforwarder.com/api/readwaybills.php?key=&st=
Request parameter	key (Required. The API key you can get in user center) st (Required. 1-Pending,20-Arrived warehouse,21-combining,22-splitting,25-combined,26-split,30-submit to ship, 40-shipping, 41-shipped, 5-received) page (Required. 0,1,2,3... Result usually have more than 1 page. So this reference tell us which page result you need to feedback )
Success return example	{ "status": 200, "waybills": [ { "id": "3805", "st": "1", "time1": "1515319112", "time2": "0", "time3": "0", "wei": "0", "len": "0", "wid": "0", "hei": "0", "shfee": "0.00", "refee": "0.00", "trno": "0", "trno2": "0", //Some shipping option may have second tracking number "cnote": "tess11", "isship": "1", "name": "tesst name", "comp": "dd", "stre": "test street", "city": "ss", "state": "ee", "coid": "239", "zipc": "sfsdd", "phone": "df43343", "shid": "1", "orderid": null, "sen": "2", "items": [ { "nm": "dsds", "nm2": "测试", "qt": "5", "val": "4.00" }, { "nm": "sdsd", "nm2": "ssds", "qt": "21", "val": "433.00" } ], "piece": "1", // There are 2 boxes in this waybill, if more than 1 box in the waybill, pieces data will show the detail weight and size of each box. If only 1 box, there is no pieces data "imgs": [{ "path": "res\/wbimg\/0\/50\/", // waybill big photo URL = "https://staff.shipforwarder.com/"+path+name "name": "152903624710.jpg", // waybill thumbnail URL = "https://staff.shipforwarder.com/"+"res/wbimg2/"+Math.floor(waybill_ID/1000)+"/"+(waybill_ID%1000)+"-0.jpg"; "trno": "773432185368434" //if the photo contain shipping label barcode, we will scan and save the barcode number here, usually this is the local tracking number }, { "path": "res\/wbimg\/0\/50\/", "name": "152903624711.jpg", "trno": "773432185368434" //if the photo contain shipping label barcode, we will scan and save the barcode number here, usually this is the local tracking number }] }, { "id": "3806", "st": "1", "time1": "1515319769", "time2": "0", "time3": "0", "wei": "0", "len": "0", "wid": "0", "hei": "0", "shfee": "0.00", "refee": "0.00", "trno": "0", "cnote": "Do not open the parcel", "isship": "1", "name": "test name", "comp": "Mibab Orthodontics", "stre": "3005 Old Alabama Rd， Suite 6000", "city": "Johns Creek", "state": "Georgia", "coid": "239", "zipc": "30022", "phone": "770-552-6800", "shid": "1", "orderid": "1552", "sen": "1", "items": [ { "nm": "shirt", "nm2": "衬衫", "qt": "5", "val": "4.00" }, { "nm": "Coat", "nm2": "外套", "qt": "2", "val": "43.00" } ], "piece": "2", // There are 2 boxes in this waybill, if more than 1 box in the waybill, pieces data will show the detail weight and size of each box. If only 1 box, there is no pieces data "pieces": [ { "wei": "1334", //weight /g "len": "13", //length /cm "wid": "12", //width /cm "hei": "11" // height /cm }, { "wei": "1334", //weight /g "len": "13", //length /cm "wid": "12", //width /cm "hei": "11" // height /cm } ], "imgs": [{ "path": "res\/wbimg\/0\/50\/", // waybill big photo URL = "https://staff.shipforwarder.com/"+path+name "name": "152903624710.jpg", // waybill thumbnail URL = "https://staff.shipforwarder.com/"+"res/wbimg2/"+Math.floor(waybill_ID/1000)+"/"+(waybill_ID%1000)+"-0.jpg"; "trno": "773432185368434" //if the photo contain shipping label barcode, we will scan and save the barcode number here, usually this is the local tracking number }, { "path": "res\/wbimg\/0\/50\/", "name": "152903624711.jpg", "trno": "0" //if the photo contain shipping label barcode, we will scan and save the barcode number here, usually this is the local tracking number }] } ] }
Fail return example	{"status":500} -- Other error {"status":501} -- API key is not correct {"status":505} -- Miss required parameter

Get a waybill by local track number

URL	https://www.shipforwarder.com/api/readwaybill2.php
Method	GET
Request example	https://www.shipforwarder.com/api/readwaybill2.php?key=&localtrack=
Request parameter	key (Required. The API key you can get in user center) localtrack (Required. The local tracking number that you want to search )
Note	If the shipping label barcode is damaged and cannot be scaned, it will fail to search even parcel is in system. Usually >99% is scanable
Success return example	{ "status": 200, "waybill": { "id": "3806", //waybill ID "st": "20", //status. 1-pending,20-arrived warehouse,21-combining,22-spliting,23-repacking,25-combined_new,26-spilt_new, 27-combined_old,28-split_old,29-spliting_old 30-submited to ship,40-shipping,41-shipped,5-received, 70-trashed "time1": "1515319769", //Time for the waybill create or arrive warehouse "time2": "0", //Time that you submit to ship "time3": "0", //Time that we start shipping "wei": "0", //weight/g "len": "0", //length/cm "wid": "0", //width/cm "hei": "0", //height/cm "shfee": "0.00", //Shipping fee / USD "refee": "0.00", //Base fee(service fee) / USD "trno": "0", //Tracking number "trno2": "0", //Some shipping option may have second tracking number "cnote": "Do not open the parcel", //Your note for this waybill "name": "test name", //recipient "comp": "Mibab Orthodontics", //company "stre": "3005 Old Alabama Rd， Suite 6000", //street "city": "Johns Creek", "state": "Georgia", "coid": "239", //country ID in our system, not country code "zipc": "30022", //zip code "phone": "770-552-6800", "shid": "1", //Shipping method ID in our system "orderid": "1552", //Your own order ID which is custom filled by you "sen": "1", //Product type. 1-(default)normal. 2-level-2 brand product; 3- level-1 brand product; //4- With battery; 5- Pure battery; 6- Liquid or Powder "items": [ { "nm": "shirt", //English product name for custom declaration "nm2": "衬衫", //Chinese product name for custom declaration "qt": "5", //quantity for custom declaration "val": "4.00" //value of one unit for custom declaration }, { "nm": "Coat", "nm2": "外套", "qt": "2", "val": "43.00" } ], "piece": "2", // There are 2 boxes in this waybill, if more than 1 box in the waybill, pieces data will show the detail weight and size of each box. If only 1 box, there is no pieces data "pieces": [ { "wei": "1334", //weight /g "len": "13", //length /cm "wid": "12", //width /cm "hei": "11" // height /cm }, { "wei": "1334", //weight /g "len": "13", //length /cm "wid": "12", //width /cm "hei": "11" // height /cm } ], "imgs": [{ "path": "res\/wbimg\/0\/50\/", // waybill big photo URL = "https://staff.shipforwarder.com/"+path+name "name": "152903624710.jpg", // waybill thumbnail URL = "https://staff.shipforwarder.com/"+"res/wbimg2/"+Math.floor(waybill_ID/1000)+"/"+(waybill_ID%1000)+"-0.jpg"; "trno": "773432185368434" //if the photo contain shipping label barcode, we will scan and save the barcode number here, usually this is the local tracking number }, { "path": "res\/wbimg\/0\/50\/", "name": "152903624711.jpg", "trno": "0" }] } }
Fail return example	{"status":500} -- Other error {"status":501} -- API key is not correct {"status":505} -- Miss required parameter {"status":511} -- Cannot find this local tracking number

Get shipping quote 1

URL	https://www.shipforwarder.com/api/getwaybillship.php
Method	GET
Request example	https://www.shipforwarder.com/api/getwaybillship.php?key=&id=&countrycode=*
Request parameter	key (Required. The API key you can get in user center) id (Required. Waybill ID) countrycode (Required. Such as "United state"-> "US" The country ISO code )
Note	This API will use the country code you now provide to calculate shipping quote, will not use the address data in this waybill
Success return example	{ "status": 200, "refee": "1.02", //Base service fee "wei": "1111", "len": "1", "wid": "1", "hei": "1", "ship": [ { "shipfee": 35.57, //shpping fee "minday": "3", //MIN deliver time /day "maxday": "6", //MAX deliver time /day "note": "0", //Important note for this shipping method "shid": "1" //Shipping methid ID }, { "shipfee": 39.24, "minday": "3", "maxday": "6", "note": "0", "shid": "4" }, { "shipfee": 29.7, "minday": "3", "maxday": "6", "note": "0", "shid": "3" }, { "shipfee": 24.1, "minday": "3", "maxday": "16", "note": "0", "shid": "6" }, { "shipfee": 18.06, "minday": "7", "maxday": "30", "note": "0", "shid": "7" }, { "shipfee": 45.8, "minday": "7", "maxday": "18", "note": "0", "shid": "8" } ] }
Fail return example	{"status":500} -- Other error {"status":501} -- API key is not correct {"status":505} -- Miss required parameter {"status":522} -- Cannot find this order {"status":530} -- The shipping method you request do not support the country or the weight range {"status":533} -- Can not find the country code

Get shipping quote 2

URL	https://www.shipforwarder.com/api/getship.php
Method	GET
Request example	https://www.shipforwarder.com/api/getship.php?key=&countrycode=&wei=&len=&wid=&hei=sen=*
Request parameter	key (Required. The API key you can get in user center) countrycode (Required. Such as "United state"-> "US" The country ISO code ) wei (Required. Weight /g ) len (Optional. Lenth cm ) wid (Optional. Width cm ) hei (Optional. Height cm )
Success return example	{ "status": 200, "countryname": "Australia", "ship": [ { "shipfee": 35.57, "minday": "3", "maxday": "6", "note": "0", "shipid": "1" }, { "shipfee": 39.24, "minday": "3", "maxday": "6", "note": "0", "shipid": "4" }, { "shipfee": 29.7, "minday": "3", "maxday": "6", "note": "0", "shipid": "3" }, { "shipfee": 24.1, "minday": "3", "maxday": "16", "note": "0", "shipid": "6" }, { "shipfee": 20.82, "minday": "7", "maxday": "30", "note": "0", "shipid": "7" }, { "shipfee": 17.45, "minday": "7", "maxday": "18", "note": "0", "shipid": "9" }, { "shipfee": 33.95, "minday": "7", "maxday": "15", "note": "0", "shipid": "18" }, { "shipfee": 28.78, "minday": "8", "maxday": "30", "note": "0", "shipid": "22" }, { "shipfee": 52.6, "minday": "7", "maxday": "18", "note": "0", "shipid": "8" } ] }
Fail return example	{"status":500} -- Other error {"status":501} -- API key is not correct {"status":505} -- Miss required parameter {"status":522} -- Cannot find this order {"status":530} -- The shipping method you request do not support the country or the weight range {"status":533} -- Can not find the country code

Get shipping rate

URL	https://www.shipforwarder.com/api/getshiprate.php
Method	GET
Request example	https://www.shipforwarder.com/api/getshiprate.php
Request parameter	key (Required. The API key you can get in user center)
Note	This is all the orginal shipping rate data from our SQL database You can save in your own database, and get any shipping cost from your own server. We don't usually change the data, so you update it over 30 days a time should be OK. cBut it's not easy to understand how to calculate
Success return example	[{ "coid": "137", //countryid "shid": "1", //shipping method ID "fwei": "500", // first weight define /g "awei": "500", // added weight define/g "ffee": "115.76", // first weight cost / USD "afee": "41.63", // added weight cost / USD "weibo": "21000", // weight bound for big weight price, If there a data here, mean when weight > this data, we should calculate the shipping cost base on bofwei,boawei,boffee,boafee "bofwei": "1000", //When weight >weight bound, first weight define /g "boawei": "1000", //When weight >weight bound, added weight define /g "boffee": "37.17",//When weight >weight bound, first weight cost/ USD "boafee": "37.17",//When weight >weight bound, added weight cost/ USD "fufee": "18.00", // Fuel surcharge "refee": "0.00", // register fee "sen2": "15.00", // % , copy brand extra fee, >1000 mean not accept copy brand for this rule "sen3": "25.00", // % , famous copy brand extra fee, >1000 mean not accept famous copy brand for this rule "sen4": "10.00", // % , with battery/magnetic extra fee, >1000 mean not accept battery/magnetic for this rule "sen5": "2000.00", // % , pure battery extra fee, >1000 mean not accept battery for this rule "sen6": "2000.00", // % , liquid or powder extra fee, >1000 mean not accept liquid or powder for this rule "minwei": "0", // Minimum weight for the rule /g "maxwei": "0", // Maximum weight for the rule /g "typ": "1", //the way how to calculate volume weight. "date1": "3", //Minimum Shipping time /day only for reference "date2": "7", //Maximum Shipping time /day only for reference "note": "0", //special note for this rule "time": "1532070878" //Lastest update time for this rule },{ "coid": "83", "shid": "6", "fwei": "500", "awei": "500", "ffee": "180.00", "afee": "56.00", "weibo": "0", "bofwei": "0", "boawei": "0", "boffee": "0.00", "boafee": "0.00", "fufee": "0.00", "refee": "4.00", "sen2": "15.00", "sen3": "25.00", "sen4": "2000.00", "sen5": "2000.00", "sen6": "2000.00", "minwei": "0", "maxwei": "30000", "typ": "2", "date1": "3", "date2": "16", "note": "0", "time": "1534496043" }]
Fail return example	{"status":500} -- Other error {"status":501} -- API key is not correct {"status":505} -- Miss required parameter
PHP Example code to calculate a shipping cost	//You can replace the reference to your own weight and size. $weight unit =g, $length unit =cm //countryid, shipid please check the list above, $countryid=235; $shipid=1; $weight=1000; $length=12; $width=13; $height=14; $sen=1 // sen2-brand product, sen3-famous brand product, sen4-with battery(magnetic), sen5-pure battery, sen6-liquid or powder $sens=array(0,0,'sen2','sen3','sen4','sen5','sen6'); //find the shipping rule that fit this country and shipping method $stmt2 = $conn->prepare("SELECT shid,fwei,awei,ffee,afee,weibo,bofwei,boawei,boffee,boafee,fufee,refee,".$sens[$row1['sen']]." ,maxwei,typ FROM ship WHERE coid =? AND shid =? AND ".$sens[$row1['sen']]." BETWEEN 0 AND 1000 AND maxwei NOT BETWEEN 1 AND ? AND minwei <= ? " ); $stmt2->execute(array($coid,$shipid,$weight,$weight )); $row2 = $stmt2->fetch(PDO::FETCH_ASSOC) or die(json_encode(array('status'=>530)));//No shipping rule is suitable // Check "typ", so we know how to calculate volume weight. switch ($row2['typ']) { case 1: $wei=$weight>$length$width$height/5 ? $weight:$length$width$height/5; break; case 2: $wei=$weight; break; case 3: $wei=$weight>$length$width$height/2 ? $weight:$length$width$height/2; break; case 4: $wei=$weight>$length$width$height/6 ? $weight:$length$width$height/6; break; case 7: $wei=$weight>$length$width$height/7 ? $weight:$length$width$height/7; break; case 8: $wei=$weight>$length$width$height/8 ? $weight:$length$width$height/8; break; case 9: $wei=$weight>$length$width$height/9 ? $weight:$length$width$height/9; break; case 10: $wei=$weight>$length$width$height/10 ? $weight:$length$width$height/10; break; case 12: $wei=$weight>$length$width$height/12 ? $weight:$length$width$height/12; break; default: $wei=$weight>$length$width$height/5 ? $weight:$length$width$height/5; } if($wei<=$row2['weibo']\|\|$row2['weibo']==0){ $addedcount1=($wei-$row2['fwei'])>0?($wei-$row2['fwei'])/$row2['awei']:0; $addedcount=ceil($addedcount1); $sensp=($row1['sen']==1?0:$row2[$sens[$row1['sen']]]/100)+1; $shippingcost=($row2['ffee']+$row2['afee']$addedcount+$row2['refee'])($row2['fufee']/100+1)$sensp; } else{ $addedcount1=($wei-$row2['bofwei'])>0?($wei-$row2['bofwei'])/$row2['boawei']:0; $addedcount=ceil($addedcount1); $sensp=($row1['sen']==1?0:$row2[$sens[$row1['sen']]]/100)+1; $shippingcost=($row2['boffee']+$row2['boafee']$addedcount+$row2['refee'])($row2['fufee']/100+1)$sensp; } //$shippingcost is the final result

Read message

URL	https://www.shipforwarder.com/api/readmessage.php
Method	GET
Request example	https://www.shipforwarder.com/api/readmessage.php?key=&id=
Request parameter	key (Required. The API key you can get in user center) id (Required. waybill ID)
Success return example	{ "status": 200, "message": [ { "id": "630", //Message ID "wbid": "3806", //Waybill ID which this message belong to "cuid": "5531", //Customer ID that send the message, 0 mean it's sent by our worker "stid": "0", //Worker ID that send the message, 0 mean it's sent by you "time": "1515338983", "note": "Take more photo for me" }, { "id": "631", "wbid": "3806", "cuid": "0", "stid": "72", "time": "1515339075", "note": "OK, Will take when they arrive at our warehouse" } ] }
Fail return example	{"status":500} -- Other error {"status":501} -- API key is not correct {"status":505} -- Miss required parameter

Send message

URL	https://www.shipforwarder.com/api/sendmessage.php
Method	GET
Request example	https://www.shipforwarder.com/api/sendmessage.php?key=&id=&message=*
Request parameter	key (Required. The API key you can get in user center) id (Required. waybill ID) message (Required. Content of the message to remind something of this waybill to our worker )
Success return example	{ "status": 200, "time": 1515338983, "id": "3806", //Waybill ID "message": "Take more photo for me" }
Fail return example	{"status":500} -- Other error {"status":501} -- API key is not correct {"status":505} -- Miss required parameter

Submit to ship

URL	https://www.shipforwarder.com/api/shipwaybill.php
Method	GET
Request example	https://www.shipforwarder.com/api/shipwaybill.php?key=&id=&shid=&recipient=&company=&street=&city=&state=&countrycode=&zipcode=&phone=& declarenamecn[0]=&declarenameen[0]=&unitvalue[0]=&qty[0]=&declarenamecn[1]=&declarenameen[1]=&unitvalue[1]=&qty[1]=*...cc
Request parameter	key (Required. The API key you can get in user center) id (Required.) shid (Required, The ID of shipping way. The shipping way list is shown below . System API appendices->shipping method) recipient (Required) company (Optional) street (Required) city (Required) state (Required) countrycode (Required, Such as "United state"-> "US" The country ISO code list is shown at System API appendices->country) zipcode (Required) phone (Required) declarenameen[] (Optional. The English name for custom declaration) declarenamecn[] (Optional. The Chinese name for custom declaration) qty[] (Optional. The quantity of the product for custom declaration) unitvalue[] (Optional. $ USD , The unit value of the product for custom declaration)
Note	The address and shipping methed ID you filled will cover and replace the exist one in waybill
Success return example	{ "status": 200, "id": "3807", "shfee": 33.25, "refee": "1.16", "shipname": "China DHL", "countryname": "USA", "declaration": [{ "declarenameen": "test1", "declarenamecn": "测试一", "qty": "11", "unitvalue": "1.00" }, { "declarenameen": "test2", "declarenamecn": "测试二", "qty": "22", "unitvalue": "2.00" }] }
Fail return example	{"status":500} -- Other error {"status":501} -- API key is not correct {"status":505} -- Miss required parameter {"status":510} -- Balance is not enough. Make sure your account balance >=5 CNY {"status":522} -- Cannot find this waybill or this waybill still not ready to be shipped {"status":530} -- The shipping method you request do not support the country or the weight range {"status":533} -- Can not find the country code

Create pending waybill

URL	https://www.shipforwarder.com/api/createwaybill.php
Method	GET
Request example	https://www.shipforwarder.com/api/createwaybill.php?key=¬e=&orderid=&isship=&shid=&sen=&recipient=&company=&street=&city=&state=&countrycode=&zipcode=&phone=&declarenamecn[0]=&declarenameen[0]=&unitvalue[0]=&qty[0]=&declarenamecn[1]=&declarenameen[1]=&unitvalue[1]=&qty[1]=...
Request parameter	key (Required. The API key you can get in user center) note (Optional, Note something about this waybill) orderid (Optional, Your order ID in your system) isship (Optional, 1-Ship immediately when we receive your parcel(if balance not enough or shipping method is not support, auto ship will be fail then need you manually edit and ship it again); 0-(default)don't ship and put it storage in warehouse until your futher request) shid (Require, The ID of shipping way. The shipping way list is shown below) sen (Optional,The kind of goods. 1-(default)normal. 2-level-2 brand product; 3- level-1 brand product; 4- With battery; 5- Pure battery; 6- Liquid or Powder ) recipient (Required) company (Optional) street (Required) city (Required) state (Required) countrycode (Required, Such as "United state"-> "US" The country ISO code list is shown at the bottom) zipcode (Required) phone (Required) declarenamecn[] (Optional, The Chinese product name of custom declaration) declarenameen[] (Optional, The English product name of custom declaration) unitvalue[] (Optional, Value of one unit for custom declaration/ USD) qty[] (Optional, Quantity for custom declaration)
Note	To avoid abuse, this API default is close, need to talk with us to open it. Our warehouse can identify your parcel by the waybill ID in our system or orderid (your system order ID). But you need to let us know which type of ID you will mark on the parcel.
Success return example	{ "status": 200, "waybill": { "id": "3806", //Waybill ID "time1": "1515319769", "cnote": "Do not open the parcel", "isship": "1", "name": "Evie Comer", //recipient "comp": "Mibab Orthodontics", //Company "stre": "3005 Old Alabama Rd， Suite 6000", //Street "city": "Johns Creek", "state": "Georgia", "coid": "239", "zipc": "30022", "phone": "770-552-6800", "shid": "1", "orderid": "1552", "sen": "1", "items": [ //custom declaration content { "nm": "shirt", "nm2": "衬衫", "qt": "5", "val": "4.00" }, { "nm": "Coat", "nm2": "外套", "qt": "2", "val": "43.00" } ] } }
Fail return example	{"status":500} -- Others error {"status":501} -- API key is not correct {"status":234} -- Your pending waybill is over limited! You can contact us to increase {"status":505} -- Miss required parameter {"status":565} -- API default is close, need to talk with us to open it.

Webhook

Go to user center->My account->API to set the webhook URL and notification type

Note: All webhook will click your URL by POST method.
{your URL}+ POST data (json format)

New income waybill:

{
	"type": 1,
	"data": {
		"id": "3806",			//waybill ID
		"st": "20",				//status. 1-pending,20-arrived warehouse,21-combining,22-spliting,23-repacking,25-combined_new,26-spilt_new,
									27-combined_old,28-split_old,29-spliting_old 30-submited to ship,40-shipping,41-shipped,5-received, 70-trashed
		"time1": "1515319769",	//Time for the waybill create or arrive warehouse
		"wei": "0",				//weight/g
		"len": "0",				//length/cm
		"wid": "0",				//width/cm
		"hei": "0",				//height/cm
		"sen": "1",			//Product type. 1-(default)normal. 2-level-2 brand product; 3- level-1 brand product; 
								//4- With battery; 5- Pure battery; 6- Liquid or Powder
		"imgs": [{
			"path": "res\/wbimg\/0\/50\/",    // waybill big photo URL = "https://staff.shipforwarder.com/"+path+name
			"name": "152903624710.jpg",       // waybill thumbnail URL = "https://staff.shipforwarder.com/"+"res/wbimg2/"+Math.floor(waybill_ID/1000)+"/"+(waybill_ID%1000)+"-0.jpg";
			"trno": "773432185368434"   //if the photo contain shipping label barcode, we will scan and save the barcode number here, usually this is the local tracking number
		}, {
			"path": "res\/wbimg\/0\/50\/",
			"name": "152903624711.jpg",
			"trno": "0"
		}]
	}
}

Combine operation finished:

{
	"type": 2,
	"data": {
		"id": "3806",			//waybill ID
		"st": "20",				//status. 1-pending,20-arrived warehouse,21-combining,22-spliting,23-repacking,25-combined_new,26-spilt_new,
									27-combined_old,28-split_old,29-spliting_old 30-submited to ship,40-shipping,41-shipped,5-received, 70-trashed
		"time1": "1515319769",	//Time for the waybill create or arrive warehouse
		"wei": "0",				//weight/g
		"len": "0",				//length/cm
		"wid": "0",				//width/cm
		"hei": "0",				//height/cm
		"sen": "1",			//Product type. 1-(default)normal. 2-level-2 brand product; 3- level-1 brand product; 
								//4- With battery; 5- Pure battery; 6- Liquid or Powder
		"subwaybills": [
			{
				"id": "3816",
				"st": "27",
				"time1": "1515319769",
				"wei": "0",	
				"len": "0",	
				"wid": "0",	
				"hei": "0",	
				"sen": "1"
			},
			{
				"id": "3826",
				"st": "27",
				"time1": "1515319769",
				"wei": "0",	
				"len": "0",	
				"wid": "0",	
				"hei": "0",	
				"sen": "1"
			}
		],
		"piece": "2",	// There are 2 boxes in this waybill, if more than 1 box in the waybill, pieces data will show the detail weight and size of each box. If only 1 box, there is no pieces data
		"pieces": [
			{
				"wei": "1334",	//weight /g
				"len": "13",	//length /cm
				"wid": "12",		//width /cm
				"hei": "11"	// height /cm
			},
			{
				"wei": "1334",	//weight /g
				"len": "13",	//length /cm
				"wid": "12",		//width /cm
				"hei": "11"	// height /cm
			}
		],
		"imgs": [{
			"path": "res\/wbimg\/0\/50\/",    // waybill big photo URL = "https://staff.shipforwarder.com/"+path+name
			"name": "152903624710.jpg",       // waybill thumbnail URL = "https://staff.shipforwarder.com/"+"res/wbimg2/"+Math.floor(waybill_ID/1000)+"/"+(waybill_ID%1000)+"-0.jpg";
			"trno": "773432185368434"   //if the photo contain shipping label barcode, we will scan and save the barcode number here, usually this is the local tracking number
		}, {
			"path": "res\/wbimg\/0\/50\/",
			"name": "152903624711.jpg",
			"trno": "0"
		}]
	}
}

Split operation finished:

{
	"type": 3,
	"data": {
		"id": "3806",			//waybill ID
		"st": "20",				//status. 1-pending,20-arrived warehouse,21-combining,22-spliting,23-repacking,25-combined_new,26-spilt_new,
									27-combined_old,28-split_old,29-spliting_old 30-submited to ship,40-shipping,41-shipped,5-received, 70-trashed
		"time1": "1515319769",	//Time for the waybill create or arrive warehouse
		"wei": "0",				//weight/g
		"len": "0",				//length/cm
		"wid": "0",				//width/cm
		"hei": "0",				//height/cm
		"sen": "1",			//Product type. 1-(default)normal. 2-level-2 brand product; 3- level-1 brand product; 
								//4- With battery; 5- Pure battery; 6- Liquid or Powder
		"piece": "2",	// There are 2 boxes in this waybill, if more than 1 box in the waybill, pieces data will show the detail weight and size of each box. If only 1 box, there is no pieces data
		"pieces": [
			{
				"wei": "1334",	//weight /g
				"len": "13",	//length /cm
				"wid": "12",		//width /cm
				"hei": "11"	// height /cm
			},
			{
				"wei": "1334",	//weight /g
				"len": "13",	//length /cm
				"wid": "12",		//width /cm
				"hei": "11"	// height /cm
			}
		],
		"imgs": [{
			"path": "res\/wbimg\/0\/50\/",    // waybill big photo URL = "https://staff.shipforwarder.com/"+path+name
			"name": "152903624710.jpg",       // waybill thumbnail URL = "https://staff.shipforwarder.com/"+"res/wbimg2/"+Math.floor(waybill_ID/1000)+"/"+(waybill_ID%1000)+"-0.jpg";
			"trno": "773432185368434"   //if the photo contain shipping label barcode, we will scan and save the barcode number here, usually this is the local tracking number
		}, {
			"path": "res\/wbimg\/0\/50\/",
			"name": "152903624711.jpg",
			"trno": "0"
		}]
	}
}

Waybill is shipped and tracking number just added:

{
	"type": 4,
	"data": {
       "id": "3806",			//waybill ID
		"st": "20",				//status. 1-pending,20-arrived warehouse,21-combining,22-spliting,23-repacking,25-combined_new,26-spilt_new,
									27-combined_old,28-split_old,29-spliting_old 30-submited to ship,40-shipping,41-shipped,5-received, 70-trashed
        "time1": "1515319769",	//Time for the waybill create or arrive warehouse
        "time2": "0",			//Time that you submit to ship
        "time3": "0",			//Time that we start shipping
        "wei": "0",				//weight/g
        "len": "0",				//length/cm
        "wid": "0",				//width/cm
        "hei": "0",				//height/cm
        "shfee": "0.00",		//Shipping fee / USD
        "refee": "0.00",		//Base fee(service fee) / USD
        "trno": "0",			//Tracking number
        "trno2": "0",			//Some shipping option may have second tracking number
        "cnote": "Do not open the parcel",	//Your note for this waybill
        "name": "test name",    //recipient
        "comp": "Mibab Orthodontics",		//company
        "stre": "3005 Old Alabama Rd， Suite 6000",	//street
        "city": "Johns Creek",						
        "state": "Georgia",
        "coid": "239",			//country ID in our system, not country code
        "zipc": "30022",		//zip code
        "phone": "770-552-6800",
        "shid": "1",			//Shipping method ID in our system
        "orderid": "1552",		//Your own order ID which is custom filled by you
        "sen": "1",			//Product type. 1-(default)normal. 2-level-2 brand product; 3- level-1 brand product; 
								//4- With battery; 5- Pure battery; 6- Liquid or Powder
        "items": [
            {
                "nm": "shirt",	//English product name for custom declaration
                "nm2": "衬衫",	//Chinese product name for custom declaration
                "qt": "5",		//quantity for custom declaration
                "val": "4.00"	//value of one unit for custom declaration
            },
            {
                "nm": "Coat",
                "nm2": "外套",
                "qt": "2",
                "val": "43.00"
            }
        ],
		"piece": "2",	// There are 2 boxes in this waybill, if more than 1 box in the waybill, pieces data will show the detail weight and size of each box. If only 1 box, there is no pieces data
        "pieces": [
            {
                "wei": "1334",	//weight /g
                "len": "13",	//length /cm
                "wid": "12",		//width /cm
                "hei": "11"	// height /cm
            },
            {
                "wei": "1334",	//weight /g
                "len": "13",	//length /cm
                "wid": "12",		//width /cm
                "hei": "11"	// height /cm
            }
        ],
		"imgs": [{
			"path": "res\/wbimg\/0\/50\/",    // waybill big photo URL = "https://staff.shipforwarder.com/"+path+name
			"name": "152903624710.jpg",       // waybill thumbnail URL = "https://staff.shipforwarder.com/"+"res/wbimg2/"+Math.floor(waybill_ID/1000)+"/"+(waybill_ID%1000)+"-0.jpg";
			"trno": "773432185368434"   //if the photo contain shipping label barcode, we will scan and save the barcode number here, usually this is the local tracking number
		}, {
			"path": "res\/wbimg\/0\/50\/",
			"name": "152903624711.jpg",
			"trno": "0"
		}]
	}
}

Waybill weight or size changed:

{
	"type": 7,
	"data": {
       "id": "3806",			//waybill ID
		"st": "20",				//status. 1-pending,20-arrived warehouse,21-combining,22-spliting,23-repacking,25-combined_new,26-spilt_new,
									27-combined_old,28-split_old,29-spliting_old 30-submited to ship,40-shipping,41-shipped,5-received, 70-trashed
        "time1": "1515319769",	//Time for the waybill create or arrive warehouse
        "wei": "0",				//weight/g
        "len": "0",				//length/cm
        "wid": "0",				//width/cm
        "hei": "0",				//height/cm
        "sen": "1",			//Product type. 1-(default)normal. 2-level-2 brand product; 3- level-1 brand product; 
								//4- With battery; 5- Pure battery; 6- Liquid or Powder
		"piece": "2",	// There are 2 boxes in this waybill, if more than 1 box in the waybill, pieces data will show the detail weight and size of each box. If only 1 box, there is no pieces data
        "pieces": [
            {
                "wei": "1334",	//weight /g
                "len": "13",	//length /cm
                "wid": "12",		//width /cm
                "hei": "11"	// height /cm
            },
            {
                "wei": "1334",	//weight /g
                "len": "13",	//length /cm
                "wid": "12",		//width /cm
                "hei": "11"	// height /cm
            }
        ],
		"imgs": [{
			"path": "res\/wbimg\/0\/50\/",    // waybill big photo URL = "https://staff.shipforwarder.com/"+path+name
			"name": "152903624710.jpg",       // waybill thumbnail URL = "https://staff.shipforwarder.com/"+"res/wbimg2/"+Math.floor(waybill_ID/1000)+"/"+(waybill_ID%1000)+"-0.jpg";
			"trno": "773432185368434"   //if the photo contain shipping label barcode, we will scan and save the barcode number here, usually this is the local tracking number
		}, {
			"path": "res\/wbimg\/0\/50\/",
			"name": "152903624711.jpg",
			"trno": "0"
		}]
	}
}

Waybill tracking number changed <br>or second tracking number added:

{
	"type": 8,
	"data": {
       "id": "3806",			//waybill ID
		"st": "20",				//status. 1-pending,20-arrived warehouse,21-combining,22-spliting,23-repacking,25-combined_new,26-spilt_new,
									27-combined_old,28-split_old,29-spliting_old 30-submited to ship,40-shipping,41-shipped,5-received, 70-trashed
        "time1": "1515319769",	//Time for the waybill create or arrive warehouse
        "time2": "0",			//Time that you submit to ship
        "time3": "0",			//Time that we start shipping
        "wei": "0",				//weight/g
        "len": "0",				//length/cm
        "wid": "0",				//width/cm
        "hei": "0",				//height/cm
        "shfee": "0.00",		//Shipping fee / USD
        "refee": "0.00",		//Base fee(service fee) / USD
        "trno": "0",			//Tracking number
        "trno2": "0",			//Some shipping option may have second tracking number
        "cnote": "Do not open the parcel",	//Your note for this waybill
        "name": "test name",    //recipient
        "comp": "Mibab Orthodontics",		//company
        "stre": "3005 Old Alabama Rd， Suite 6000",	//street
        "city": "Johns Creek",						
        "state": "Georgia",
        "coid": "239",			//country ID in our system, not country code
        "zipc": "30022",		//zip code
        "phone": "770-552-6800",
        "shid": "1",			//Shipping method ID in our system
        "orderid": "1552",		//Your own order ID which is custom filled by you
        "sen": "1",			//Product type. 1-(default)normal. 2-level-2 brand product; 3- level-1 brand product; 
								//4- With battery; 5- Pure battery; 6- Liquid or Powder
        "items": [
            {
                "nm": "shirt",	//English product name for custom declaration
                "nm2": "衬衫",	//Chinese product name for custom declaration
                "qt": "5",		//quantity for custom declaration
                "val": "4.00"	//value of one unit for custom declaration
            },
            {
                "nm": "Coat",
                "nm2": "外套",
                "qt": "2",
                "val": "43.00"
            }
        ],
		"piece": "2",	// There are 2 boxes in this waybill, if more than 1 box in the waybill, pieces data will show the detail weight and size of each box. If only 1 box, there is no pieces data
        "pieces": [
            {
                "wei": "1334",	//weight /g
                "len": "13",	//length /cm
                "wid": "12",		//width /cm
                "hei": "11"	// height /cm
            },
            {
                "wei": "1334",	//weight /g
                "len": "13",	//length /cm
                "wid": "12",		//width /cm
                "hei": "11"	// height /cm
            }
        ],
		"imgs": [{
			"path": "res\/wbimg\/0\/50\/",    // waybill big photo URL = "https://staff.shipforwarder.com/"+path+name
			"name": "152903624710.jpg",       // waybill thumbnail URL = "https://staff.shipforwarder.com/"+"res/wbimg2/"+Math.floor(waybill_ID/1000)+"/"+(waybill_ID%1000)+"-0.jpg";
			"trno": "773432185368434"   //if the photo contain shipping label barcode, we will scan and save the barcode number here, usually this is the local tracking number
		}, {
			"path": "res\/wbimg\/0\/50\/",
			"name": "152903624711.jpg",
			"trno": "0"
		}]
	}
}

Appendices / Shipping methods

In API, you must fill the shipping method ID instead of name
1."China DHL", 2."China UPS", 3."China TNT", 4."China FEDEX", 5."China ARAMEX",6."EMS",7."China Post small parcel by air", 8."HongKong Post Air Mail", 9."Guangzhou ePacket", 10."Road Freight To Door", 11."Road Freight", 12."Air Freight To Door", 13."Air Freight", 14."Ocean Freight To Door",15."Ocean Freight", 16."Normal Express",17."SF-express", 18."dhl global mail",19."Fedex-packet", 20."UK packet",21."Normal packet",22."PostNL", 23."Epacket-fast",24."Malaysia post", 25."Singapore Post",26."Sweden Post", 27."USPS packet",28."DPEX", 29."Road Freight To Door(tax free)", 30."Air Freight To Door(tax free)", 31."Ocean Freight To Door(tax free)", 32."Pick up",33."Air Freight(tax free)", 34."Ocean Freight(tax free)", 35."STO(申通)", 36."YT(圆通)",37."ZTO(中通)", 38."BEST(百世)", 39."YUNDA(韵达)", 40."TK(天天)",41."DEPPON(德邦)", 42."ANE(安能)" 43. "SF-packet ,44. “SF-E-commerce” 45. "China post big parcel Surface" 46. "LWE express" , 47."China post big parcel by air" , 48."China post big parcel SAL", 49."ETK", 50."Hongkong DHL", 51."Taiwan DHL", 52."Hongkong UPS", 53."Hongkong FEDEX", 54."Hongkong TNT", 55."Hongkong ARAMEX", 56."Special line-A", 57."Special line-B" , 58."Special line-C" , 59."Special line-D", 60."ePacket-B", 61."ePacket-C", 62."ePacket-D", 63."China Post small parcel Surface", 64."Belgium Post", 65."DHL-packet", 66."UPS-packet", 67."DHL-packet-2", 68."DHL-packet-3", 69."USPS-2", 70."USPS-3", 71."China DHL-2", 72."China DHL-3", 73."Hongkong DHL-2", 74."Hongkong DHL-3", 75."China UPS-2", 76."China UPS-3", 77."Hongkong UPS-2", 78."Hongkong UPS-3", 79."China FEDEX-2", 80."China FEDEX-3", 81."Hongkong FEDEX-2", 82."Hongkong FEDEX-3", 83."China ARAMEX-2", 84."China ARAMEX-3", 85."Hongkong ARAMEX-2", 86."Hongkong ARAMEX-3", 87."Ocean Freight To Door(tax free)-2", 88."Ocean Freight To Door(tax free)-3", 89."Train Freight", 90."Train Freight To Door(tax free)-1", 91."Train Freight To Door(tax free)-2", 92."Train Freight To Door(tax free)-3", 93."Normal express-2", 94."Normal express-3", 95."USPS-4", 96."USPS-5", 97."FCL 20GP", 98."FCL 40GP", 99."FCL 40HC", 100."Singapore-EMS", 101."J&T-1", 102."J&T-2", 103."J&T-3", , 104."air Freight To Door(tax free)-2", 105."air Freight To Door(tax free)-3", 106."Belgium Post-1", 107."Belgium Post-2", 108."KYE", 109."JDL", 110."Hong Kong FedEx-Time limit price", 111."China FedEx-Time limit price", 112."Hong Kong UPS-Time limit price", 113."China UPS-Time limit price", 114."Hong Kong DHL-Time limit price", 115."China DHL-Time limit price", 116."FLYT-1", 117."FLYT-2", 118."FLYT-3", 119."yunexpress-1", 120."yunexpress-2", 121."yunexpress-3", 122."yunexpress-4", 123."yunexpress-5", 124."UBI-1", 125."UBI-2", 126."UBI-3", 127."SF-E-commerce-2", 128."SF-E-commerce-3", 129."SF-express-2", 130."SF-express-3", 131."DPD-1", 132."DPD-2", 133."DPD-tax free-1", 134."DPD-tax free-2", 135."UBI-tax free-1", 136."UBI-tax free-2", 137."yunexpress-tax free-1", 138."yunexpress-tax free-2", 139."FLYT-tax free-1", 140."Special line-tax free-1", 141."Special line-tax free-2", 142."DHL-tax free-1", 143."UPS-tax free-1", 144."FEDEX-tax free-1", 145."ARAMEX-tax free-1", 146."SF-express-tax free-1",147."yunexpress-6",148."yunexpress-7",149."yunexpress-8",150."yunexpress-9",151."yunexpress-10",152."yunexpress-11",153."yunexpress-12", 154."CDEK-1", 155."CDEK-2", 156."CDEK-3", 157."CDEK-4"

Here is the array for all in javascript :

var shippingmethod_list=["","China DHL","China UPS","China TNT","China FEDEX","China ARAMEX","EMS","China Post small parcel by air","HongKong Post Air Mail","Guangzhou ePacket","Road Freight To Door","Road Freight","Air Freight To Door","Air Freight","Ocean Freight To Door","Ocean Freight","Normal Express","SF-express","dhl global mail","Fedex-packet","UK packet","Normal packet","PostNL","Epacket-fast","Malaysia post","Singapore Post","Sweden Post","USPS","DPEX","Road Freight To Door(tax free)","Air Freight To Door(tax free)","Ocean Freight To Door(tax free)","Pick up","Air Freight(tax free)","Ocean Freight(tax free)","STO(申通)", "YT(圆通)","ZTO(中通)", "BEST(百世)","YUNDA(韵达)", "TK(天天)", "DEPPON(德邦)","ANE(安能)" , "SF-packet" , "SF-E-commerce" , "China post big parcel Surface" , "LWE express" , "China post big parcel by air" , "China post big parcel SAL", "ETK", "Hongkong DHL", "Taiwan DHL",  "Hongkong UPS",  "Hongkong FEDEX",  "Hongkong TNT",  "Hongkong ARAMEX", "Special line-A", "Special line-B" , "Special line-C" , "Special line-D", "ePacket-B", "ePacket-C", "ePacket-D", "China Post small parcel Surface", "Belgium Post", "DHL-packet", "UPS-packet", "DHL-packet-2", "DHL-packet-3", "USPS-2", "USPS-3", "China DHL-2", "China DHL-3", "Hongkong DHL-2", "Hongkong DHL-3", "China UPS-2", "China UPS-3", "Hongkong UPS-2", "Hongkong UPS-3", "China FEDEX-2", "China FEDEX-3", "Hongkong FEDEX-2", "Hongkong FEDEX-3", "China ARAMEX-2", "China ARAMEX-3", "Hongkong ARAMEX-2", "Hongkong ARAMEX-3", "Ocean Freight To Door(tax free)-2", "Ocean Freight To Door(tax free)-3", "Train Freight", "Train Freight To Door(tax free)-1", "Train Freight To Door(tax free)-2", "Train Freight To Door(tax free)-3", "Normal express-2", "Normal express-3", "USPS-4", "USPS-5", "FCL 20GP", "FCL 40GP", "FCL 40HC", "Singapore-EMS", "J&T-1", "J&T-2", "J&T-3", "air Freight To Door(tax free)-2", "air Freight To Door(tax free)-3", "Belgium Post-1", "Belgium Post-2", "KYE", "JDL", "Hong Kong FedEx-Time limit price", "China FedEx-Time limit price", "Hong Kong UPS-Time limit price", "China UPS-Time limit price", "Hong Kong DHL-Time limit price", "China DHL-Time limit price", "FLYT-1", "FLYT-2", "FLYT-3", "yunexpress-1", "yunexpress-2", "yunexpress-3", "yunexpress-4", "yunexpress-5", "UBI-1", "UBI-2", "UBI-3", "SF-E-commerce-2", "SF-E-commerce-3", "SF-express-2", "SF-express-3", "DPD-1", "DPD-2", "DPD-tax free-1", "DPD-tax free-2", "UBI-tax free-1", "UBI-tax free-2", "yunexpress-tax free-1", "yunexpress-tax free-2", "FLYT-tax free-1", "Special line-tax free-1", "Special line-tax free-2", "DHL-tax free-1", "UPS-tax free-1", "FEDEX-tax free-1", "ARAMEX-tax free-1", "SF-express-tax free-1","yunexpress-6","yunexpress-7","yunexpress-8","yunexpress-9","yunexpress-10","yunexpress-11","yunexpress-12", "CDEK-1", "CDEK-2", "CDEK-3", "CDEK-4" ];

Appendices /Country

Country ID list in javascript:

var country_list = ["","Afghanistan", "Albania", "Algeria", "American Samoa", "Angola", "Anguilla", "Antartica", "Antigua and Barbuda", "Argentina", "Armenia", "Aruba", "Ashmore and Cartier Island", "Australia", "Austria", "Azerbaijan", "Bahamas", "Bahrain", "Bangladesh", "Barbados", "Belarus", "Belgium", "Belize", "Benin", "Bermuda", "Bhutan", "Bolivia", "Bosnia and Herzegovina", "Botswana", "Brazil", "British Virgin Islands", "Brunei", "Bulgaria", "Burkina Faso", "Burma", "Burundi", "Cambodia", "Cameroon", "Canada", "Cape Verde", "Cayman Islands", "Central African Republic", "Chad", "Chile", "China Guangdong(广东省)", "Christmas Island", "Clipperton Island", "Cocos (Keeling) Islands", "Colombia", "Comoros", "Congo, Democratic Republic of the", "Congo, Republic of the", "Cook Islands", "Costa Rica", "Cote d'Ivoire", "Croatia", "Cuba", "Cyprus", "Czech Republic", "Denmark", "Djibouti", "Dominica", "Dominican Republic", "Ecuador", "Egypt", "El Salvador", "Equatorial Guinea", "Eritrea", "Estonia", "Ethiopia", "Europa Island", "Falkland Islands (Islas Malvinas)", "Faroe Islands", "Fiji", "Finland", "France", "French Guiana", "French Polynesia", "French Southern and Antarctic Lands", "Gabon", "Gambia, The", "Gaza Strip", "Georgia", "Germany", "Ghana", "Gibraltar", "Glorioso Islands", "Greece", "Greenland", "Grenada", "Guadeloupe", "Guam", "Guatemala", "Guernsey", "Guinea", "Guinea-Bissau", "Guyana", "Haiti", "Heard Island and McDonald Islands", "Holy See (Vatican City)", "Honduras", "Hong Kong", "Howland Island", "Hungary", "Iceland", "India", "Indonesia", "Iran", "Iraq", "Ireland", "Ireland, Northern", "Israel", "Italy", "Jamaica", "Jan Mayen", "Japan", "Jarvis Island", "Jersey", "Johnston Atoll", "Jordan", "Juan de Nova Island", "Kazakhstan", "Kenya", "Kiribati", "Korea, North", "Korea, South", "Kuwait", "Kyrgyzstan", "Laos", "Latvia", "Lebanon", "Lesotho", "Liberia", "Libya", "Liechtenstein", "Lithuania", "Luxembourg", "Macau", "Macedonia, Former Yugoslav Republic of", "Madagascar", "Malawi", "West Malaysia", "Maldives", "Mali", "Malta", "Man, Isle of", "Marshall Islands", "Martinique", "Mauritania", "Mauritius", "Mayotte", "Mexico", "Micronesia, Federated States of", "Midway Islands", "Moldova", "Monaco", "Mongolia", "Montserrat", "Morocco", "Mozambique", "Namibia", "Nauru", "Nepal", "Netherlands", "Netherlands Antilles", "New Caledonia", "New Zealand", "Nicaragua", "Niger", "Nigeria", "Niue", "Norfolk Island", "Northern Mariana Islands", "Norway", "Oman", "Pakistan", "Palau", "Panama", "Papua New Guinea", "Paraguay", "Peru", "Philippines", "Pitcaim Islands", "Poland", "Portugal", "Puerto Rico", "Qatar", "Reunion", "Romainia", "Russia", "Rwanda", "Saint Helena", "Saint Kitts and Nevis", "Saint Lucia", "Saint Pierre and Miquelon", "Saint Vincent and the Grenadines", "Samoa", "San Marino", "Sao Tome and Principe", "Saudi Arabia", "Scotland", "Senegal", "Seychelles", "Sierra Leone", "Singapore", "Slovakia", "Slovenia", "Solomon Islands", "Somalia", "South Africa", "South Georgia and South Sandwich Islands", "Spain", "Spratly Islands", "Sri Lanka", "Sudan", "Suriname", "Svalbard", "Swaziland", "Sweden", "Switzerland", "Syria", "Taiwan", "Tajikistan", "Tanzania", "Thailand", "Tobago", "Toga", "Tokelau", "Tonga", "Trinidad", "Tunisia", "Turkey", "Turkmenistan", "Tuvalu", "Uganda", "Ukraine", "United Arab Emirates", "United Kingdom", "Uruguay", "USA", "Uzbekistan", "Vanuatu", "Venezuela", "Vietnam", "Virgin Islands", "Wales", "Wallis and Futuna", "West Bank", "Western Sahara", "Yemen", "Serbia", "Zambia", "Zimbabwe", "China Anhui(安徽省)","China Beijing(北京市)","China Chongqing(重庆省)","China Fujian(福建省)","China Gansu(甘肃省)","China Guangxi(广西省)","China Guizhou(贵州省)","China Hainan(海南省)","China Hebei(河北省)","China Heilongjiang(黑龙江省)","China Henan(河南省)","China Hubei(湖北省)","China Hunan(湖南省)","China Jiangsu(江苏省)","China Jiangxi(江西省)","China Jilin(吉林省)","China Liaoning(辽宁省)","China Inner Mongol(内蒙古)","China Ningxia(宁夏省)","China Qinghai(青海省)","China Shandong(山东省)","China Shanxi(山西省)","China Shangxi(陕西省)","China Shanghai(上海市)","China Sichuan(四川省)","China Tianjin(天津市)","China Tibet(西藏)","China Xinjiang(新疆)","China Yunnan(云南省)","China Zhejiang(浙江省)", "East Malaysia","Montenegro","Andorra"];

Country code -> Country ID in PHP:

$codetoid=array("AF"=>"1","AL"=>"2","DZ"=>"3","AS"=>"4","AO"=>"5","AI"=>"6","AQ"=>"7","AG"=>"8","AR"=>"9","AM"=>"10","AW"=>"11","AUS"=>"12","AU"=>"13","AT"=>"14","AZ"=>"15","BS"=>"16","BH"=>"17","BD"=>"18","BB"=>"19","BY"=>"20","BE"=>"21","BZ"=>"22","BJ"=>"23","BM"=>"24","BT"=>"25","BO"=>"26","BA"=>"27","BW"=>"28","BR"=>"29","VG"=>"30","BN"=>"31","BG"=>"32","BF"=>"33","MM"=>"34","BI"=>"35","KH"=>"36","CM"=>"37","CA"=>"38","CV"=>"39","KY"=>"40","CF"=>"41","TD"=>"42","CL"=>"43","CN"=>"44","CX"=>"45","IP"=>"46","CC"=>"47","CO"=>"48","KM"=>"49","CD"=>"50","CG"=>"51","CK"=>"52","CR"=>"53","CI"=>"54","HR"=>"55","CU"=>"56","CY"=>"57","CZ"=>"58","DK"=>"59","DJ"=>"60","DM"=>"61","DO"=>"62","EC"=>"63","EG"=>"64","SV"=>"65","GQ"=>"66","ER"=>"67","EE"=>"68","ET"=>"69","EU"=>"70","FK"=>"71","FO"=>"72","FJ"=>"73","FI"=>"74","FR"=>"75","GF"=>"76","PF"=>"77","TF"=>"78","GA"=>"79","GM"=>"80","GZ"=>"81","GE"=>"82","DE"=>"83","GH"=>"84","GI"=>"85","GO"=>"86","GR"=>"87","GL"=>"88","GD"=>"89","GP"=>"90","GU"=>"91","GT"=>"92","GG"=>"93","GN"=>"94","GW"=>"95","GY"=>"96","HT"=>"97","HM"=>"98","VA"=>"99","HN"=>"100","HK"=>"101","HQ"=>"102","HU"=>"103","IS"=>"104","IN"=>"105","ID"=>"106","IR"=>"107","IQ"=>"108","IE"=>"109","GB2"=>"110","IL"=>"111","IT"=>"112","JM"=>"113","JN"=>"114","JP"=>"115","DQ"=>"116","JE"=>"117","JQ"=>"118","JO"=>"119","JU"=>"120","KZ"=>"121","KE"=>"122","KI"=>"123","KP"=>"124","KR"=>"125","KW"=>"126","KG"=>"127","LA"=>"128","LV"=>"129","LB"=>"130","LS"=>"131","LR"=>"132","LY"=>"133","LI"=>"134","LT"=>"135","LU"=>"136","MO"=>"137","MK"=>"138","MG"=>"139","MW"=>"140","MY"=>"141","MV"=>"142","ML"=>"143","MT"=>"144","IM"=>"145","MH"=>"146","MQ"=>"147","MR"=>"148","MU"=>"149","YT"=>"150","MX"=>"151","FM"=>"152","UM"=>"153","MD"=>"154","MC"=>"155","MN"=>"156","MS"=>"157","MA"=>"158","MZ"=>"159","NA"=>"160","NR"=>"161","NP"=>"162","NL"=>"163","AN"=>"164","NC"=>"165","NZ"=>"166","NI"=>"167","NE"=>"168","NG"=>"169","NU"=>"170","NF"=>"171","MP"=>"172","NO"=>"173","OM"=>"174","PK"=>"175","PW"=>"176","PA"=>"177","PG"=>"178","PY"=>"179","PE"=>"180","PH"=>"181","PN"=>"182","PL"=>"183","PT"=>"184","PR"=>"185","QA"=>"186","RE"=>"187","RO"=>"188","RU"=>"189","RW"=>"190","SH"=>"191","KN"=>"192","LC"=>"193","PM"=>"194","VC"=>"195","WS"=>"196","SM"=>"197","ST"=>"198","SA"=>"199","UK2"=>"200","SN"=>"201","SC"=>"202","SL"=>"203","SG"=>"204","SK"=>"205","SI"=>"206","SB"=>"207","SO"=>"208","ZA"=>"209","GS"=>"210","ES"=>"211","XP"=>"212","LK"=>"213","SD"=>"214","SR"=>"215","SJ"=>"216","SZ"=>"217","SE"=>"218","CH"=>"219","SY"=>"220","TW"=>"221","TJ"=>"222","TZ"=>"223","TH"=>"224","TT2"=>"225","TG"=>"226","TK"=>"227","TO"=>"228","TT"=>"229","TN"=>"230","TR"=>"231","TM"=>"232","TV"=>"233","UG"=>"234","UA"=>"235","AE"=>"236","GB"=>"237","UY"=>"238","US"=>"239","UZ"=>"240","VU"=>"241","VE"=>"242","VN"=>"243","VI"=>"244","WLK"=>"245","WF"=>"246","WE"=>"247","EH"=>"248","YE"=>"249","RS"=>"250","ZM"=>"251","ZW"=>"252","CN1"=>"253","CN2"=>"254","CN3"=>"255","CN4"=>"256","CN5"=>"257","CN6"=>"258","CN7"=>"259","CN8"=>"260","CN9"=>"261","CN10"=>"262","CN11"=>"263","CN12"=>"264","CN13"=>"265","CN14"=>"266","CN15"=>"267","CN16"=>"268","CN17"=>"269","CN18"=>"270","CN19"=>"271","CN20"=>"272","CN21"=>"273","CN22"=>"274","CN23"=>"275","CN24"=>"276","CN25"=>"277","CN26"=>"278","CN27"=>"279","CN28"=>"280","CN29"=>"281","CN30"=>"282","MY2"=>"283","ME"=>"284","AD"=>"285");

$country_id=$codetoid[$country_code];

Country ID -> Country code in PHP:

$idtocode = array("","AF","AL","DZ","AS","AO","AI","AQ","AG","AR","AM","AW","AUS","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BR","VG","BN","BG","BF","MM","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","IP","CC","CO","KM","CD","CG","CK","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","EU","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GZ","GE","DE","GH","GI","GO","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HQ","HU","IS","IN","ID","IR","IQ","IE","GB2","IL","IT","JM","JN","JP","DQ","JE","JQ","JO","JU","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","IM","MH","MQ","MR","MU","YT","MX","FM","UM","MD","MC","MN","MS","MA","MZ","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","SH","KN","LC","PM","VC","WS","SM","ST","SA","GB","SN","SC","SL","SG","SK","SI","SB","SO","ZA","GS","ES","XP","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TT2","TG","TK","TO","TT","TN","TR","TM","TV","UG","UA","AE","GB","UY","US","UZ","VU","VE","VN","VI","WLK","WF","WE","EH","YE","RS","ZM","ZW","CN1","CN2","CN3","CN4","CN5","CN6","CN7","CN8","CN9","CN10","CN11","CN12","CN13","CN14","CN15","CN16","CN17","CN18","CN19","CN20","CN21","CN22","CN23","CN24","CN25","CN26","CN27","CN28","CN29","CN30","MY","ME","AD");
$country_code=$codetoid[$country_id];

System API appendices