接口文档

创建订单

在线测试

请求方式：POST

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

请求地址：http://customer.ydhex.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,"insurance_value":0.0,"mail_cargo_type":"4","production_sales_company":"","production_sales_companycode":"","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,"invoice_note":"Dresses"}]}

paramsJson参数 类型 必需 描述
reference_no string 是 客户参考号
shipping_method string 是 运输方式代码
shipping_method_no string 服务商单号
order_weight string 是 订单重量，单位KG，默认为0.2
order_pieces string 外包装件数,默认1
cargotype string 货物类型
W：包裹
D：文件
B：袋子
mail_cargo_type string 包裹申报种类
1：Gif礼品
2：CommercialSample 商品货样
3：Document 文件
4：Other 其他
默认4
VatNum string 英国VAT税号
IossNum string 欧盟IOSS税号
return_sign string 是否需要标识退件退回 (Y,N)
buyer_id string EORI
order_info string 订单备注
platform_id string 条件 平台ID或平台CODE（如果您是电商平台，请联系我们添加并确认您对应的平台ID或平台CODE）
261 PZZZZZ 出品-出店型平台
262 JZZZZZ 自建站
类型平台需要传自建站名称格式：PZZZZZ|自建站名称、JZZZZZ|自建站名称
或者 261|自建站名称、262|自建站名称
custom_hawbcode string 自定义单号
production_sales_company string 是 生产销售企业单位
production_sales_companycode string 是 生产销售企业代码
shipper object 是 发件人信息
shipper.shipper_name string 是 发件人姓名
shipper.shipper_company string 发件人公司
shipper.shipper_countrycode string 是 发件人国家二字代码
shipper.shipper_province string 发件人省
shipper.shipper_city string 发件人城市
shipper.shipper_district string 发件人县/区
shipper.shipper_street string 是 发件人地址
shipper.shipper_street2 string 发件人地址2
shipper.shipper_postcode string 发件人邮编
shipper.shipper_areacode string 发件人区域代码
shipper.shipper_telephone string 是 发件人电话
shipper.shipper_mobile string 发件人手机
shipper.shipper_email string 发件人邮箱
shipper.shipper_fax string 发件人传真
shipper.shipper_certificatetype string 发件人证件号码类型代码(S:税号)
shipper.shipper_certificatecode string 发件人证件号码
consignee object 是 收件人信息
consignee.consignee_name string 是 收件人姓名
consignee.consignee_company string 收件人公司名
consignee.consignee_countrycode string 是 收件人国家二字代码
consignee.consignee_province string 条件 收件人省
consignee.consignee_city string 条件 收件人城市
consignee.consignee_district string 收件人县/区
consignee.consignee_street string 是 收件人地址
consignee.consignee_street2 string 收件人地址2
consignee.consignee_postcode string 条件 收件人邮编
consignee.consignee_doorplate string 收件人门牌号
consignee.consignee_areacode string 收件人区域代码
consignee.consignee_telephone string 是 收件人电话
consignee.consignee_mobile string 收件人手机
consignee.consignee_email string 收件人邮箱
consignee.consignee_katakana string 收件人片假名
consignee.consignee_fax string 收件人传真
consignee.consignee_certificatetype string 证件类型代码
ID：身份证
PP：护照
consignee.consignee_certificatecode string 证件号码
consignee.consignee_credentials_period string 证件有效期
consignee.consignee_tariff string 条件 税号
consignee.consignee_province_en string 收件人省（英文）
consignee.consignee_city_en string 收件人城市（英文）
consignee.consignee_district_en string 收件人县/区（英文）
consignee.consignee_street_en string 收件人地址（英文）
consignee.consignee_street2_en string 收件人地址2（英文）
consignee.consignee_postcode_en string 收件人邮编（英文）
consignee.consignee_doorplate_en string 收件人门牌号（英文）
invoice array 是 海关申报信息
invoice.sku string SKU
invoice.invoice_enname string 是 英文品名
invoice.invoice_cnname string 条件 中文品名
invoice.invoice_quantity string 是 数量
invoice.unit_code string 单位
MTR：米
PCE：件
SET：套
默认PCE
invoice.invoice_unitcharge string 是 单价(单个商品价格)
invoice.invoice_currencycode string 币别
USD：美元
JPY：日元
RMB：人民币
EUR：欧元
GBP：英镑
HKD：港币
RUB：俄罗斯卢布
SGD：新加坡元
默认USD
invoice.invoice_outunitcharge string 出口国申报单价
invoice.invoice_outcurrencycode string 出口国申报币种
invoice.jp_hs_code string 日本hs code
invoice.hs_code string 海关协制编号
invoice.invoice_note string 配货信息
invoice.invoice_url string 销售地址
invoice.invoice_info string 备注信息
invoice.invoice_image string 商品图片地址
invoice.invoice_material string 材质
invoice.invoice_spec string 规格
invoice.posttax_num string 国内报关申报价值
invoice.country_origin string 原产国/国内报关币种
invoice.register_code string 店铺名称(长度100)
invoice.invoice_store_names string 店铺名称(长度300)
invoice.invoice_use string 用途
invoice.invoice_asin_code string 条件 ASIN号码
invoice.m_pid string 条件 商户商品标识
invoice.ns_pid string 条件 非标准化制造商商品标识
invoice.s_pid string 条件 标准化制造商商品标识
cargovolume array 否 材积信息
cargovolume.child_number string 子单号
cargovolume.involume_length decimal(5,1) 长(cm)
cargovolume.involume_width decimal(5,1) 宽(cm)
cargovolume.involume_height decimal(5,1) 高(cm)
cargovolume.involume_grossweight decimal(5,3) 实重(kg)
extra_service array 否 额外服务
extra_service.extra_servicecode string 是 额外服务类型代码
extra_service.extra_servicevalue string 条件 额外服务值（有些额外服务类型必须传此值）
extra_service.extra_servicenote string 备注

