admin管理员组

文章数量:1533865

2024年6月19日发(作者：)

4PX 物流接口参数说明

深圳递四方速递

2012-06

版本信息

版本 最后修改日

期

0.1

0.2

0.3

2012-6-27

2012-11-14

2016-04-11

陈宏波

陈宏波

缪金荣

建立文档

修改文档

修改文档

增加黄色底字段

和1.11/1.12

0.4 2016-07-13

缪金荣 增加投保类型为6P时的投保

信息内容：

InsurApplicant、

InsurCardNo、InsurCargoName、

InsurQuantityPack

修改人 修改内容 备注

增加1.1、1.3、1.4

黄色底字段

0.5 2017-07-29

吴中卫 1.修改了wsdl调用的url

2.创建并预报接口修改为

createAndPreAlertOrderSer

viceNew

3.增加补充说明

增加返回的参数

fpxOrderNo

黄色底字段

目录

1. 概述.............................................................................................................................................. 5

1.1. 写作目的 ........................................................................................................................... 5

1.2. 本文读者 ........................................................................................................................... 5

1.3. 调用方式 ........................................................................................................................... 5

...................................................................................................................... 5

订单验证流程 .................................................................................................. 5

2 API 接口参数 .......................................................................................................................... 6

2.1. 创建订单 ........................................................................................................................... 6

2.1.1. 请求参数 ........................................................................................................... 6

2.1.2. 返回参数 ......................................................................................................... 13

2.2. 预报订单 ......................................................................................................................... 14

2.2.1. 请求参数 .............................................................................................................. 14

2.2.2. 返回参数 .............................................................................................................. 15

2.3. 创建并预报订单 ............................................................................................................. 16

2.3.1. 请求参数 .............................................................................................................. 17

2.3.2. 返回参数 .............................................................................................................. 23

2.4. 修改订单 ......................................................................................................................... 25

2.4.1. 请求参数 .............................................................................................................. 25

2.4.2. 返回参数 .............................................................................................................. 30

2.5. 删除订单 ......................................................................................................................... 32

2.5.1. 请求参数 .............................................................................................................. 32

2.5.2. 返回参数 .............................................................................................................. 33

2.6. 查询订单 ......................................................................................................................... 34

2.6.1. 请求参数 .............................................................................................................. 34

2.6.2. 返回参数 .............................................................................................................. 36

2.7. 运费试算 ......................................................................................................................... 41

2.7.1. 请求参数 .............................................................................................................. 42

2.7.2. 返回参数 .............................................................................................................. 44

2.8. 查询轨迹 ......................................................................................................................... 47

2.8.1. 请求参数 .............................................................................................................. 47

2.8.2. 返回参数 .............................................................................................................. 47

2.9. 申请拦截 ......................................................................................................................... 49

2.9.1. 请求参数 .............................................................................................................. 50

2.9.2. 返回参数 .............................................................................................................. 50

2.10. 查询跟踪号 ................................................................................................................... 51

2.10.1. 请求参数 ............................................................................................................ 52

3

2.10.2. 返回参数 ............................................................................................................ 52

2.11.查询标签信息 ................................................................................................................. 54

2.11.1 请求参数 ............................................................................................................. 54

2.11.2 返回参数 ............................................................................................................. 54

2.12.打印标签（获取标签图片字节流） ............................................................................. 57

2.12.1 请求参数 ............................................................................................................. 57

2.12.2 返回参数 ............................................................................................................. 58

补充说明 ................................................................................................................................. 59

3.1基础数据参照表 ............................................................................................................... 59

3.2常用接口错误代码说明 ................................................................................................... 59

3.2.1创建并预报异常代码说明 .................................................................................... 59

1. 概述

1.1. 写作目的

本文档是 4PX 提供的物流接口参数说明，以供开发人员和测试人员参考。

1.2. 本文读者

本文主要读者为开发员和测试员。

1.3. 调用方式

在线订单操作---生产环境：

:8058/OrderOnline/ws/?wsdl

在线订单工具---生产环境：

:8059/OrderOnlineTool/ws/

?wsdl

订单验证流程

第一步：申请/ 网站上的账号，获得token

第二步：在API上传订单

第三步：在/ 上查看上传的订单信息

注：无论是 WSDL或SDK调用方式，如要上线，必需向我司申请正式WSDL或 SDK。

2 API 接口参数

2.1. 创建订单

类 型: 在线订单操作

接口名称：createOrderService

2.1.1. 请求参数

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

<

InsurApplicant>String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

Argument Type Requir

ed

1 AuthToken String

√ 调用 API 唯一标识，由 4PX

提供

length = 32

2

2.1 OrderNo

CreateOrderRequest

String

√ 客户订单号码，由客户自己

定义

length <=20

2.2 TrackingNumber String

服务商跟踪号码，由 4PX

提供，

客户如果有相应服务商跟

踪号，

也可以提供，但我司会校验

是否

有效，无效则重新分配

Length < =30

2.3 ProductCode String

√ 产品代码，指 DHL、新加

Meaning

坡小包

挂号、联邮通挂号等，参照

产品

代码表

Length = 2

2.4 CargoCode String

货物类型(默认：P)，参照货

物类

型表

Length = 1

2.5 PaymentCode String

付款类型(默认：P)，参照付

