接口文档

接口文档

创建订单

请求方式：POST

Content-Type：application/x-www-form-urlencoded

请求地址：http://oms.kjy.com/webservice/PublicService.asmx/ServiceInterfaceUTF8

Body参数名	类型	必需	描述	示例
appToken	string	是	API账号
appKey	string	是	API密码
serviceMethod	string	是	接口方法名	createorder
paramsJson	string	是	请求参数的数据内容	json格式

请求示例：

appToken=&appKey=&serviceMethod=createorder&paramsJson={"reference_no":"TEST2018000001","shipping_method":"PK0161","order_weight":2.0,"order_pieces":1,"mail_cargo_type":"4","consignee":{"consignee_company":"","consignee_province":"Massachusetts","consignee_city":"Mattapan","consignee_street":"760 Cummins HWY Apt11 ","consignee_postcode":"02126","consignee_name":"Marie Denise Medard Francois","consignee_telephone":"862-235-2637","consignee_mobile":"","consignee_countrycode":"US"},"shipper":{"shipper_countrycode":"CN","shipper_city":".","shipper_street":"..","shipper_areacode":"","shipper_name":".","shipper_telephone":"..","shipper_mobile":".."},"invoice":[{"invoice_enname":"Dresses","invoice_cnname":"连衣裙","invoice_quantity":1,"unit_code":"PCE","invoice_unitcharge":15.0,"net_weight":0.5,"invoice_note":"Dresses"}]}