返回示例：

                                {
    "success": 1,
    "cnmessage": "订单创建成功",
    "enmessage": "Order created successfully",
    "data": {
        "order_id": 51770,
        "refrence_no": "TEST2018000002",
        "shipping_method_no": "RZ000013260TW",
        "channel_hawbcode": "",
        "store":"903,105"
    }
}
参数名 描述 类型
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.store 店番号 (eg:903,105) string

创建商业件订单

在线测试

请求方式：POST

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

请求地址：http://customer.ydhex.com/webservice/PublicService.asmx/ServiceInterfaceUTF8

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

请求示例：

appToken=&appKey=&serviceMethod=createcommercialorder&paramsJson={"reference_no":"TEST13060611361","shipping_method":"YN-ZX","shipping_method_no":"","order_weight":"0.5","order_pieces":"1","cargotype":"W","production_sales_company":"","production_sales_companycode":"","shipper":{"shipper_name":"YDH","shipper_company":"YDH","shipper_countrycode":"CN","shipper_countrycodecnname":null,"shipper_province":null,"shipper_city":"","shipper_street":"li an road 999.no","shipper_postcode":"","shipper_telephone":"201100"},"consignee":{"consignee_account":null,"consignee_name":"Massachusetts","consignee_company":"","consignee_countrycode":"VN","consignee_province":"","consignee_city":"Mattapan","consignee_district":null,"consignee_street":"760 Cummins HWY Apt11","consignee_postcode":"02126","consignee_telephone":"862-235-2637","consignee_mobile":null,"consignee_email":""},"fba_order_extend":{"packaging_type":"ENV","is_declare_customs":"N","freight_type":"SENDER_PAY","freight_type_account":null,"is_freight_amount":false,"tax_payment_type":"CONSIGNEE_PAY","tax_payment_type_account":""},"importer":{"importer_name":"菜鸟","importer_company":"YDH","importer_telephone":"151656","importer_province":"","importer_city":"","importer_postcode":"15165","importer_address":"123"},"invoice":[{"no":1,"sku":"","invoice_enname":"Dresses","invoice_cnname":"连衣裙","invoice_quantity":"1","unit_code":null,"invoice_unitcharge":"2","invoice_currencycode":"USD","hs_code":null,"invoice_material":"2323","invoice_use":"","invoice_spec":""}]}