款类

型表

Length = 1

2.6 InitialCountryCode String

起运国家二字代码，参照国

家代

码表

Length = 2

2.7 DestinationCountry

Code

String

√ 目的国家二字代码，参照国

家代码表

Length = 2

2.8 Pieces String 货物件数(默认：1)

0 < Amount <= 999

2.9 InsurType String 保险类型，参照保险类型

表

Length = 2

2.1

0

2.1

1

BuyerId String

InsurValue String 保险价值(单位：USD)

0 < Amount <= [10,2]

买家 ID

Length <= 30

2.1

2

ReturnSign String 小包退件标识

Y: 发件人要求退回

N: 无须退回(默认)

Length = 1

2.1

3

CustomerWeight String 客户自己称的重量(单位

：KG)

0 < Amount <= [10,2]

2.1

4

2.1

5

2.1

6

2.1

7

2.1

8

2.1

9

2.2

0

2.2

1

2.2

2

2.2

3

2.2

4

TransactionId String 交易 ID

Length <= 30

ShipperCompany

Name

ShipperName

String 发件人公司名称

Length <= 60

String 发件人姓名

Length <= 60

ShipperAddress String 发件人地址

Length <= 180

ShipperTelephone String 发件人电话号码

Length <= 30

ShipperFax String 发件人传真号码

Length <= 30

ShipperPostCode String 发件人邮编

Length <= 10

ConsigneeCompa

nyName

ConsigneeName

String 收件人公司名称

Length <= 60

String √ 收件人姓名

Length <= 60

Street String √ 街道

Length <= 60

City String √ 城市

Length <= 60

2.2

5

2.2

6

2.2

7

2.2

8

2.2

9

2.3

0

2.3

7

StateOrProvince String √ 州 / 省

Length <= 60

ConsigneeTeleph

one

ConsigneeFax

String 收件人电话号码

Length <= 30

String 收件人传真号码

Length <= 30

ConsigneePostCo

de

ConsigneeEmail

String 收件人邮编

Length <= 10

String 收件人 Email

Length <= 50

orderNote

String 订单备注信息

Length <= 256

InsurApplicant

String

投保类型为6P时，投保人

（个人名义时真实姓名，

公司名义时公司全称）

2.3

8

2.3

9

2.4

0

2.3

1

2.3

1.1

2.3

1.2

2.3

1.3

InsurCardNo

String

投保类型为6P时，个人名

义投保时投保人身份证号

InsurCargoName

String

投保类型为6P时，货物名

称描述

InsurQuantityPack

String

投保类型为6P时，货物包

装与数量描述

DeclareInvoice

EName String √ 海关申报英文品名

Length <= 200

CName String 海关申报中文品名

Length <= 200

DeclareUnitCode String 申报单位类型代码(默认:

PCE)，

参照申报单位类型代码表

Length <= 3

2.3

1.4

2.3

1.5

2.3

1.6

2.3

1.7

2.3

1.8

2.3

1.9

2.3

2

2.3

3

2.3

4

Needpod

Hasbattery

Itemurl

Hscode

DeclarePieces String 件数(默认: 1)

0 < Amount <= 999

UnitPrice String 单价

0 < Amount <= [10,2]

DeclareNote String 配货备注

Length <= 256

Name String 配货名称

String

海关申报货物编号

String

产品的Url

String

是否带电标识(Y:是,N:否)

Mctcode

String

内容类型,邮政货物种类代码

String

是否需要POD(Y:是,N:否) 交

付凭证，它一共分四联（也有

五联、六联的），也可以指收

件人的签名。

2.3

5

Prealertintegrationty

pe

String

对接类型，数据对接类型代

码，例如网站上传、离线预报

上传、Api对接、仓储写入等

2.3

6

Shipperstateorprovin

ce

String

发件人州 省

2.1.2. 返回参数

String

String

String

String

String

String

String

String

String

String

1

2

Argument

Timestamp

ReferenceNumb

er

3 TrackingNumber String

服务商跟踪号码

Type

String

String

服务器响应时间

引用单号，一般为客户单号

Meaning

4 Ack String

操作状态

成功: Success

失败: Failure

5

5.

1

5.

2

5.

3

5.

4

5.

5

5.

6

DefineMessage String

EnAction String

EnMessage String

CnAction String

CnMessage String

Code String

Error

错误代码

错误详细内容中文描述

错误的处理方法中文描述

错误详细内容英文描述

错误的处理方法英文描述

错误信息补充说明

2.2. 预报订单

类 型: 在线订单操作

接口名称：preAlertOrderService

2.2.1. 请求参数

String

String

Argument

1 AuthToken

Type

Strin

g

Required

√

Meaning

调用 API 唯一标识，由 4PX 提

供

length = 32

2 ReferenceNumber Strin

g

√

引用单号，可以是客户单号

或服

务商单号

length <= 30

2.2.2. 返回参数

< PreAlertOrderService >

String

String

String

String

String

String

String

String

String

String

1

2

Argument

Timestamp

ReferenceNumbe

r

3

4

Type

String

String

服务器响应时间

Meaning

引用单号，一般为客户单号

TrackingNumber

Ack

String

String

服务商跟踪号码

操作状态

成功: Success

失败: Failure

5

5.1