paramsJson参数	类型	长度	必需	描述
reference_no	string	50	是	客户参考号
shipping_method	string		是	运输方式代码
shipping_method_no	string	50		服务商单号
order_weight	string	9,3		订单重量，单位KG，3位小数，默认为0.2
order_pieces	string			外包装件数,默认1
cargotype	string			货物类型 W：包裹 D：文件 B：袋子
order_status	string			订单状态 P：已预报 (默认) D：草稿 (如果创建草稿订单，则需要再调用submitforecast【提交预报】接口)
mail_cargo_type	string			包裹申报种类 1：Gif礼品 2：CommercialSample 商品货样 3：Document 文件 4：Other 其他默认4
buyer_id	string	30		买家ID
currency_code	string	3		币种代码
order_info	string	200		订单备注
platform_id	string			平台ID（如果您是电商平台，请联系我们添加并确认您对应的平台ID）
custom_hawbcode	string	50		自定义单号
attachment	string			附件
attachment_type	string			附件类型(不填则默认url) 1：url 2：base64
extension	string			附件后缀(附件类型为base64必填如：.jpg)
shipper	object		是	发件人信息
shipper.shipper_name	string	200	是	发件人姓名
shipper.shipper_company	string	200		发件人公司
shipper.shipper_countrycode	string	2	是	发件人国家二字代码
shipper.shipper_province	string	300		发件人州/省
shipper.shipper_city	string	300		发件人城市
shipper.shipper_district	string	300		发件人区/县
shipper.shipper_street	string	300	是	发件人街道地址
shipper.shipper_postcode	string	100		发件人邮编
shipper.shipper_areacode	string	10		发件人区域代码
shipper.shipper_telephone	string	100	至少传一项	发件人电话
shipper.shipper_mobile	string	100	至少传一项	发件人手机
shipper.shipper_email	string	100		发件人邮箱
shipper.shipper_fax	string	40		发件人传真
shipper.shipper_tariff	string	50		发件人税号
consignee	object		是	收件人信息
consignee.consignee_name	string	200	是	收件人姓名
consignee.consignee_company	string	200		收件人公司名
consignee.consignee_countrycode	string	2	是	收件人国家二字代码
consignee.consignee_province	string	300	条件	收件人州/省
consignee.consignee_city	string	300	条件	收件人城市
consignee.consignee_district	string	300	条件	收件人区/县
consignee.consignee_street	string	300	是	收件人街道地址
consignee.consignee_postcode	string	100	条件	收件人邮编
consignee.consignee_doorplate	string	300		收件人门牌号
consignee.consignee_areacode	string	10		收件人区域代码
consignee.consignee_telephone	string	100	至少传一项	收件人电话
consignee.consignee_mobile	string	100	至少传一项	收件人手机
consignee.consignee_email	string	100		收件人邮箱
consignee.consignee_fax	string	100		收件人传真
consignee.consignee_certificatetype	string			证件类型代码 ID：身份证 PP：护照
consignee.consignee_certificatecode	string	50		证件号码
consignee.consignee_credentials_period	string	50		证件有效期
consignee.consignee_tariff	string	50	条件	收件人税号
consignee.consignee_eori_number	string	50	条件	收件人EORI号
consignee.station_code	string	50	条件	仓库代码
invoice	array		是	海关申报信息
invoice.sku	string	100		SKU
invoice.invoice_enname	string	500	是	英文品名
invoice.invoice_cnname	string	500	条件	中文品名
invoice.invoice_quantity	string	6	是	数量
invoice.unit_code	string			单位 MTR：米 PCE：件 SET：套默认PCE
invoice.invoice_unitcharge	string	12,2	是	单价，2位小数 (1个数量的商品价格)
invoice.net_weight	string	9,3		商品单重，3位小数 (1个数量的商品单重)，单位KG
invoice.hs_code	string	30		海关协制编号
invoice.invoice_note	string	255		配货信息
invoice.invoice_url	string	255		销售地址
invoice.invoice_info	string	200		商品图片地址
invoice.invoice_material	string	255		材质
invoice.invoice_spec	string	255		规格
invoice.invoice_use	string	255		用途
invoice.invoice_brand	string	255		品牌
invoice.posttax_num	string	255		行邮税号
invoice.country_origin	string	50		原产国
invoice.invoice_is_registered	string	1		是否已注册 Y:已注册 N:未注册(默认值)
invoice.invoice_is_electrified	string	1		是否带电 Y:带电 N:不带电(默认值)
invoice.invoice_is_magnetic	string	1		是否带磁 Y:带磁 N:不带磁(默认值)
invoice.invoice_is_liquid	string	1		是否液体 Y:是液体 N:不是液体(默认值)
invoice.invoice_is_powder	string	1		是否粉末 Y:是粉末 N:不是粉末(默认值)
invoice.invoice_child_number	string	123456		箱号
invoice.invoice_asin_code	string	123456		ASIN CODE
invoice.invoice_image	string	base64字符串		上传图片
invoice.packing_photo	string	base64字符串		包装照片
cargovolume	array		否	包裹材积信息
cargovolume.child_number	string	60		箱号(子单号)
cargovolume.involume_length	string	5,1		长，1位小数，单位CM
cargovolume.involume_width	string	5,1		宽，1位小数，单位CM
cargovolume.involume_height	string	5,1		高，1位小数，单位CM
cargovolume.involume_grossweight	string	9,3		毛重，3位小数，单位KG
extra_service	array		否	额外服务
extra_service.extra_servicecode	string		是	额外服务类型代码
extra_service.extra_servicevalue	string	20	条件	额外服务值（有些额外服务类型必须传此值）
extra_service.extra_servicenote	string	50		备注
importer	object		否	进口商信息
importer.importer_name	string			进口商姓名
importer.importer_company	string			进口商公司
importer.importer_province	string			州/省
importer.importer_city	string			城市
importer.importer_street	string			进口商地址
importer.importer_postcode	string			邮政编码
importer.importer_telephone	string			进口商电话
importer.importer_countrycode	string			国家
fba_reference	array		否	FBA信息
fba_reference.fba_number	string		是	FBA编号
fba_reference.reference_id	string			Reference ID
fba_reference.fba_box_quantity	string			FBA箱数

返回示例：

                                {
    "success": 1,
    "cnmessage": "订单创建成功",
    "enmessage": "Order created successfully",
    "data": {
        "order_id": 51770,
        "refrence_no": "TEST2018000002",
        "shipping_method_no": "RZ000013260TW",
        "channel_hawbcode": "",
        "packages":[
            {
                "child_number":"TEST2018000001U000001",
                "child_tracknumber":"1Z84T09T0308000001",
                "child_label","http://test.hk.api.ruantongbao.com/api-lable/pdf/20211122/1Z84T09T0308000001.pdf"
            },
            {
                "child_number":"TEST2018000001U000002",
                "child_tracknumber":"1Z84T09T0301000002",
                "child_label","http://test.hk.api.ruantongbao.com/api-lable/pdf/20211122/1Z84T09T0301000002.pdf"
            }
        ]
    }
}