paramsJson参数 类型 必需 描述
reference_no string 是 客户参考号
shipping_method string 是 运输方式代码
shipping_method_no string 服务商单号
order_weight string 是 订单重量，单位KG，默认为0.2
order_pieces string 是 外包装件数,默认1
cargotype string 货物类型
W：包裹
D：文件
B：袋子
mail_cargo_type string 包裹申报种类
1：Gif礼品
2：CommercialSample 商品货样
3：Document 文件
4：Other 其他
默认4
VatNum string 英国VAT税号
IossNum string 欧盟IOSS税号
return_sign string 是否需要标识退件退回 (Y,N)
buyer_id string EORI
order_info string 订单备注
platform_id string 是 平台ID（如果您是电商平台，请联系我们添加并确认您对应的平台ID）
custom_hawbcode string 自定义单号
production_sales_company string 是 生产销售企业单位
production_sales_companycode string 是 生产销售企业代码
shipper object 是 发件人信息
shipper.shipper_name string 是 发件人姓名
shipper.shipper_company string 是 发件人公司
shipper.shipper_countrycode string 是 发件人国家二字代码
shipper.shipper_province string 发件人省
shipper.shipper_city string 发件人城市
shipper.shipper_district string 发件人县/区
shipper.shipper_street string 是 发件人地址
shipper.shipper_street2 string 发件人地址2
shipper.shipper_postcode string 发件人邮编
shipper.shipper_areacode string 发件人区域代码
shipper.shipper_telephone string 是 发件人电话
shipper.shipper_mobile string 发件人手机
shipper.shipper_email string 发件人邮箱
shipper.shipper_fax string 发件人传真
consignee object 是 收件人信息
consignee.consignee_name string 是 收件人姓名
consignee.consignee_company string 收件人公司名
consignee.consignee_countrycode string 是 收件人国家二字代码
consignee.consignee_province string 收件人省
consignee.consignee_city string 收件人城市
consignee.consignee_district string 收件人县/区
consignee.consignee_street string 是 收件人地址
consignee.consignee_street2 string 收件人地址2
consignee.consignee_postcode string 是 收件人邮编
consignee.consignee_doorplate string 收件人门牌号
consignee.consignee_areacode string 收件人区域代码
consignee.consignee_telephone string 是 收件人电话
consignee.consignee_mobile string 收件人手机
consignee.consignee_email string 收件人邮箱
consignee.consignee_fax string 收件人传真
consignee.consignee_katakana string 收件人片假名
consignee.consignee_certificatetype string 证件类型代码
ID：身份证
PP：护照
consignee.consignee_certificatecode string 证件号码
consignee.consignee_credentials_period string 证件有效期
consignee.consignee_tariff string 税号
consignee.consignee_province_en string 收件人省（英文)
consignee.consignee_city_en string 收件人城市（英文）
consignee.consignee_district_en string 收件人县/区（英文
consignee.consignee_street_en string 收件人地址（英文）
consignee.consignee_street2_en string 收件人地址2（英文）
consignee.consignee_postcode_en string 收件人邮编（英文）
consignee.consignee_doorplate_en string 收件人门牌号（英文）
fba_order_extend object 是 商业件订单扩展信息
fba_order_extend.product_types_code string 商品类型（多个”,“分隔）
fba_order_extend.delivery_method string 提货方式
A 义达提货
B 客户自提
fba_order_extend.warehousing_date string 入仓日期
fba_order_extend.warehousing_period string 入仓时间段
fba_order_extend.is_declare_customs string 是否报关
Y 是
N 否
fba_order_extend.declare_customs_file string 报关资料文件地址
fba_order_extend.is_tax_inclusive string 是否包税
Y 是
N 否
fba_order_extend.delivery_terms string 交货条款
A(DDP)
B(DDU)
fba_order_extend.is_purchase_insurance string 是否购买保险
Y 是
N 否
fba_order_extend.purchase_insurance_amount string 购买保险金额
fba_order_extend.warehouse_code string 仓库代码
fba_order_extend.shipper_type string 发件人类型
X-选择地址
N-私人地址
fba_order_extend.consignee_type string 收件人类型
X-FBA选择地址
N-私人地址
fba_order_extend.freight_type string 是 运费付款方式
SENDER_PAY 寄件人支付
CONSIGNEE_PAY 收件人支付
IMPORTER_PAY 进口商支付
fba_order_extend.freight_type_account string 到付账号
fba_order_extend.freight_amount string 到付金额
fba_order_extend.freight_currency string 到付币种
fba_order_extend.is_Degauss string 是否磁检
fba_order_extend.is_remarks string 是否备注
fba_order_extend.tax_payment_type string 是 税金付款方式
SENDER_PAY 寄件人支付
CONSIGNEE_PAY 收件人支付
IMPORTER_PAY 进口商支付
fba_order_extend.tax_payment_type_account string 税金付款方式账号
fba_order_extend.order_type string 订单类型
fba_order_extend.packaging_type string 是 货物类型
ENV:文件袋
WOOD:木箱
PAK:防水袋
BOX:纸箱
TARY:托盘
OTH:其他
MouthSeatInfo object 口座账号信息
MouthSeatInfo.ms_name string 日本輸入者コード（口座支付时必填）
MouthSeatInfo.ms_bankname string 銀行名（口座支付时必填）
MouthSeatInfo.ms_bankcode string 銀行コード（口座支付时必填）
MouthSeatInfo.ms_branchcode string 支店コード（口座支付时必填）
MouthSeatInfo.account_number string 口座番号（口座支付时必填）
importer object 是 进口商信息
importer.importer_company string 条件 进口商公司名（与联系人二选一）
importer.importer_countrycode string 进口商国家
importer.importer_name string 条件 进口商联系人（与公司名二选一）
importer.importer_email string 进口商邮箱
importer.importer_mobile string 条件 进口商手机（与联系电话二选一）
importer.importer_telephone string 条件 进口商联系电话（与手机二选一）
importer.importer_province string 进口商省/州
importer.importer_city string 进口商城市
importer.importer_doorplate string 进口商门牌号
importer.importer_vat string 进口商VAT
importer.importer_eori string 进口商EORI
importer.importer_postcode string 是 进口商邮编
importer.importer_address string 是 进口商地址
importer.importer_enname string 进口商英文名
importer.importer_enname string 进口商英文地址
importer.importer_corporate_number string 法人番号
importer.importer_address2 string 进口商地址2（日文)
importer.importer_province_en string 进口商省（英文）
importer.importer_city_en string 是 进口商城市（英文）
importer.importer_district_en string 是 进口商县/区（英文）
importer.importer_address_en string 进口商地址（英文)
importer.importer_address2_en string 进口商地址2（英文）
importer.importer_postcode_en string 进口商邮编（英文）
importer.impoter_doorplate_en string 进口商门牌号（英文）
child_account array 否 子账号信息
child_account.payment_account_username string 子账号用户名
child_account.payment_account_phone_number string 子账号用户电话
child_account.payment_account_contact_name string 子账号联系人
child_account.payment_account_id string 子账号id
child_account.payment_account_email string 子账号邮箱
child_account.payment_account_mobile_number string 子账号手机号码
child_account.payment_account_company_id string 子账号企业id
invoice array 是 海关申报信息
invoice.sku string SKU
invoice.no int 是 箱号
invoice.invoice_enname string 是 英文品名
invoice.invoice_cnname string 是 中文品名
invoice.invoice_quantity string 是 数量
invoice.unit_code string 单位
MTR：米
PCE：件
SET：套
默认PCE
invoice.invoice_unitcharge string 是 单价(单个商品价格)
invoice.invoice_currencycode string 是 币别
USD：美元
JPY：日元
RMB：人民币
EUR：欧元
GBP：英镑
HKD：港币
RUB：俄罗斯卢布
SGD：新加坡元
默认USD
invoice.invoice_outunitcharge string 出口国申报单价
invoice.invoice_outcurrencycode string 出口国申报币种
invoice.jp_hs_code string 日本hs_code
invoice.hs_code string 海关协制编号
invoice.invoice_note string 配货信息
invoice.invoice_url string 销售地址
invoice.invoice_info string 商品图片地址
invoice.invoice_material string 材质
invoice.invoice_spec string 规格
cargovolume array 否 材积信息
cargovolume.child_number string 子单号
cargovolume.involume_length decimal(5,1) 长(cm)
cargovolume.involume_width decimal(5,1) 宽(cm)
cargovolume.involume_height decimal(5,1) 高(cm)
cargovolume.involume_grossweight decimal(5,3) 实重(kg)
extra_service.extra_servicevalue string 条件 额外服务值（有些额外服务类型必须传此值）
extra_service.extra_servicenote string 备注