5.2

5.3

5.4

5.5

5.6

Error

Code

CnMessage

CnAction

EnMessage

EnAction

DefineMessage

String

String

String

String

String

String

错误代码

错误详细内容中文描述

错误的处理方法中文描述

错误详细内容英文描述

错误的处理方法英文描述

错误信息补充说明

2.3. 创建并预报订单

类 型: 在线订单操作

接口名称：createAndPreAlertOrderServiceNew

2.3.1. 请求参数

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

<

InsurApplicant>String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

Argument Type Requir

ed

Meaning

1

AuthToken String

√ 调用 API 唯一标识，由 4PX

提供

length = 32

2

2.

1

CreateOrderServiceRequest

OrderNo String

√ 客户订单号码，由客户自己定

义

length <=20

2.

2

TrackingNumber String

服务商跟踪号码，由 4PX 提

供，

客户如果有相应服务商跟踪

号，

也可以提供，但我司会校验是

否

有效，无效则重新分配

Length < =30

2.

3

ProductCode String

√ 产品代码，指 DHL、新加坡

小包

挂号、联邮通挂号等，参照产

品

代码表

Length = 2

2.

4

CargoCode String

货物类型(默认：P)，参照货物

类

型表

Length = 1

2.

5

PaymentCode String

付款类型(默认：P)，参照付款

类

型表

Length = 1

2.

6

InitialCountryCode String

起运国家二字代码，参照国家

代

码表

Length = 2

2.

7

DestinationCountryCo

de

String

√ 目的国家二字代码，参照国家

代

码表

2.

8

2.

9

2.1

0

2.1

1

2.1

2

Pieces String

货物件数(默认：1)

0 < Amount <= 999

InsurType String

保险类型，参照保险类型表

Length = 2

InsurValue String

保险价值(单位：USD)

0 < Amount <= [10,2]

BuyerId String

买家 ID

Length <= 30

ReturnSign String

小包退件标识

Y: 发件人要求退回

N: 无须退回(默认)

Length = 1

2.1

3

2.1

4

CustomerWeight String

客户自己称的重量(单位：KG)

0 < Amount <= [10,2]

TransactionId String

交易 ID

Length <= 30

2.1

5

2.1

6

2.1

7

2.1

8

2.1

9

2.2

0

2.2

1

2.2

2

2.2

3

2.2

4

2.2

5

2.2

6

2.2

7

2.2

8

2.2

ShipperCompanyNam

e

ShipperName

String

发件人公司名称

Length <= 60

String

发件人姓名

Length <= 60

ShipperAddress String

发件人地址

Length <= 180

ShipperTelephone String

发件人电话号码

Length <= 30

ShipperFax String

发件人传真号码

Length <= 30

ShipperPostCode String

发件人邮编

Length <= 10

ConsigneeCompanyNa

me

ConsigneeName

String

收件人公司名称

Length <= 60

String

√ 收件人姓名

Length <= 60

Street String

√ 街道

Length <= 60

City String

√ 城市

Length <= 60

StateOrProvince String

√ 州 / 省

Length <= 60

ConsigneeTelephone String

收件人电话号码

Length <= 30

ConsigneeFax String

收件人传真号码

Length <= 30

ConsigneePostCode String

收件人邮编

Length <= 10

ConsigneeEmail String

收件人 Email

9

2.3

0

Length <= 50

orderNote String

订单备注信息

Length <= 256

InsurApplicant

2.

37

String

投保类型为6P时，投保人

（个人名义时真实姓名，

公司名义时公司全称）

2.

38

2.

39

2.

40

2.3

1

2.3

1.1

2.3

1.2

2.3

1.3

InsurCardNo

String

投保类型为6P时，个人名

义投保时投保人身份证号

InsurCargoName

String

投保类型为6P时，货物名

称描述

InsurQuantityPack

String

投保类型为6P时，货物包

装与数量描述

DeclareInvoice

EName String

√ 海关申报英文品名

Length <= 200

CName String

海关申报中文品名

Length <= 200

DeclareUnitCode String

申报单位类型代码(默认:

PCE)，

参照申报单位类型代码表

Length <= 3

2.3

1.4

2.3

1.5

2.3

1.6

DeclarePieces String

件数(默认: 1)

0 < Amount <= 999

UnitPrice String

单价

0 < Amount <= [10,2]

DeclareNote String

配货备注

Length <= 256

String

配货名称

31

.7

2.

31

.8

2.

31

.9

2.

32

2.

33

2.

34

NeedPOD

Hasbattery

Itemurl

Hscode

String

海关申报货物编号

String

产品的Url

String

是否带电标识(Y:是,N:否)

Mctcode

String

内容类型,邮政货物种类代码

String

是否需要POD(Y:是,N:否) 交

付凭证，它一共分四联（也有

五联、六联的），也可以指收

件人的签名。

2.

35

Prealertintegrationtyp

e

String

对接类型，数据对接类型代

码，例如网站上传、离线预报

上传、Api对接、仓储写入等

2.

36

Shipperstateorprovinc

e

String

发件人州 省

2.3.2. 返回参数

String

String

String

String

String

String

String

String

String

String

String

1

2

3

4

5

Argument

Timestamp

ReferenceNumber

TrackingNumber

Type

String

String