参数名	描述	类型
success	是否成功标志，0代表失败；1代表成功；2代表重复订单	int
cnmessage	中文消息	string
enmessage	英文消息	string
data	成功时返回的数据	object
data.order_id	订单ID	string
data.refrence_no	客户参考号	string
data.shipping_method_no	服务商单号	string
data.channel_hawbcode	渠道转单号	string
data.packages	子单号信息	array
data.packages.child_number	子单号(箱号)	string
data.packages.child_tracknumber	子单跟踪单号	string
data.packages.child_label	子单标签	string

提交预报(先创建草稿状态的订单才需要再调用此接口提交预报)

在线测试

请求方式：POST

Content-Type：application/x-www-form-urlencoded

请求地址：http://oms.kjy.com/webservice/PublicService.asmx/ServiceInterfaceUTF8

Body参数名	类型	必需	描述	示例
appToken	string	是	API账号
appKey	string	是	API密码
serviceMethod	string	是	接口方法名	submitforecast
paramsJson	string	是	请求参数的数据内容	json格式

请求示例：

appToken=&appKey=&serviceMethod=submitforecast&paramsJson={"reference_no":"TEST2018000002"}

paramsJson参数	类型	长度	必需	描述
reference_no	string	50	是	客户参考号
order_weight	string	9,3		订单重量，单位KG

返回示例：

                                                                {
    "success": 1,
    "cnmessage": "订单提交预报成功",
    "enmessage": "Order Submit forecast successfully",
    "data": {
        "order_id": 51770,
        "refrence_no": "TEST2018000002",
        "shipping_method_no": "RZ000013260TW",
        "channel_hawbcode": "",
        "packages":[
            {
                "child_number":"TEST2018000001U000001",
                "child_tracknumber":"1Z84T09T0308000001",
                "child_label","http://test.hk.api.ruantongbao.com/api-lable/pdf/20211122/1Z84T09T0308000001.pdf"
            },
            {
                "child_number":"TEST2018000001U000002",
                "child_tracknumber":"1Z84T09T0301000002",
                "child_label","http://test.hk.api.ruantongbao.com/api-lable/pdf/20211122/1Z84T09T0301000002.pdf"
            }
        ]
    }
}

参数名	描述	类型
success	是否成功标志，0代表失败；1代表成功	int
cnmessage	中文消息	string
enmessage	英文消息	string
data	成功时返回的数据	object
data.order_id	订单ID	string
data.refrence_no	客户参考号	string
data.shipping_method_no	服务商单号	string
data.channel_hawbcode	渠道转单号	string
data.packages	子单号信息	array
data.packages.child_number	子单号(箱号)	string
data.packages.child_tracknumber	子单跟踪单号	string
data.packages.child_label	子单标签	string

修改订单

在线测试

请求方式：POST

Content-Type：application/x-www-form-urlencoded

请求地址：http://oms.kjy.com/webservice/PublicService.asmx/ServiceInterfaceUTF8

Body参数名	类型	必需	描述	示例
appToken	string	是	API账号
appKey	string	是	API密码
serviceMethod	string	是	接口方法名	updateorder
paramsJson	string	是	请求参数的数据内容	json格式

请求示例：

appToken=&appKey=&serviceMethod=updateorder&paramsJson={"reference_no":"TEST2018000002","order_weight":"0.5"}

paramsJson参数	类型	长度	必需	描述
reference_no	string	50	是	客户参考号
order_weight	string	9,3	是	订单重量，单位KG

返回示例：

                                {
    "success": 1,
    "cnmessage": "更新订单成功",
    "enmessage": "更新订单成功"
}

参数名	描述	类型
success	是否成功标志，0代表失败；1代表成功	int
cnmessage	中文消息	string
enmessage	英文消息	string

删除订单

在线测试

请求方式：POST

Content-Type：application/x-www-form-urlencoded

请求地址：http://oms.kjy.com/webservice/PublicService.asmx/ServiceInterfaceUTF8

Body参数名	类型	必需	描述	示例
appToken	string	是	API账号
appKey	string	是	API密码
serviceMethod	string	是	接口方法名	removeorder
paramsJson	string	是	请求参数的数据内容	json格式