返回示例：

                                {
    "success": 1,
    "cnmessage": "订单创建成功",
    "enmessage": "Order created successfully",
    "data": {
        "order_id": 51770,
        "refrence_no": "TEST2018000002",
        "shipping_method_no": "RZ000013260TW",
        "channel_hawbcode": "",
        "store":"903,105"
    }
}
参数名 描述 类型
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.store 店番号 (eg:903,105) string

获取订单标签

在线测试

请求方式：POST

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

请求地址：http://customer.ydhex.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 是 标签文件类型
1：PNG文件
2：PDF文件
configInfo.lable_paper_type string 是 纸张类型
1：标签纸(10*10厘米)
2：A4纸(21*29.7厘米)
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

返回示例：

                                {
    "success": 1,
    "cnmessage": "获取订单标签成功",
    "enmessage": "Get order label successfully",
    "data": [
        {
            "lable_file_type": "2",
            "lable_file": "http://customer.ydhex.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_file 标签文件url地址 string

获取跟踪记录

在线测试

请求方式：POST

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

请求地址：http://customer.ydhex.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 是 服务商单号，支持同时接收最多20个服务商单号用,号分隔，如：355095460000,355095460001。

返回示例：

                                {
    "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": "快件操作完成",
                    "track_description_en": "Shipment departed from facility",
                    "track_description_jp": "ショートカットの操作が完了しました"
                }
            ]
        }
    ]
}
参数名 描述 类型
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.details 轨迹明细 array
data.details.track_occur_date 时间 string
data.details.track_location 地点 string
data.details.track_code 轨迹代码 string
data.details.track_description 内容 string