String

String

String

服务器响应时间

Meaning

引用单号，一般为客户单号

服务商跟踪号码

4PX唯一单号

操作状态

成功: Success

失败: Failure

fpxOrderNo

Ack

6

6.1

6.2

Error

Code

CnMessage

String

String

错误代码

错误详细内容中文描述

6.3

6.4

6.5

6.6

CnAction

EnMessage

EnAction

DefineMessage

String

String

String

String

错误的处理方法中文描述

错误详细内容英文描述

错误的处理方法英文描述

错误信息补充说明

2.4. 修改订单

类 型:在线订单操作

接口名称：modifyOrderService

2.4.1. 请求参数

String

String

String

String

String

String

String

String

String

String

String

<

InsurApplicant>String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

Argument Type Requi

red

Meaning

1

AuthToken String

√ 调用 API 唯一标识，由 4PX 提

供

length = 32

2

2.1

CreateOrderServiceRequest

OrderNo String

√ 客户订单号码，由客户自己定义

length <=20

2.2

TrackingNumber String

服务商跟踪号码，由 4PX 提

供，

客户如果有相应服务商跟踪号，

也可以提供，但我司会校验是否

有效，无效则重新分配

Length < =30

2.3

ProductCode String

√ 产品代码，指 DHL、新加坡小

挂号、联邮通挂号等，参照产品

代码表

Length = 2包

2.4

CargoCode String

货物类型(默认：P)，参照货物

类

型表

Length = 1

2.5

PaymentCode String

付款类型(默认：P)，参照付款

类

型表

Length = 1

2.6

InitialCountryCode String

起运国家二字代码，参照国家代

码表

Length = 2

2.7

DestinationCountryC

ode

String

√ 目的国家二字代码，参照国家代

码表

Length = 2

2.8

Pieces String

货物件数(默认：1)

0 < Amount <= 999

2.9

InsurType String

保险类型，参照保险类型表

Length = 2

2.10

InsurValue String

保险价值(单位：USD)

0 < Amount <= [10,2]

2.11

BuyerId String

买家 ID

Length <= 30

2.12

ReturnSign String

小包退件标识

Y: 发件人要求退回

N: 无须退回(默认)

Length = 1

2.13

CustomerWeight String

客户自己称的重量(单位：KG)

0 < Amount <= [10,2]

2.14

TransactionId String

交易 ID

Length <= 30

2.15

ShipperCompanyNa

me

String

发件人公司名称

Length <= 60

2.16

ShipperName String

发件人姓名

Length <= 60

2.17

ShipperAddress String

发件人地址

Length <= 180

2.18

ShipperTelephone String

发件人电话号码

Length <= 30

2.19

ShipperFax String

发件人传真号码

Length <= 30

2.20

ShipperPostCode String

发件人邮编

Length <= 10

2.21

ConsigneeCompany

Name

String

收件人公司名称Length <= 60

2.22

ConsigneeName String

√ 收件人姓名

Length <= 60

2.23

Street String

√ 街道

Length <= 60

2.24

City String

√ 城市

Length <= 60

2.25

StateOrProvince String

√ 州 / 省

Length <= 60

2.26

ConsigneeTelephone String

收件人电话号码

Length <= 30

2.27

ConsigneeFax String

收件人传真号码

Length <= 30

2.28

ConsigneePostCode String

收件人邮编

Length <= 10

2.29

ConsigneeEmail String

收件人 Email

Length <= 50

2.30

Note String

订单备注信息

Length <= 256

2.3

7

InsurApplicant

String

投保类型为6P时，投保人

（个人名义时真实姓名，公

司名义时公司全称）

2.3

8

2.3

9

2.4

0

2.31

2.31.

1

2.31.

2

2.31.

3

InsurCardNo

String

投保类型为6P时，个人名义

投保时投保人身份证号

InsurCargoName

String

投保类型为6P时，货物名称

描述

InsurQuantityPack

String

投保类型为6P时，货物包装

与数量描述

DeclareInvoice

EName String

√ 海关申报英文品名

Length <= 200

Name String

海关申报中文品名

Length <= 200

DeclareUnitCode String

申报单位类型代码(默认: PCE)，

参照申报单位类型代码表

Length <= 3

2.31.

4

2.31.

5

2.31.

6

DeclarePieces String

件数(默认: 1)

0 < Amount <= 999

UnitPrice String

单价

0 < Amount <= [10,2]

DeclareNote String

配货备注

Length <= 256

2.4.2. 返回参数

String

String

String

String

String

String

String

String

String

String

Argument Ty

pe

Meaning

1

Timestamp Stri

ng

服务器响应时间

2

ReferenceNumber Stri

ng

引用单号，一般为客户单号

3

TrackingNumber Stri

ng

服务商跟踪号码

4

Ack Stri

ng

操作状态

成功: Success

失败: Failure

5

5.1

Error

Code Stri

ng

错误代码

5.2

CnMessage Stri

ng

错误详细内容中文描述

5.3

CnAction Stri

ng

错误的处理方法中文描述

5.4

EnMessage Stri

ng

错误详细内容英文描述

5.5

EnAction Stri

ng

错误的处理方法英文描述

5.6

DefineMessage Stri

ng

错误信息补充说明

2.5. 删除订单