请求示例：

appToken=&appKey=&serviceMethod=removeorder&paramsJson={"reference_no":"TEST2018000002"}

paramsJson参数	类型	必需	描述
reference_no	string	是	客户参考号

返回示例：

                                {
    "success": 1,
    "cnmessage": "订单移除成功",
    "enmessage": "Order removal succeeded"
}

参数名	描述	类型
success	是否成功标志，0代表失败；1代表成功；2代表订单不存在	int
cnmessage	中文消息	string
enmessage	英文消息	string

获取订单标签

在线测试

请求方式：POST

Content-Type：application/x-www-form-urlencoded

请求地址：http://oms.kjy.com/webservice/PublicService.asmx/ServiceInterfaceUTF8

Body参数名	类型	必需	描述	示例
appToken	string	是	API账号
appKey	string	是	API密码
serviceMethod	string	是	接口方法名	getnewlabel
paramsJson	string	是	请求参数的数据内容	json格式

请求示例：

appToken=&appKey=&serviceMethod=getnewlabel&paramsJson={"configInfo":{"lable_file_type":"2","lable_paper_type":"1","lable_content_type":"1","additional_info":{"lable_print_invoiceinfo":"Y","lable_print_buyerid":"N","lable_print_datetime":"Y","customsdeclaration_print_actualweight":"N"}},"listorder":[{"reference_no":"TEST2018000002"}]}

paramsJson参数	类型	必需	描述
configInfo	object	是	配置信息
configInfo.lable_file_type	string	是	标签文件类型 2：PDF文件
configInfo.lable_paper_type	string	是	纸张类型 1：标签纸 2：A4纸
configInfo.lable_content_type	string	是	标签内容类型代码 1：标签 2：报关单 3：配货单 4：标签+报关单 5：标签+配货单 6：标签+报关单+配货单
configInfo.additional_info	object	是	附加配置信息
configInfo.additional_info.lable_print_invoiceinfo	string		标签上打印配货信息 (Y:打印 N:不打印) 默认 N:不打印
configInfo.additional_info.lable_print_buyerid	string		标签上是否打印买家ID (Y:打印 N:不打印) 默认 N:不打印
configInfo.additional_info.lable_print_datetime	string		标签上是否打印日期 (Y:打印 N:不打印) 默认 Y:打印
configInfo.additional_info.customsdeclaration_print_actualweight	string		报关单上是否打印实际重量 (Y:打印 N:不打印) 默认 N:不打印
listorder	array	是	订单信息
listorder.reference_no	string	是	客户参考号
config_code	string		标签纸张配置代码 1：标签纸-地址标签 2：标签纸-地址标签+报关单 3：标签纸-地址标签+配货单 4：标签纸-地址标签+报关单+配货单 5：A4纸-地址标签 6：A4纸-地址标签+报关单 7：A4纸-地址标签+配货单 8：A4纸-地址标签+报关单+配货单

返回示例：

                                {
    "success": 1,
    "cnmessage": "获取订单标签成功",
    "enmessage": "Get order label successfully",
    "data": [
        {
            "lable_file_type": "2",
            "lable_content_type": "1",
            "result_file_type": "URL",
            "lable_file": "http://oms.kjy.com/api-lable/pdf/20180913/0fb7227a-1ff2-4e0c-bbef-ddab75d74a10.pdf"
        }
    ]
}

参数名	描述	类型
success	是否成功标志，0代表失败；1代表成功	int
cnmessage	中文消息	string
enmessage	英文消息	string
data	成功时返回的数据	array
data.lable_file_type	标签文件类型 1 ：PNG文件 2 ：PDF文件	string
data.lable_content_type	标签内容类型 1 ：运单标签 2 ：报关单/发票	string
data.lable_file	标签文件url地址	string

获取订单跟踪单号

在线测试

请求方式：POST

Content-Type：application/x-www-form-urlencoded

请求地址：http://oms.kjy.com/webservice/PublicService.asmx/ServiceInterfaceUTF8

Body参数名	类型	必需	描述	示例
appToken	string	是	API账号
appKey	string	是	API密码
serviceMethod	string	是	接口方法名	gettrackingnumber
paramsJson	string	是	请求参数的数据内容	json格式

请求示例：