费用试算

在线测试

请求方式：POST

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

请求地址：http://customer.ydhex.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
length string 长（CM）
width string 宽（CM）
height string 高（CM）
extra_service array 额外服务代码集合

返回示例：

                                {
    "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://customer.ydhex.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代表成功 int
cnmessage 中文消息 string
enmessage 英文消息 string

修改订单

在线测试

请求方式：POST

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

请求地址：http://customer.ydhex.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":"15.75","cargovolume":[{"child_number":"TEST20180000020001","involume_length":10,"involume_width":20,"involume_height":30,"involume_grossweight":40},{"child_number":"1TEST20180000020002","involume_length":10,"involume_width":20,"involume_height":30,"involume_grossweight":40}]}

paramsJson参数 类型 必需 描述
reference_no string 是 客户参考号
order_weight string 是 订单重量
cargovolume array 否 材积信息
cargovolume.child_number string 否 子单号（若需要修改材积信息，一票多件时该字段必传）
cargovolume.involume_length decimal(5,1) 否 长(cm)
cargovolume.involume_width decimal(5,1) 否 宽(cm)
cargovolume.involume_height decimal(5,1) 否 高(cm)
cargovolume.involume_grossweight decimal(5,3) 否 实重(kg)
cargovolume.invoice_boxnumbergenerate string 与invoice箱号一致

返回示例：

                                {
    "success": 1,
    "cnmessage": "更新订单成功",
    "enmessage": "更新订单成功"
}
参数名 描述 类型
success 是否成功标志，0代表失败；1代表成功 int
cnmessage 中文消息 string
enmessage 英文消息 string

修改收件人税号

在线测试

请求方式：POST

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

请求地址：http://customer.ydhex.com/webservice/PublicService.asmx/ServiceInterfaceUTF8

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

请求示例：

appToken=&appKey=&serviceMethod=updateconsigneetariff&paramsJson={"reference_no":"TEST2018000002","consignee_tariff":"123456","consignee_name":"test","phone":"12345678900"}

paramsJson参数 类型 必需 描述
reference_no string 是 客户参考号
consignee_tariff string 是 收件人税号
consignee_name string 是 收件人姓名
phone string 是 收件人手机/电话

返回示例：

                                {
    "success": 1,
    "cnmessage": "更新订单成功",
    "enmessage": "更新订单成功"
}
参数名 描述 类型
success 是否成功标志，0代表失败；1代表成功 int
cnmessage 中文消息 string
enmessage 英文消息 string

获取基础数据

在线测试

请求方式：POST

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

请求地址：http://customer.ydhex.com/webservice/PublicService.asmx/ServiceInterfaceUTF8

Body参数名 类型 必需 描述 示例
appToken string 是 API账号
appKey string 是 API密码
serviceMethod string 是 接口方法名 getshippingmethod：获取运输方式
getmailcargotype：获取申报种类
getcountry：获取国家
getcertificatetype：获取证件类型
getdeclareunit：获取申报单位
getextraservice：获取额外服务
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

获取跟踪单号

在线测试

请求方式：POST

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

请求地址：http://customer.ydhex.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":"TEST2018000002"}

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

返回示例：

                                {
    "success": 1,
    "cnmessage": "获取跟踪单号成功",
    "enmessage": "succeeded",
     "data": 
        {
            "refrence_no": "RZ000013260TW",
            "shipping_method_no": "TEST2018000002",
            "channel_hawbcode": "CHAN2018000002"        
        }
}
参数名 描述 类型
success 是否成功标志，0代表失败；1代表成功 int
cnmessage 中文消息 string
enmessage 英文消息 string
data 返回的数据 object
data.refrence_no 客户单号 string
data.shipping_method_no 服务商单号 string
data.channel_hawbcode 转单号 string

获取运单重量

在线测试

请求方式：POST

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

请求地址：http://customer.ydhex.com/webservice/PublicService.asmx/ServiceInterfaceUTF8

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

请求示例：

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

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

返回示例：

                                {
    "success": 1,
    "cnmessage": "获取重量信息成功",
    "enmessage": "succeeded",
     "data": 
        {
            "grossweight": "0.05",
            "volumeweight": "0.05",
            "chargeweight": "0.05"        
        }
}
参数名 描述 类型
success 是否成功标志，0代表失败；1代表成功 int
cnmessage 中文消息 string
enmessage 英文消息 string
data 返回的数据 object
data.grossweight 订单实重 string
data.volumeweight 订单体积重 string
data.chargeweight 订单计费重 string

订单拦截

在线测试

请求方式：POST

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

请求地址：http://customer.ydhex.com/webservice/PublicService.asmx/ServiceInterfaceUTF8

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

请求示例：

appToken=&appKey=&serviceMethod=interception&paramsJson={"Customerordernumber":"13060111195","Reasonforinterception":"666" ,"BlockType":""}

paramsJson参数 类型 必需 描述
Customerordernumber string 是 客户单号
Reasonforinterception string 否 拦截原因
BlockType string 否 处理方式:默认不填写为拦截退件,为0:拦截退件,为1:拦截暂扣

返回示例：

                                {
    "success": 1,
    "cnmessage": "拦截成功!",
    "enmessage": "Interception successful!",
}
参数名 描述 类型
success 是否成功标志，0代表失败；1代表成功 int
cnmessage 中文消息 string
enmessage 英文消息 string

日本退运

在线测试

请求方式：POST

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

请求地址：http://customer.ydhex.com/webservice/PublicService.asmx/ServiceInterfaceUTF8

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

请求示例：

appToken=&appKey=&serviceMethod=reversecreateorder&paramsJson={"reference_no":"TEST2018000001","shipping_method":"PK0200","consign_method":1,"order_weight":2.0,"order_pieces":1,"insurance_value":0.0,"mail_cargo_type":"4","consignee":{"consignee_company":"","consignee_province":"大阪府","consignee_city":"貝塚市港１７－１２","consignee_street":"760 Cummins HWY Apt11 ","consignee_postcode":"5970095","consignee_name":"Marie Denise Medard Francois","consignee_telephone":"0724887974","consignee_mobile":"","consignee_countrycode":"JP"},"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,"invoice_note":"Dresses"}]}

paramsJson参数 类型 必需 描述
reference_no string 是 客户参考号
shipping_method string 是 运输方式代码
consign_method int 是 逆向寄件方式，1：上门取件，0：自提
shipping_method_no string 服务商单号
order_weight string 订单重量，单位KG，默认为0.2
order_pieces string 外包装件数,默认1
cargotype string 货物类型
W：包裹
D：文件
B：袋子
mail_cargo_type string 包裹申报种类
1：Gif礼品
2：CommercialSample 商品货样
3：Document 文件
4：Other 其他
默认4
VatNum string 英国VAT税号
IossNum string 欧盟IOSS税号
return_sign string 是否需要标识退件退回 (Y,N)
buyer_id string EORI
order_info string 订单备注
platform_id string 平台ID（如果您是电商平台，请联系我们添加并确认您对应的平台ID）
custom_hawbcode string 自定义单号
shipper object 是 发件人信息
shipper.shipper_name string 是 发件人姓名
shipper.shipper_company string 发件人公司
shipper.shipper_countrycode string 是 发件人国家二字代码
shipper.shipper_province string 发件人省
shipper.shipper_city string 发件人城市
shipper.shipper_district string 发件人县/区
shipper.shipper_street string 是 发件人地址
shipper.shipper_street2 string 发件人地址2
shipper.shipper_postcode string 发件人邮编
shipper.shipper_areacode string 发件人区域代码
shipper.shipper_telephone string 是 发件人电话
shipper.shipper_mobile string 发件人手机
shipper.shipper_email string 发件人邮箱
shipper.shipper_fax string 发件人传真
consignee object 是 收件人信息
consignee.consignee_name string 是 收件人姓名
consignee.consignee_company string 收件人公司名
consignee.consignee_countrycode string 是 收件人国家二字代码
consignee.consignee_province string 条件 收件人省
consignee.consignee_city string 条件 收件人城市
consignee.consignee_district string 收件人县/区
consignee.consignee_street string 是 收件人地址
consignee.consignee_street2 string 收件人地址2
consignee.consignee_postcode string 条件 收件人邮编
consignee.consignee_doorplate string 收件人门牌号
consignee.consignee_areacode string 收件人区域代码
consignee.consignee_telephone string 是 收件人电话
consignee.consignee_mobile string 收件人手机
consignee.consignee_email string 收件人邮箱
consignee.consignee_katakana string 收件人片假名
consignee.consignee_fax string 收件人传真
consignee.consignee_certificatetype string 证件类型代码
ID：身份证
PP：护照
consignee.consignee_certificatecode string 证件号码
consignee.consignee_credentials_period string 证件有效期
consignee.consignee_tariff string 条件 税号
invoice array 是 海关申报信息
invoice.sku string SKU
invoice.invoice_enname string 是 英文品名
invoice.invoice_cnname string 条件 中文品名
invoice.invoice_quantity string 是 数量
invoice.unit_code string 单位
MTR：米
PCE：件
SET：套
默认PCE
invoice.invoice_unitcharge string 是 单价(单个商品价格)
invoice.jp_hs_code string 日本hs code
invoice.invoice_currencycode string 币别
USD：美元
JPY：日元
RMB：人民币
EUR：欧元
GBP：英镑
HKD：港币
RUB：俄罗斯卢布
SGD：新加坡元
默认USD
invoice.hs_code string 海关协制编号
invoice.invoice_note string 配货信息
invoice.invoice_url string 销售地址
invoice.invoice_info string 商品图片地址
invoice.invoice_material string 材质
invoice.invoice_spec string 规格
invoice.invoice_use string 用途
extra_service array 否 额外服务
extra_service.extra_servicecode string 是 额外服务类型代码
extra_service.extra_servicevalue string 条件 额外服务值（有些额外服务类型必须传此值）
extra_service.extra_servicenote string 备注

返回示例：

                                {
    "success": 1,
    "cnmessage": "订单创建成功",
    "enmessage": "Order created successfully",
    "data": {
        "order_id": 51770,
        "refrence_no": "TEST2018000002",
        "shipping_method_no": "RZ000013260TW",
        "channel_hawbcode": "",
        "store":"903,105"
    }
}
参数名 描述 类型
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.store 店番号 (eg:903,105) string

黑猫退运线下自送

在线测试

请求方式：POST

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

请求地址：http://customer.ydhex.com/webservice/PublicService.asmx/ServiceInterfaceUTF8

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

请求示例：

appToken=&appKey=&serviceMethod=blackcatgetqr&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 是 标签文件类型
1：PNG文件
2：PDF文件
configInfo.lable_paper_type string 是 纸张类型
1：标签纸(10*10厘米)
2：A4纸(21*29.7厘米)
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

返回示例：

                                {
    "success": 1,
    "cnmessage": "获取订单标签成功",
    "enmessage": "Get order label successfully",
    "data": [
        {
            "lable_file_type": "2",
            "lable_file": "http://customer.ydhex.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_file 标签文件url地址 string

发货证明

在线测试

请求方式：POST

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

请求地址：http://customer.ydhex.com/webservice/PublicService.asmx/ServiceInterfaceUTF8

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

请求示例：

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

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

返回示例：

                                {
    "success": 1,
    "cnmessage": "获取发货证明成功",
    "enmessage": "The delivery certificate is successfully obtained. Procedure",
    "data": [{"lable_file":"http://editest.ydhex.com/draw-lable/pdf/20240618/2024061813/71d0beb2-3976-4d3e-ab22-d74699b8cd36.pdf"}]
}
参数名 描述 类型
success 是否成功标志，0代表失败；1代表成功 int
cnmessage 中文消息 string
enmessage 英文消息 string
data 成功时返回的数据 array

签收证明

在线测试

请求方式：POST

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

请求地址：http://customer.ydhex.com/webservice/PublicService.asmx/ServiceInterfaceUTF8

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

请求示例：

appToken=&appKey=&serviceMethod=proofofdelivery&paramsJson={"reference_no":"YDH1006171532AZ"}

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

返回示例：

                                {
    "success": 1,
    "cnmessage": "获取签收证明成功",
    "enmessage": "The delivery certificate is successfully obtained. Procedure",
    "data": [{"lable_file":"http://editest.ydhex.com/draw-lable/pdf/20240618/2024061813/71d0beb2-3976-4d3e-ab22-d74699b8cd36.pdf"}]
}
参数名 描述 类型
success 是否成功标志，0代表失败；1代表成功 int
cnmessage 中文消息 string
enmessage 英文消息 string
data 成功时返回的数据 array

上传尾程面单

在线测试

请求方式：POST

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

请求地址：http://customer.ydhex.com/webservice/PublicService.asmx/ServiceInterfaceUTF8

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

请求示例：

appToken=&appKey=&serviceMethod=uploadlastmilelabel&paramsJson={"reference_no":"TEST2018000002","tracking_no":"JP987654321","label_type":"PDF","label_base64":"JVBERi0x...","label_url":""}

paramsJson参数 类型 必需 描述
reference_no string 是 OMS订单号（客户单号）
tracking_no string 是 尾程运单号
label_type string 是 面单文件类型，仅支持 PDF、PNG、JPG
label_base64 string 条件 面单文件 Base64 内容，与 label_url 二选一，优先使用 Base64；文件大小不超过 10MB
label_url string 条件 面单文件 URL，与 label_base64 二选一

返回示例：

                                {
    "success": 1,
    "cnmessage": "上传成功",
    "enmessage": "Upload succeeded"
}
参数名 描述 类型
success 是否成功标志，0代表失败；1代表成功 int
cnmessage 中文消息 string
enmessage 英文消息 string

同步出库节点时间

在线测试

请求方式：POST

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

请求地址：http://customer.ydhex.com/webservice/PublicService.asmx/ServiceInterfaceUTF8

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

请求示例：

appToken=&appKey=&serviceMethod=updateoutboundtime&paramsJson={"outboundNo":"CK202608210001","outboundTime":"2026-08-21 13:20:00"}

paramsJson参数 类型 必需 描述
outboundNo string 是 出库单号，对应系统客户单号 shipper_hawbcode
outboundTime datetime 是 出库时间，格式：yyyy-MM-dd HH:mm:ss

返回示例：

                                {
    "success": 1,
    "cnmessage": "success",
    "enmessage": "success",
    "code": "200",
    "message": "success"
}

失败示例：

                                {
    "success": 0,
    "cnmessage": "出库单号不能为空",
    "code": "500",
    "message": "出库单号不能为空"
}
参数名 描述 类型
success 是否成功标志，0代表失败；1代表成功 int
cnmessage 中文消息 string
code 返回状态码，200表示成功，500表示失败 string
message 返回信息。成功为 success；失败为 出库单号不能为空 / 出库时间不能为空 / 参数错误 / 订单不存在 / 系统异常 string