12. 更新订单接口

Table of Contents

Table of Contents

接口说明

路径

请求字段

请求内容

响应内容

响应报文

部分成功样例

失败样例

接口说明

本接口用于通过参考号或者跟踪号更新部分订单信息，具体服务是否支持此接口请联系eTower了解。

请注意以下几点：

字符串类型字段只有在填写了对应的值才会更新对应字段。空值不会把该字段置空
数字类型字段在不为空和不为0时才会修改对应字段的值
如果更新Receipt相关信息，则以下标绿字段字段需要全量更新，不支持单独更新其中某一个，eTower会使用此接口报文里面的地址信息替换原订单里面的地址信息。
如果更新Shipper相关信息，则以下标黄字段字段需要全量更新，不支持单独更新其中某一个，eTower会使用此接口报文里面的地址信息替换原订单里面的地址信息。
如果更新Return相关信息，则以下标蓝字段字段需要全量更新，不支持单独更新其中某一个，eTower会使用此接口报文里面的地址信息替换原订单里面的地址信息。
更新item信息，通过sku匹配，如果sku匹配不到或者匹配到多条都会报错
更新订单重量和币值在不更新item重量和币值信息的前提下会将订单重量或者币值按照原item所占总数的比重进行拆分。
客户使用参考号（Ref No.）或者跟踪号（Tracking No.），最多获取30条记录；
发送获取清单/ 大包交接之后，订单信息无法更改

路径

HTTP Verb	URL
Post	/services/shipper/update-order

请求字段

Field (API)		Data Type	Length	Mandatory	Details
orderId		String	80	M	Tracking No跟踪号/Ref No客户端的订单唯一标识
description		String	60	O	英文品名
nativeDescription		String	255	O	中文品名
weight		Double		O	重量(>=0.000001)
weightUnit		String	3	O	重量单位，枚举值：G, KG,LB 默认值：KG
length		Double		O	长
width		Double		O	宽
height		Double		O	高
dimensionUnit		String	3	O	长度单位，枚举值：M, CM 默认值：CM 只针对长宽高，与体积无关
invoiceValue		Double		O	货值(>=0.01)，与sum(itemCount * unitValue)的误差不能超过0.1
invoiceCurrency		String	3	O	币种，ISO货币代码
recipientName		String	50	O	收件人名称限制英语/法语字符/非纯数字自动去除特殊字符
recipientCompany		String	50	O	收件人公司名
phone		String	20	O	电话
email		String	50	O	邮箱
address
	addressLine1	String	200	O	地址第一行限制英语/法语字符/非纯数字自动去除特殊字符
	addressLine2	String	200	O	地址第二行
	addressLine3	String	80	O	地址第三行
	city	String	80	O	城市
	state	String	80	O	省限制英语/法语字符/非纯数字自动去除特殊字符
	postcode	String	16	O	邮编
	country	String	2	O	国家二字代码
shipperName		String	50	O	发件人名称限制英语/法语字符/非纯数字自动去除特殊字符
shipperPhone		String	20	O	电话
shipperAddress
	addressLine1	String	200	O	地址第一行
	addressLine2	String	200	O	地址第二行（如标黄字段未更新，则单独更新此字段不生效）
	addressLine3	String	80	O	地址第三行（如标黄字段未更新，则单独更新此字段不生效）
	city	String	80	O	城市
	state	String	80	O	省
	postcode	String	16	O	邮编
	country	String	2	O	国家二字代码
shipperEmail		String	80	O	客户邮箱（如标黄字段未更新，则单独更新此字段不生效）
returnOption		String	100	O	退件选项（如标蓝字段未更新，则单独更新此字段不生效）
returnName		String	50	O	退件接收人名称
returnAddress
	addressLine1	String	200	O	地址第一行
	addressLine2	String	200	O	地址第二行（如标蓝字段未更新，则单独更新此字段不生效）
	addressLine3	String	80	O	地址第三行（如标蓝字段未更新，则单独更新此字段不生效）
	city	String	80	O	城市
	state	String	80	O	省
	postcode	String	16	O	邮编
	country	String	2	O	国家二字代码
returnPhone		String	50	O	退货电话
items		List		O	Item信息
	sku	String	128	O	SKU
	description	String	60	O	英文品名如果值为空，设置成订单级别的description 1. 不能包含设置的违禁品关键词 2. 必须是英文和法文字符或数字
	nativeDescription	String	255	O	中文品名
	hsCode	String	60	O	HS Code
	originCountry	String	60	O	国家二字代码，三字代码或名称
	itemCount	Integer		O	件数，>0
	unitValue	Double		O	单价，>0
	weight	Double		O	Item重量，转换成KG
	itemExportInvoice Value	String	255	O	物品出口申报金额
	itemExportInvoice Currency	String	255	O	物品出口申报币种