appToken=&appKey=&serviceMethod=gettrackingnumber&paramsJson={"reference_no":"TEST2018000001"}

paramsJson参数	类型	必需	描述
reference_no	string	是	客户参考号

返回示例：

                                {
    "success": 1,
    "cnmessage": "获取跟踪单号成功",
    "enmessage": "Get Tracking Number successfully",
    "data": {
            "refrence_no": "TEST2018000001",
            "shipping_method_no": "1Z84T09T0308000000",
            "channel_hawbcode": "",
            "packages":[
                {
                    "child_number":"TEST2018000001U000001",
                    "child_tracknumber":"1Z84T09T0308000001"
                },
                {
                    "child_number":"TEST2018000001U000002",
                    "child_tracknumber":"1Z84T09T0301000002"
                }
            ]
        }
}

参数名	描述	类型
success	是否成功标志，0代表失败；1代表成功	int
cnmessage	中文消息	string
enmessage	英文消息	string
data	成功时返回的数据	object
data.refrence_no	客户参考号	string
data.shipping_method_no	服务商单号	string
data.channel_hawbcode	渠道转单号	string
data.packages	子单号信息	array
data.packages.child_number	子单号(箱号)	string
data.packages.child_tracknumber	子单跟踪单号	string

批量获取订单跟踪单号

在线测试

请求方式：POST

Content-Type：application/x-www-form-urlencoded

请求地址：http://oms.kjy.com/webservice/PublicService.asmx/ServiceInterfaceUTF8

Body参数名	类型	必需	描述	示例
appToken	string	是	API账号
appKey	string	是	API密码
serviceMethod	string	是	接口方法名	gettrackingnumberbatch
paramsJson	string	是	请求参数的数据内容	json格式

请求示例：

appToken=&appKey=&serviceMethod=gettrackingnumberbatch&paramsJson={"reference_no_lst":["TEST2018000001","TEST2018000002"]}

paramsJson参数	类型	必需	描述
reference_no_lst	string[]	是	客户参考号数组

返回示例：

                                {
    "success": 2,
    "cnmessage": "获取跟踪单号部分成功",
    "enmessage": "Failed to get some Tracking Number",
    "data":[{
            "success":"1",
            "refrence_no": "TEST2018000001",
            "shipping_method_no": "1Z84T09T0308000000",
            "channel_hawbcode": "",
            "packages":[
                {
                    "child_number":"TEST2018000001U000001",
                    "child_tracknumber":"1Z84T09T0308000001"
                },
                {
                    "child_number":"TEST2018000001U000002",
                    "child_tracknumber":"1Z84T09T0301000002"
                }
            ]
        },
        {
            "success":"0",
            "refrence_no": "TEST2018000002",
            "shipping_method_no": "",
            "channel_hawbcode": "",
            "packages":null
	}]
}

参数名	描述	类型
success	是否成功标志，0代表失败；1代表成功；2代表部分成功	int
cnmessage	中文消息	string
enmessage	英文消息	string
data	成功时返回的数据	array
data.success	0代表失败；1代表成功；	string
data.refrence_no	客户参考号	string
data.shipping_method_no	服务商单号	string
data.channel_hawbcode	渠道转单号	string
data.packages	子单号信息	array
data.packages.child_number	子单号(箱号)	string
data.packages.child_tracknumber	子单跟踪单号	string

获取订单跟踪记录

在线测试

请求方式：POST

Content-Type：application/x-www-form-urlencoded

请求地址：http://oms.kjy.com/webservice/PublicService.asmx/ServiceInterfaceUTF8

Body参数名	类型	必需	描述	示例
appToken	string	是	API账号
appKey	string	是	API密码
serviceMethod	string	是	接口方法名	gettrack
paramsJson	string	是	请求参数的数据内容	json格式

请求示例：

appToken=&appKey=&serviceMethod=gettrack&paramsJson={"tracking_number":"RZ000013260TW"}

paramsJson参数	类型	必需	描述
tracking_number	string	是	服务商单号

返回示例：

                                {
    "success": 1,
    "cnmessage": "获取跟踪记录成功",
    "enmessage": "Get Track successfully",
    "data": [
        {
            "server_hawbcode": "RZ000013260TW",
            "destination_country": "US",
            "track_status": "NT",
            "track_status_name": "转运中",
            "signatory_name": "",
            "details": [
                {
                    "track_occur_date": "2018-09-04 11:52:27",
                    "track_location": "",
                    "track_description": "快件电子信息已经收到",
                }
            ]
        }
    ]
}