类 型: 在线订单操作

接口名称：removeOrderService

2.5.1. 请求参数

String

String

Argument

1 AuthToken

Type

String

Require

√

供

length = 32

Meaning

调用 API 唯一标识，由 4PX 提

2 ReferenceNumber String √

引用单号，可以是客户单号或

服

2.5.2. 返回参数

String

String

String

String

String

String

String

String

String

1

2

Argument

Timestamp

ReferenceNumbe

r

3

Type

String

String

服务器响应时间

Meaning

引用单号，一般为客户单号

Ack String

操作状态

成功: Success

失败: Failure

4

4.1

4.2

4.3

4.4

4.5

4.6

Error

Code

CnMessage

CnAction

EnMessage

EnAction

DefineMessage

String

String

String

String

String

String

错误代码

错误详细内容中文描述

错误的处理方法中文描述

错误详细内容英文描述

错误的处理方法英文描述

错误信息补充说明

2.6. 查询订单

类 型: 在线订单操作

接口名称：findOrderService

2.6.1. 请求参数

String

String

String

String

String

Argument Type Require

d

Meaning

1 AuthToken String √

调用 API 唯一标识，由 4PX 提

供

length = 32

2

2.1 ReferenceNumber String

FindOrderRequest

√

引用单号，可以是客户单号

或服

务商单号

length <= 30

2.2

StartTime

String

开始时间,默认为创建订单时

间，

结合订单状态(Status)查询

length <= 30

2.3

EndTime

String

结束时间,默认为创建订单时

间，

结合订单状态(Status)查询

length <= 30

2.4

Status

String 订单状态，参照订单状态表

length = 1

2.6.2. 返回参数

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

1

2

3

Argument

Timestamp

ReferenceNumber

Ack

Type

String

String

String

Meaning

服务器响应时间

引用单号，一般为客户单号

操作状态

成功: Success

失败: Failure

4

4.1

4.2

4.3

4.4

4.5

4.6

Error

Code

CnMessage

CnAction

EnMessage

EnAction

DefineMessage

String

String

String

String

String

String

错误代码

错误详细内容中文描述

错误的处理方法中文描述

错误详细内容英文描述

错误的处理方法英文描述

错误信息补充说明

5

5.1

5.2

OrderItem

OrderNo

TrackingNumber

String

String

客户订单号码，由客户自己定义

服务商跟踪号码，由 4PX 提供，客户

如果有相应服务商跟踪号，也可以提

供，但我司会校验是否有效，无效则

重

新分配

5.3

5.4

ChannelHawbCode

ProductCode

String

String

渠道转单号，由服务商换单后的号码

产品代码，指 DHL、新加坡小包挂号、

联邮通挂号等，参照产品代码表

5.5

5.6

5.7

5.8

5.9

5.10

5.11

5.12

5.13

CargoCode

PaymentCode

InitialCountryCode

DestinationCountryCode

Pieces

InsurType

InsurStatus

InsurValue

ODACheckSign

String

String

String

String

String

String

String

String

String

货物类型(默认：P)，参照货物类型表

付款类型(默认：P)，参照付款类型表

起运国家二字代码，参照国家代码表

目的国家二字代码，参照国家代码表

货物件数(默认：1)

保险类型，参照保险类型表

保险状态，参照保险状态表

保险价值(单位：USD)

ODA 校验标志

Y：表示已经校验过

N：表示尚未校验

5.14

ODASign String

ODA 标志

Y：表示为 ODA

N：表示非 ODA

U：表示未知

5.15

HoldSign String

拦截标志

Y：表示发件人要求拦截

N：表示放行

5.16

5.17

5.18

5.19

5.20

5.21

5.22

5.23

5.24

BuyerId

CreateDate

ModifyDate

PrintDate

ConfirmDate

PostDate

CheckInDate

CheckOutDate

ReturnSign

String

String

String

String

String

String

String

String

String

买家 ID

创建订单时间

最后修改订单时间

打印标签时间

确认订单时间

预报订单时间

签入时间

签出时间

小包退件标识

Y: 发件人要求退回

N: 无须退回(默认)

5.25

5.26

5.27

5.28

5.29

5.30

5.31

5.32

5.33

5.34

5.35

CustomerWeight

GrossWeight

VolumeWeight

ChargeWeight

TransactionId

ShipperCompany

ShipperName

ShipperAddress

ShipperTelephone

ShipperFax

ShipperPostCode

String

String

String

String

String

String

String

String

String

String

String

客户自己称的重量(单位：KG)

实际重量

体积重

计费重量

交易 ID

发件人公司名称

发件人姓名

发件人地址

发件人电话号码

发件人传真号码

发件人邮编

5.36

5.37

5.38

5.39

5.40

5.41

5.42

5.43

5.44

5.45

5.46

ConsigneeCompany

ConsigneeName

ConsigneeAddress1

ConsigneeAddress2

ConsigneeAddress3

ConsigneeTelephone

ConsigneeFax

ConsigneePostCode

ConsigneeEmail

OrderNote

String

String

String

String

String

String

String

String

String

String

Declar

eInvoic

eItem

收件人公司名称

收件人姓名

收件人地址 1(街道)

收件人地址 2(城市)

收件人地址 3(州 / 省)

收件人电话号码

