API接口文档

一、服务地址


HTTP POST请求服务地址:http://edi.ux-exp.com/OrderHandler.ashx

参数示例
paramsJson={}&appToken=&appKey=&serviceMethod=createorder
&identify=


二、请求参数

序号

参数

类型

必填

描述

1

appToken

String

API账号

2

appKey

String

API密码

3

serviceMethod

String

接口方法名

4

paramsJson

String

请求参数的数据内容,json格式(获取基础数据时此参数可为空)

5

identify

String

加盟商代码


三、接口方法名列表

序号

方法名

描述

1

createorder

提交订单

2

getnewlabel

获取订单标签

3

gettrack

获取跟踪记录

4

feetrail

费用试算

5

getcustomershippingmethod

getmailcargotype

getcountry

getcertificatetype

getdeclareunit

getextraservice

获取基础数据(运输方式、申报种类、国家、证件类型、申报单位 、额外服务)


四、接口方法介绍


1.createorder提交订单
  • paramsJson请求参数

参数名

数据类型

必填

说明

reference_no

string

客户参考号

shipping_method

string

运输方式代码

shipping_method_no

string

 

服务商单号

order_weight

float

 

订单重量,单位KG,默认为0.2

order_pieces

int

 

外包装件数,默认1

cargotype

string

 

货物类型
W:包裹
D:文件
B:袋子

mail_cargo_type

string

 

包裹申报种类
1:Gif礼品
2:CommercialSample 商品货样
3:Document 文件
4:Other 其他
默认4

return_sign

string

 

是否需要标识退件退回 (Y,N)

buyer_id

string

 

买家ID

order_info

string

 

订单备注

platform_id

int

 

平台ID
(如果您是电商平台,请联系我们添加并确认您对应的平台ID)

shipper

object

发件人信息

consignee

object

收件人信息

invoice

object[]

海关申报信息

lwgw

object[]

件信息

extra_service

object[]

 

额外服务

  • shipper参数

参数名

数据类型

必填

说明

shipper_name

string

发件人姓名

shipper_company

string

 

发件人公司名

shipper_countrycode

string

发件人国家二字码

shipper_province

string

 

发件人省

shipper_city

string

 

发件人城市

shipper_street

string

发件人地址

shipper_postcode

string

 

发件人邮编

shipper_areacode

string

 

发件人区域代码

shipper_telephone

string


(至少传一个)

发件人电话

shipper_mobile

string

发件人手机

shipper_email

string

 

发件人邮箱

shipper_fax

string

 

发件人传真

  • consignee参数

参数名

数据类型

必填

说明

consignee_name

string

收件人姓名

consignee_company

string

 

收件人公司名

consignee_countrycode

string

收件人国家代码

consignee_province

string

 

收件人省

consignee_city

string

 

收件人城市

consignee_street

string

收件人地址

consignee_postcode

string

 

收件人邮编

consignee_areacode

string

 

收件人区域代码

consignee_telephone

string


(至少传一个)

收件人电话

consignee_mobile

string

收件人手机

consignee_email

string

 

收件人邮箱

consignee_fax

string

 

收件人传真

consignee_certificatetype

string

 

证件类型代码
ID:身份证
PP:护照

consignee_certificatecode

string

 

证件号码

consignee_credentials_period

string

 

证件有效期

consignee_tariff

string

 

收件人税号

  • invoice参数

参数名

数据类型

必填

说明

sku

string

SKU

invoice_enname

string

英文品名

invoice_cnname

string

 

中文品名

invoice_quantity

int

数量

unit_code

string

 

单位(MTR(米), PCE(件), SET(套)),
默认PCE

invoice_unitcharge

float

单价

hs_code

string

 

海关协制编号

invoice_note

string

 

配货信息

invoice_url

string

 

销售地址

invoice_info

string

 

商品图片地址

  • lwgw参数

参数名

数据类型

必填

说明

involume_length

float

件长度

involume_width

float

件宽度

involume_height

float

件高度

involume_grossweight

float

件重量

  • extra_service参数

参数名

数据类型

必填

说明

extra_servicecode

string

额外服务类型代码

extra_servicevalue

string

额外服务值(有些额外服务类型必须传此值)

extra_servicenote

string

 

备注

  • 返回结果josn格式

参数名

数据类型

说明

success

int

是否成功标志,0代表失败;1代表成功

cnmessage

string

处理结果中文消息

enmessage

string

处理结果英文消息

data

object

成功时返回的数据

  • data结果式

参数名

数据类型

说明

refrence_no

string

客户参考号

shipping_method_no

string

服务商单号

//C#样例:





2.getnewlabel 获取订单标签
  • paramsJson请求参数

参数名

数据类型

必填

说明

configInfo

object

配置信息

listorder

object[]

订单信息(单次请求不能超过100条)

  • configInfo参数数

参数名

数据类型

必填

说明

lable_file_type

string