参数名	描述	类型
success	是否成功标志，0代表失败；1代表成功	int
cnmessage	中文消息	string
enmessage	英文消息	string
data	成功时返回的数据	array
data.server_hawbcode	服务商单号	string
data.destination_country	目的国家二字代码	string
data.track_status	轨迹状态代码	string
data.track_status_name	轨迹状态名称	string
data.signatory_name	签收人名	string
data.pod_url	POD文件链接，多个使用英文逗号(,)隔开	string
data.details	轨迹明细	array
data.details.track_occur_date	时间	string
data.details.track_location	地点	string
data.details.track_description	内容	string

获取订单费用(按费用种类分组合计费用)

在线测试

请求方式：POST

Content-Type：application/x-www-form-urlencoded

请求地址：http://oms.kjy.com/webservice/PublicService.asmx/ServiceInterfaceUTF8

Body参数名	类型	必需	描述	示例
appToken	string	是	API账号
appKey	string	是	API密码
serviceMethod	string	是	接口方法名	getbusinessfee
paramsJson	string	是	请求参数的数据内容	json格式

请求示例：

appToken=&appKey=&serviceMethod=getbusinessfee&paramsJson={"reference_no":"TEST2018000001","shipping_method_no":""}

paramsJson参数	类型	必需	描述
order_id	string	三选一	订单ID
reference_no	string		客户参考号
shipping_method_no	string		服务商单号

返回示例：

                                {
    "success": 1,
    "cnmessage": "获取费用信息成功",
    "enmessage": "Get fee successfully",
    "data": [
        {
            "fee_kind_code": "E1", 
            "fee_kind_name": "速递运费", 
            "currency_code": "RMB", 
            "currency_name": "人民币", 
            "currency_rate": "1.0000", 
            "currency_amount": "40.00", 
            "amount": "40.00"
        }, 
        {
            "fee_kind_code": "E2", 
            "fee_kind_name": "挂号费", 
            "currency_code": "RMB", 
            "currency_name": "人民币", 
            "currency_rate": "1.0000", 
            "currency_amount": "8.00", 
            "amount": "8.00"
        }
    ]
}

参数名	描述	类型
success	是否成功标志，0代表失败；1代表成功	int
cnmessage	中文消息	string
enmessage	英文消息	string
data	成功时返回的数据	array
data.fee_kind_code	费用种类代码	string
data.fee_kind_name	费用种类名称	string
data.currency_code	币种代码	string
data.currency_name	币种名称	string
data.currency_rate	兑人民币的汇率	string
data.currency_amount	原始币种金额	string
data.amount	人民币金额	string

获取订单费用明细(业务的每笔费用变动数据)

在线测试

请求方式：POST

Content-Type：application/x-www-form-urlencoded

请求地址：http://oms.kjy.com/webservice/PublicService.asmx/ServiceInterfaceUTF8

Body参数名	类型	必需	描述	示例
appToken	string	是	API账号
appKey	string	是	API密码
serviceMethod	string	是	接口方法名	getbusinessfee_detail
paramsJson	string	是	请求参数的数据内容	json格式

请求示例：

appToken=&appKey=&serviceMethod=getbusinessfee_detail&paramsJson={"reference_no":"TEST2018000001","shipping_method_no":""}

paramsJson参数	类型	必需	描述
order_id	string	三选一	订单ID
reference_no	string		客户参考号
shipping_method_no	string		服务商单号