收件人传真号码

收件人邮编

收件人 Email

订单备注信息

5.46.

1

5.46.

2

5.46.

3

5.46.

4

5.46.

5

5.46.

6

EName String

海关申报英文品名

Name String

海关申报中文品名

DeclareUnitCode String

申报单位类型代码(默认: PCE)，参照申

报单位类型代码表

DeclarePieces String

件数(默认: 1)

UnitPrice String

单价

DeclareNote String

配货备注

2.7. 运费试算

类 型: 在线订单工具

接口名称：chargeCalculateService

2.7.1. 请求参数

String

String

String

String

String

String

String

String

String

Argument Type Require

d

Meaning

1 AuthToken String

√ 调用 API 唯一标识，由 4PX

提供

length = 32

2

2.1

ChargeCalculateRequest

StartShipmentId String

起运地 ID，参照起运地 ID

表

Length <= 4

2.2 CountryCode String

√ 目的国家二字代码，参照国家

代

码表

Length = 2

2.3 Weight String

√ 计费重量，单位(kg)

0 < Amount <= [3,3]

2.4 Length String

长度(计算体积重使用)

0 < Amount <= [3,3]

2.5 Width String

宽度(计算体积重使用)

0 < Amount <= [3,3]

2.6 Height String

高度(计算体积重使用)

0 < Amount <= [3,3]

2.7 CargoCode String

货物类型(默认：P)

Length = 1

2.8 DisplayOrder String

计费结果产品显示级别(默认：

1)

Length = 1

2.9 ProductCode String[

]

产品代码组,该属性不为空，只

返

回该产品组计费结果，参照产

品代

码表

Length = 2

2.10 PostCode String

邮编

Length <= 10

2.7.2. 返回参数

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

1

2

3

Argument

Timestamp

ReferenceNumber

Ack

Type

String

String

String

Meaning

服务器响应时间

引用单号，一般为客户单号

操作状态

成功: Success

失败: Failure

4

4.1

4.2

4.3

4.4

4.5

4.6

5

5.1

5.2

5.3

5.4

5.5

5.6

5.7

5.8

5.9

5.10

5.11

5.12

5.13

5.14

Error

Code

CnMessage

CnAction

EnMessage

EnAction

DefineMessage

CalculateFee

FreightAmount

FreightOilAmount

IncidentalAmount

TotalAmount

CurrencyCode

ProductCName

ProductEName

ProductCode

Deliveryperiod

Tracking

Volumn

TotalRmbAmount

FreightRmbAmount

FreightOilRmbAmoun

t

5.15 IncidentalRmbAmoun

t

String

人民杂费金额

String

String

String

String

String

String

String

String

String

String

String

String

String

String

运费金额

燃油附加费金额

杂费金额

总费用金额

币种

产品中文名称

产品英文名称

产品代码

递送时间

可跟踪

按体积重量计费

人民币总费用

人民币运费金额

人民燃油附加费金额

String

String

String

String

String

String

错误代码

错误详细内容中文描述

错误的处理方法中文描述

错误详细内容英文描述

错误的处理方法英文描述

错误信息补充说明

5.16

Note String

备注

2.8. 查询轨迹

类 型: 在线订单工具

接口名称：cargoTrackingService

2.8.1. 请求参数

String

String

1

2

Argument

AuthToken

Type

String

Required Meaning

√

√

调用 API 唯一标识，由 4PX

提供

引用单号，可以是客户单号或

服

ReferenceNumber String

2.8.2. 返回参数

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

1

2

3

Argument

Timestamp

ReferenceNumber

Ack

Type

String

String

String

Meaning

服务器响应时间

引用单号，一般为客户单号

操作状态

成功: Success

失败: Failure

4

4.1

4.2

4.3

4.4

4.5

4.6

5

5.1

5.2

5.3

5.4

5.5

5.6

5.10.

5.10.

5.10.

5.10.

Error

Code

CnMessage

CnAction

EnMessage

EnAction

DefineMessage

Track

TrackingNumber

ProductCode

SignForPerson

SignForDate

DestinationCountry

TrackInfo

TrackCode

TrackContent

OccurDate

OccurAddress

String

String

String

String

轨迹代码，参照轨迹代码表

轨迹状态描述补充

轨迹发生时间

轨迹发生地点

String

String

String

String

String

服务商跟踪号码

产品代码，参照产品代码表

签收人

签收日期

目的地国家代码

String

String

String

String

String

String

错误代码

错误详细内容中文描述

错误的处理方法中文描述

错误详细内容英文描述

错误的处理方法英文描述

错误信息补充说明

2.9. 申请拦截

类 型: 在线订单工具

接口名称：cargoHoldService

2.9.1. 请求参数

String

String

1

2

Argument

AuthToken

Type

String

Required Meaning

√

√

调用 API 唯一标识，由 4PX

提供

引用单号，可以是客户单号或

服

ReferenceNumber String

2.9.2. 返回参数

String

String

String

String

String

String

String

String

String

1

2

3

Argument

Timestamp

ReferenceNumber

Ack

Type

String

String

String

Meaning

服务器响应时间

引用单号，一般为客户单号

操作状态

成功: Success

失败: Failure

4

4.1

4.2

4.3

4.4

4.5

4.6

Error

Code