标签文件类型
1 :PNG文件
2 :PDF文件

lable_paper_type

string

纸张类型
1 :标签纸(10*10厘米)
2 :A4纸(21*29.7厘米)

lable_content_type

string

标签内容类型代码
1 :标签
2 :报关单
3 :配货单
4 :标签+报关单
5 :标签+配货单
6 :标签+报关单+配货单

additional_info

object

附加配置信息

  • additional_info参数

参数名

数据类型

必填

说明

lable_print_invoiceinfo

string

 

标签上打印配货信息 (Y:打印 N:不打印) 默认 N:不打印

lable_print_buyerid

string

 

标签上是否打印买家ID (Y:打印 N:不打印) 默认 N:不打印

lable_print_datetime

string

 

标签上是否打印日期 (Y:打印 N:不打印) 默认 Y:打印

customsdeclaration_print_actualweight

string

 

报关单上是否打印实际重量 (Y:打印 N:不打印) 默认 N:不打印

  • listorder参数

参数名

数据类型

必填

说明

reference_no

string

客户参考号

 

  • 返回结果json格式

参数名

数据类型

说明

success

int

是否成功标志,0代表失败;1代表成功

cnmessage

string

中文消息

enmessage

string

英文消息

data

object[]

成功时返回的数据

  • data结果

参数名

数据类型

说明

lable_file_type

string

标签文件类型
1 :PNG文件
2 :PDF文件

lable_file

string

标签文件url地址

//C#样例:



3.gettrack跟踪记录
  • paramsJson请求参数

参数名

数据类型

必填

说明

tracking_number

string

跟踪单号

  • 返回结果json格式

参数名

数据类型

说明

success

int

是否成功标志,0代表失败;1代表成功

cnmessage

string

中文消息

enmessage

string

英文消息

data

object[]

成功时返回的数据

  • data结果

参数名

数据类型

说明

server_hawbcode

string

跟踪单号

track_status

string

最新状态代码

track_status_name

string

最新状态名称

signatory_name

string

签收人

details

object[]

跟踪记录明细

  • details结果

参数名

数据类型

说明

track_occur_date

string

时间

track_location

string

地点

track_description

string

内容

track_code

string

轨迹代码

//C#样例:



4.feetrail费用试算

  • paramsJson请求参数

参数名

数据类型

必填

说明

shipping_method

string

运输方式代码

sender_name

string

发件人姓名

sender_company

string

发件人公司

sender_country

string

发件人国家二字码

sender_address_line

string

发件人地址

sender_state

string

发件人省州

sender_city

string

发件人城市

sender_zipcode

string

发件人邮编

sender_mobile

string

发件人手机号

sender_residential

string

发件人是否为住宅地址
参考值:2

receiver_name

string

收件人姓名

receiver_company

string

收件人公司

receiver_country

string

收件人国家二字码

receiver_address_line

string

收件人地址

receiver_state

string

收件人省州

receiver_city

string

收件人城市

receiver_zipcode

string

收件人邮编

receiver_mobile

string

收件人电话

receiver_residential

string

收件人地址是否为住宅地址
参考值:2

others_signature_service

string

签名服务,不传或传0: 无签名 、1:Adult Signature 2: Direct Signature

others_label_size

string

面单尺寸 1: 4 x 6 inches - adapter thermal printer 2: A4 - fit a4 laser printers

others_mailing_date

string

邮寄日期

others_packaging_type

string

参考值:YOUR_PACKAGING

others_po_no

string

others_invoice_no

string

others_department_no

string

others_freight_class

string

GFP用,计算方式请查看:https://www.freightclasscalc.com/calculator.php

express_type

string

可用参数:FEDEX_GROUND、GROUND_HOME_DELIVERY 、SMART_POST , FEDEX_2_DAY,UPS_GROUND, PRIORITY,FIRST_CLASS 不传则使用最便宜的价格

express_company

string

可用参数:FedEx / UPS / USPSL。不传则为全部

packages

object[]

件信息

  • packages参数

参数名

数据类型

必填

说明

length

float

件长度 单位(英寸)

width

float

件宽度 单位(英寸)

height

float

件高度 单位(英寸)

weight

float

件重量 (单位: 克)/fedex单位(磅/lb)

  • 返回结果json格式

参数名

数据类型

说明

success

int

是否成功标志,0代表失败;1代表成功

cnmessage

string

中文消息

enmessage

string

英文消息

fee_date

string

运费试算时间

fee

string

运费试算金额

//C#样例:



5.获取基础数据接口

  • paramsJson请求参数

参数名

数据类型

说明

success

int

是否成功标志,0代表失败;1代表成功

cnmessage

string

中文消息

enmessage

string

英文消息

data

object[]

成功时返回的数据

  • data结果

参数名

数据类型

说明

code

string

代码

cnname

string

中文名

enname

string

英文名

note

string

备注

//C#样例:

邮行天下提供技术支持