返回示例：

                                {
    "success": 1,
    "cnmessage": "获取费用信息成功",
    "enmessage": "Get fee successfully",
    "data": [
        {
            "fee_kind_code": "E1", 
            "fee_kind_name": "速递运费", 
            "currency_code": "RMB", 
            "currency_name": "人民币", 
            "currency_rate": "1.0000", 
            "currency_amount": "30.00", 
            "amount": "30.00", 
            "create_date": "2019-06-19 11:06:57", 
            "occur_date": "2019-06-19 11:02:33", 
            "bill_date": "2019-08-15 23:59:59", 
            "note": "业务扣费"
        },
        {
            "fee_kind_code": "E1", 
            "fee_kind_name": "速递运费", 
            "currency_code": "RMB", 
            "currency_name": "人民币", 
            "currency_rate": "1.0000", 
            "currency_amount": "10.00", 
            "amount": "10.00", 
            "create_date": "2019-06-20 09:12:11", 
            "occur_date": "2019-06-19 11:02:33", 
            "bill_date": "2019-08-15 23:59:59", 
            "note": "重量变动增加费用"
        }, 
        {
            "fee_kind_code": "E2", 
            "fee_kind_name": "挂号费", 
            "currency_code": "RMB", 
            "currency_name": "人民币", 
            "currency_rate": "1.0000", 
            "currency_amount": "8.00", 
            "amount": "8.00", 
            "create_date": "2019-06-19 11:06:57", 
            "occur_date": "2019-06-19 11:02:33", 
            "bill_date": "2019-08-15 23:59:59", 
            "note": "业务扣费"
        }
    ]
}

参数名	描述	类型
success	是否成功标志，0代表失败；1代表成功	int
cnmessage	中文消息	string
enmessage	英文消息	string
data	成功时返回的数据	array
data.fee_kind_code	费用种类代码	string
data.fee_kind_name	费用种类名称	string
data.currency_code	币种代码	string
data.currency_name	币种名称	string
data.currency_rate	兑人民币的汇率	string
data.currency_amount	原始币种金额	string
data.amount	人民币金额	string
data.create_date	费用创建日期	string
data.occur_date	费用结算日期	string
data.bill_date	费用账单日期	string
data.note	备注	string

获取订单重量

在线测试

请求方式：POST

Content-Type：application/x-www-form-urlencoded

请求地址：http://oms.kjy.com/webservice/PublicService.asmx/ServiceInterfaceUTF8

Body参数名	类型	必需	描述	示例
appToken	string	是	API账号
appKey	string	是	API密码
serviceMethod	string	是	接口方法名	getbusinessweight
paramsJson	string	是	请求参数的数据内容	json格式

请求示例：

appToken=&appKey=&serviceMethod=getbusinessweight&paramsJson={"reference_no":"TEST2018000001","shipping_method_no":""}

paramsJson参数	类型	必需	描述
reference_no	string	二选一	客户参考号
shipping_method_no	string	二选一	服务商单号

返回示例：

                                {
    "success": 1,
    "cnmessage": "获取重量信息成功",
    "enmessage": "Get weight successfully",
    "data": {
            "grossweight": "1.000", 
            "volumeweight": "0.000", 
            "chargeweight": "1.000",
            "volume": [
                {
                    "box_number": "B9000001", 
                    "length": "10.0", 
                    "width": "10.0", 
                    "height": "10.0", 
                    "grossweight": "1.000"
                }
            ]
        }
}

参数名	描述	类型
success	是否成功标志，0代表失败；1代表成功	int
cnmessage	中文消息	string
enmessage	英文消息	string
data	成功时返回的数据	object
data.grossweight	毛重，单位KG	string
data.volumeweight	体积重量，单位KG	string
data.chargeweight	计费重量，单位KG	string
data.volume	材积信息	array
data.volume.box_number	箱号	string
data.volume.length	长，单位CM	string
data.volume.width	宽，单位CM	string
data.volume.height	高，单位CM	string
data.volume.grossweight	毛重，单位KG	string

费用试算

在线测试

请求方式：POST

Content-Type：application/x-www-form-urlencoded

请求地址：http://oms.kjy.com/webservice/PublicService.asmx/ServiceInterfaceUTF8

Body参数名	类型	必需	描述	示例
appToken	string	是	API账号
appKey	string	是	API密码
serviceMethod	string	是	接口方法名	feetrail
paramsJson	string	是	请求参数的数据内容	json格式

请求示例：

appToken=&appKey=&serviceMethod=feetrail&paramsJson={"country_code":"US","weight":"1.5"}