extendData		Object		O	扩展字段，仅展示部分，具体字段根据服务要求有所不同
	vendorid	String	12	O	发件人税号
	gstexemptionCode	Sting	4	O	GST免税码，如果vendorid正确，该字段值自动设置为“PAID”
	senderTaxId	String	255	O	发货人税号
	injectPort	String	255	O	订单配送港口
	originPort	String	255	O	订单起始港口
	postage	Decimal (12, 2)	255	O	运费
	icms	Decimal (12, 2)	255	O	巴西icms 费用
	vat	Decimal (12, 2)	255	O	税号
	agentID	String	10	O	parcelShopID
	coverAmount	Double		O	保费金额，针对于特定服务的额外投保业务
	shipperCompanyName	String	255	O	发件人公司名
	shipperOrganizationCode	String	255	O	发件人企业统一社会信用代码
	exportInvoiceValue	String	255	O	出口申报金额
	exportInvoiceCurrency	String	255	O	出口申报币种

请求内容

Request

[{
	"address": {
		"country": "CA",
		"city": "Belle River",
		"postcode": "N0R 1A0",
		"addressLine1": "address line 1",
		"addressLine2": "",
		"addressLine3": "",
		"state": "ON"
	},
	"nativeDescription": "",
	"orderId": "Test001",
	"dimensionUnit": "",
	"length": 0,
	"description": "",
	"weight": 0,
	"invoiceValue": 0,
	"invoiceCurrency": "",
	"recipientCompany": "",
	"returnAddress": {
		"addressLine1": "",
		"addressLine2": "",
		"addressLine3": "",
		"city": "",
		"country": "",
		"postcode": "",
		"state": ""
	},
	"returnName": "",
	"returnOption": "",
	"returnPhone": "",
	"shipperAddress": {
		"addressLine1": "",
		"addressLine2": "",
		"addressLine3": "",
		"city": "",
		"country": "",
		"postcode": "",
		"state": ""
	},
	"shipperEmail": "",
	"shipperName": "",
	"shipperPhone": "",
	"phone": "",
	"width": 0,
	"recipientName": "",
	"items": [{
		"hsCode": "",
		"nativeDescription": "",
		"originCountry": "",
		"description": "",
		"weight": 0,
		"sku": "sku",
		"itemCount": 0,
		"unitValue": 0
	}],
	"email": "",
	"height": 0,
	"weightUnit": ""
}]

响应内容

服务端返回与请求相对应的跟踪号，包括

1）是否查询成功(status)；

2）出错代码(errors)；

3）请求id(orderId)；

4）客户单号(referenceNo)；

5）跟踪号(trackingNo)；

响应报文

Response

{
    "status": "Success",
    "errors": null,
    "data": [
        {
            "status": "Success",
            "errors": null,
            "orderId": "JDQ002444601000931506",
            "referenceNo": "Marco-20200806113127",
            "trackingNo": "JDQ002444601000931506",
            "connoteId": null
        },
        {
            "status": "Success",
            "errors": null,
            "orderId": "JDQ002444701000931503",
            "referenceNo": "Marco-20200806113130",
            "trackingNo": "JDQ002444701000931503",
            "connoteId": null
        }
    ]
}

部分成功样例

Response

{
    "status": "Partial Success",
    "errors": [
        {
            "code": 100009,
            "message": "Order JDQ00244470100093150113 not found"
        }
    ],
    "data": [
        {
            "status": "Success",
            "errors": null,
            "orderId": "JDQ002444601000931506",
            "referenceNo": "Marco-20200806113127",
            "trackingNo": "JDQ002444601000931506",
            "connoteId": null
        },
        {
            "status": "Failure",
            "errors": [
                {
                    "code": 100009,
                    "message": "Order JDQ00244470100093150113 not found"
                }
            ],
            "orderId": "JDQ00244470100093150113",
            "referenceNo": null,
            "trackingNo": null,
            "connoteId": null
        }
    ]
}

失败样例

Response

{
    "status": "Failure",
    "errors": [
        {
            "code": 100009,
            "message": "Order JDQ00244470100093150113 not found"
        },
        {
            "code": 100009,
            "message": "Order JDQ00244460100093150611 not found"
        }
    ],
    "data": [
        {
            "status": "Failure",
            "errors": [
                {
                    "code": 100009,
                    "message": "Order JDQ00244460100093150611 not found"
                }
            ],
            "orderId": "JDQ00244460100093150611",
            "referenceNo": null,
            "trackingNo": null,
            "connoteId": null
        },
        {
            "status": "Failure",
            "errors": [
                {
                    "code": 100009,
                    "message": "Order JDQ00244470100093150113 not found"
                }
            ],
            "orderId": "JDQ00244470100093150113",
            "referenceNo": null,
            "trackingNo": null,
            "connoteId": null
        }
    ]
}

页面树结构

12. 更新订单接口

接口说明

路径

请求字段

请求内容

响应内容

响应报文

部分成功样例

失败样例