CnMessage

CnAction

EnMessage

EnAction

DefineMessage

String

String

String

String

String

String

错误代码

错误详细内容中文描述

错误的处理方法中文描述

错误详细内容英文描述

错误的处理方法英文描述

错误信息补充说明

2.10. 查询跟踪号

类 型: 在线订单工具

接口名称：findTrackingNumberService

2.10.1. 请求参数

String

String

Argument Type Require

d

Meaning

1 AuthToken String √

调用 API 唯一标识，由 4PX 提

供

length = 32

2 ReferenceNumber String √

引用单号，可以是客户单号

或服

务商单号

length <= 30

2.10.2. 返回参数

String

String

String

String

String

String

String

String

String

String

String

1

2

3

4

5

Argument

Timestamp

ReferenceNumber

TrackingNumber

ChannelNumber

Ack

Type

String

String

String

String

String

Meaning

服务器响应时间

引用单号，一般为客户单号

服务商跟踪号码

渠道转单号

操作状态

成功: Success

失败: Failure

6

6.1

6.2

6.3

6.4

Error

Code

CnMessage

CnAction

EnMessage

String

String

String

String

错误代码

错误详细内容中文描述

错误的处理方法中文描述

错误详细内容英文描述

6.5

6.6

EnAction

DefineMessage

String

String

错误的处理方法英文描述

错误信息补充说明

2.11.查询标签信息

类 型: 在线订单工具

接口名称：findLabelDataService

2.11.1 请求参数

String

String

1

2

Argument Type Required Meaning

AuthToken

ReferenceNumb

er

String

String

√

√

调用API唯一标识，由4PX提供

length = 32

引用单号，可以是客户单号或服

务商单号

length <= 30

2.11.2 返回参数

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

String

1

2

3

4

Argument

TimeStamp

ReferenceNumber

TrackingNumber

Ack

Meaning

响应时间,yyyy-MM-dd HH:mm:ss

引用单号，一般为客户单号

服务商跟踪号码

操作状态 成功: Success 失败:

Failure

LabelData

String 公司代码

String 回邮地址

String 收件人名字

String 地址1

String 地址2

String 地址3

String 收件人电话

String 收件人邮编

String 是否购买保险(Y OR N)

String 区域码

String 国家代码

String 国家名称

String 客服员代码

String 销售员代码

String 产品代码

String 产品简称

String 产品中文名称

String 产品英文名称

String 是否退件(Y OR N)

String 是否为高投保(Y OR N)

String 计费分区

DeclareInvoiceData

Type

String

String

String

String

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

CompanyCode

ReturnAddress

ConsigneeName

ConsigneeAddress1

ConsigneeAddress2

ConsigneeAddress3

ConsigneeTelephone

PostCode

InsuranceSign

Zone

CountryCode

CountryName

CustomerService

Sales

ProductCode

ProductShortName

ProductCName

ProductEName

ReturnSign

HighInsureSign

ChargeZone

25

26

27

27

29

30

DiEName

DiCName

DiUnitPrice

DiPcs

DiNote

CargoType

31

32

33

34

35

36

37

38

39

TotalWeight

TotalValue

DiName

Code

CnMessage

CnAction

EnMessage

EnAction

DefineMessage

String 申报英文品名

String 申报中文品名

String 单价

String 数量

String 备注

DeclarationData

String 货物类型 default 1(礼物)

1 - Gift

2 - Documents

3 - Commercial sample

4 - Other

String 总重量 default 0.2kg

String 总申报价值

String 申报品名(可能存在多个)

Error

String 错误代码

String 错误详细内容中文描述

String 错误的处理方法中文描述

String 错误详细内容英文描述

String 错误的处理方法英文描述

String 错误信息补充说明

2.12.打印标签（获取标签图片字节流）

类 型: 在线订单工具

接口名称：propsPrintLabelPng

2.12.1 请求参数

String

String

String

String

String

String

String

String

String

Argument

1

IsPrintTime

2

IsPrintBuyerId

3

IsPeihuoInfo

4

IsPeihuoList

5

IsDeclarationList

6

IsCustomerWeight

7

IsPeihuoBarcode

8

OrderNo

Type

Required

Meaning

String

String

String

String

String

String

String

String

是否打印时间: Y/N

是否打印买家ID: Y/N

是否打印配货信息: Y/N

是否打印配货单Y/N

是否打印配报关单Y/N

是否打印客户重

是否打印配货单的条形码

订单号

2.12.2 返回参数

String

String

String

byte

String

String

String

String

String

String

Argument

Type

Meaning

1

2

3

4

5

6

7

8

9

10

Timestamp

ReferenceNumber

Ack

Images

Code

CnMessage

CnAction

EnMessage

EnAction

DefineMessage

String

String

String

Byte[][]

String

String

String

String

String

String

响应时间,yyyy-MM-dd HH:mm:ss

引用单号，一般为客户单号

操作状态 成功: Success 失败: Failure

图片转换的字符集

Error

错误代码

错误详细内容中文描述

错误的处理方法中文描述

错误详细内容英文描述

错误的处理方法英文描述

错误信息补充说明

3 补充说明

3.1基础数据参照表

ORDER DATA

CODE MAPPING

3.2常用接口错误代码说明

3.2.1创建并预报异常代码说明