paramsJson参数	类型	必需	描述
country_code	string	是	目的国家二字代码
weight	string	是	重量（KG）
shipping_method	string		运输方式代码
post_code	string		目的地邮编
location	string		起运地默认为：用户绑定的起运地
cargo_type	string		货物类型（W:包裹 D:文件）默认为：W
wh_code	string		仓库代码
extra_service	array		额外服务代码集合
cargo_volume	object		材积信息
cargo_volume.weight	string	是	重量（KG）
cargo_volume.length	string		长（CM）
cargo_volume.width	string		宽（CM）
cargo_volume.height	string		高（CM）

返回示例：

                                {
    "success": 1,
    "cnmessage": "运费试算成功",
    "enmessage": "fee trial successfully",
    "data": [
        {
            "ServiceCode": "PK0033",
            "ServiceCnName": "中国邮政挂号",
            "ServiceEnName": "CNGH",
            "ChargeWeight": "1.5",
            "Effectiveness": "5-7",
            "Formula": "144",
            "FreightFee": "144.00",
            "FuelFee": "0.00",
            "RegisteredFee": "6.16",
            "OtherFee": "0.00",
            "OtherFeeDetails": [
                
            ],
            "TotalFee": 150.16,
            "ProductSort": 0,
            "Remark": "中国邮政挂号",
            "Traceability": "Y",
            "VolumeCharge": ""
        },
        {
            "ServiceCode": "PK0073",
            "ServiceCnName": "DHL本地",
            "ServiceEnName": "DHLL",
            "ChargeWeight": "10.000",
            "Effectiveness": "3-5",
            "Formula": "(2096) * 0.8折",
            "FreightFee": "1676.80",
            "FuelFee": "1.34",
            "RegisteredFee": "0.00",
            "OtherFee": "134.28",
            "OtherFeeDetails": [
                {
                    "FeeAmount": "134.28",
                    "FeeCnName": "报关费",
                    "FeeEnName": "clearance fee"
                }
            ],
            "TotalFee": 1812.42,
            "ProductSort": 0,
            "Remark": "",
            "Traceability": "Y",
            "VolumeCharge": "5000"
        }
    ]
}

参数名	描述	类型
success	是否成功标志，0代表失败；1代表成功	int
cnmessage	中文消息	string
enmessage	英文消息	string
data	成功时返回的数据	array
data.ServiceCode	运输方式代码	string
data.ServiceCnName	运输方式中文名	string
data.ServiceEnName	运输方式英文名	string
data.ChargeWeight	计费重量	string
data.FreightFee	运费	string
data.FuelFee	燃油费	string
data.RegisteredFee	挂号费	string
data.OtherFee	其他费用	string
data.OtherFeeDetails	其他费用明细	array
data.OtherFeeDetails.FeeCnName	费用中文名	string
data.OtherFeeDetails.FeeEnName	费用英文名	string
data.OtherFeeDetails.FeeAmount	费用金额	string
data.TotalFee	总费用	string
data.Effectiveness	时效天数	string
data.Traceability	是否可追踪	string
data.VolumeCharge	材积系数	string
data.Formula	运费计算公式	string
data.Remark	备注	string

获取基础数据

在线测试

请求方式：POST

Content-Type：application/x-www-form-urlencoded

请求地址：http://oms.kjy.com/webservice/PublicService.asmx/ServiceInterfaceUTF8

Body参数名	类型	必需	描述	示例
appToken	string	是	API账号
appKey	string	是	API密码
serviceMethod	string	是	接口方法名	getshippingmethod：获取运输方式 getcustomershippingmethod：获取可用的运输方式 getmailcargotype：获取申报种类 getcountry：获取国家 getcertificatetype：获取证件类型 getdeclareunit：获取申报单位 getextraservice：获取额外服务 getproductgroup：获取运输类型 getlocation：获取起运地 getlabelconfig：获取标签纸张配置
paramsJson	string		请求参数的数据内容	空

请求示例：

appToken=&appKey=&serviceMethod=getshippingmethod&paramsJson=

返回示例：

                                {
    "success": 1,
    "cnmessage": null,
    "enmessage": null,
     "data": [
        {
            "code": "",
            "cnname": "",
            "enname": "",
            "note": ""
        }
    ]
}

参数名	描述	类型
success	是否成功标志，0代表失败；1代表成功	int
cnmessage	中文消息	string
enmessage	英文消息	string
data	成功时返回的数据	array
data.code	代码	string
data.cnname	中文名称	string
data.enname	英文名称	string
data.note	备注	string