错误代码

/Error-code

A001034

A000002

A001000

A001002

A001017

A001035

A001037

A001048

说明

Token不能为Null

Token无效,未找到相关信息

系统异常

海关信息不能为空

公司ID不能为空

请求参数有误,不能为Null或没有数据.

澳邮换号失败

此产品到该国家目前不支持POD服务

A001049

A001050

A001051

A001052

A001053

A001056

A002001

A002002

A002003

A002004

A002005

A002006

A002007

A002008

A002009

A002010

A002011

A002012

A002013

A002014

A002015

A002016

A002017

A002018

A002019

A002020

A002021

A002022

A002023

A002024

A002025

A002026

A002027

A002028

A002029

A002030

A002031

A002032

A002033

申报总价值不能少于2.5USD

申报品中文名称不能大于25位

海关编码错误

海关编码必须为6-10位数字

海关中文品名不能为空,且最少需要两位.

海关申报品长度不能超过50位

客户单号不能为空

客户单号格式不正确

客户单号已经存在

服务商单号格式不正确

服务商单号已经存在

货物类型代码无法识别

货物件数格式不正确

买家id长度不能大于60位

交易id格式不正确

订单备注长度不能大于256位

运输方式不能为空

运输方式代码无法识别

收件人国家不能为空

收件人国家二字码不存在

支付方式无法识别

客户重量格式不正确

发件人名不能为空

发件人姓名不能大于30位

发件人公司名不能为空

发件人公司名不能大于90位

发件人电话不能为空

发件人电话格式不正确

发件人地址不能为空

发件人地址必须大于10位且小于240位

发件人邮编格式不正确

发件人传真格式不正确

收件人名不能为空

DHL收件人名不能大于30位

收件人姓名不能大于60位

收件人公司名不能大于90位

联邮通到澳大利亚的邮编必需为4位数字

新加坡EMS到新加坡的邮编必需为6位数字

联邮通到德国的邮编必需为5位数字

A002034

A002035

A002036

A002037

A002038

A002039

A002040

A002041

A002042

A002043

A002044

A002045

A002046

A002047

A002048

A002049

A002050

A002052

A002053

A002054

A002055

A002056

A002057

A002058

A002059

A002060

A002061

A002062

A002063

A002065

A002066

A002067

A002068

A002069

A002075

A002076

美国的邮编格式不正确

邮编不能为空

邮编格式不正确

收件人地址1(街道)不能为空

收件人地址1(街道)长度不能大于120位

收件人电话不能为空

收件人电话格式不正确

收件人传真格式不正确

收件人邮箱格式不正确

申报品名不能为空

申报品名格式不正确

配货名称不能大于100位

申报单位类型代码无法识别

申报数量格式不正确

申报单价不能为空

申报单价格式不正确

配货备注不能大于256位

运输方式到收件人国家缓存设置存在异常

运输方式不到该国家

保险类型无法识别

保险金额格式不正确

保险类型不为空，但投保金额为空

保险类型为空，但投保金额不为空

运输方式不能购买该类型保险

保险错误

收件人地址3(州)不能为空

收件人地址2(城市)不能为空

州不存在

该州不存在该城市

该运输方式不支持退件

退件标识无法识别

非DHL发件人名长度不能大于60位

非DHL发件人电话长度不能大于30位

非DHL发件人地址长度不能大于180位

收件人地址2(城市)长度不能大于60位

收件人地址3(州)长度不能大于60位

A002078

A002081

A002082

A002083

A002084

A002085

A002087

A002088

A002089

A002091

A002093

A002094

A002095

A002096

A002097

A002098

A002099

A002100

A002101

A002102

A002103

A002104

A002105

A002106

A002107

A002108

A002109

A002111

A002112

A002113

A002114

A002115

Fedex收件人街道、城市和州的总长度不能大于70位

邮政小包渠道到俄罗斯不支持购买我司5元及8元的保价服务

亚马逊FBA头程配送单号不能大于18位

亚马逊FBA头程配送单号必需以FBA开头

州不存在,请确认州字段是否是州简码

联邮通挂号和联邮通空邮包裹联系地址的第二个或第三个单词

必须为门牌号

内容类型编码不能为空

内容类型编码无法识别

收件人信息输入格式不正确

发件人城市格式不正确

发件人省格式不正确

收件人电话不允许为空

收件人电话格式不正确

收件人邮编不能为空

收件人邮编格式不正确

收件人邮编无法识别

收件人名长度不能大于45

发件人名长度不能大于45

收件人省长度不能大于120

发件人省长度不能大于45

收件人城市长度不能大于120

发件人城市长度不能大于45

收件人地址长度不能大于120

发件人地址长度不能大于90

发件人电话格式错误

申报品名长度不能大于50

目的地国家不允许购买保险

产品到此国家或邮编无服务

输入格式不正确

发件人名格式不正确

输入格式不正确

以色列邮编正确格式为5位或7位数字

本文标签： 类型代码收件人

版权声明：本文标题：4PX API接口参数说明文档(2016年7月13日) 内容由热心网友自发贡献，该文观点仅代表作者本人， 转载请联系作者并注明出处：https://m.elefans.com/dongtai/1718782165a724370.html， 本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容，一经查实，本站将立刻删除。