页面树结构
转至元数据结尾
转至元数据起始

正在查看旧版本。 查看 当前版本.

与当前比较 查看页面历史

« 前一个 版本 22 下一个 »

Table of Contents

接口说明

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

请注意以下几点:

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

路径

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


请求字段

Field (API)Data Type

Length

MandatoryDetails
orderID
String80MTracking No跟踪号/Ref No客户端的订单唯一标识
description
String60O英文品名
nativeDescription
String255O中文品名
weight
Double O重量(>=0.000001)
weightUnit
String3O重量单位,枚举值:G, KG,LB
默认值:KG
length
Double O
width
Double O
height
Double O
dimensionUnit
String3O

长度单位,枚举值:M, CM
默认值:CM

只针对长宽高,与体积无关

invoiceValue
Double O货值(>=0.01),与sum(itemCount * unitValue)的误差不能超过0.1
invoiceCurrency
String3O币种,ISO货币代码
recipientName
String50O

收件人名称



限制英语/法语字符/非纯数字
自动去除特殊字符

recipientCompany
String50O收件人公司名
phone
String20O电话
email
String50O邮箱
address




addressLine1String200O地址第一行

限制英语/法语字符/非纯数字
自动去除特殊字符

addressLine2String200O地址第二行

addressLine3String80O地址第三行

cityString80O城市

stateString80O

限制英语/法语字符/非纯数字
自动去除特殊字符

postcodeString16O邮编

countryString2O国家二字代码
shipperName
String50O发件人名称

限制英语/法语字符/非纯数字
自动去除特殊字符
shipperPhone
String20O电话
shipperAddress




shipperAddressLine1String200O地址第一行

shipperAddressLine2String200O地址第二行(如标黄字段未更新,则单独更新此字段不生效)

shipperAddressLine3String80O地址第三行(如标黄字段未更新,则单独更新此字段不生效)

shipperCityString80O城市

shipperStateString80O

shipperPostcodeString16O邮编

shipperCountryString2O国家二字代码
shipperEmail
String80O客户邮箱(如标黄字段未更新,则单独更新此字段不生效)
returnOption
String100O退件选项(如标蓝字段未更新,则单独更新此字段不生效)
returnName
String50O退件接收人名称
returnAddress




returnAddressLine1String200O地址第一行

returnAddressLine2String200O地址第二行(如标蓝字段未更新,则单独更新此字段不生效)

returnAddressLine3String80O地址第三行(如标蓝字段未更新,则单独更新此字段不生效)

returnCityString80O城市

returnStateString80O

returnPostcodeString16O邮编

returnCountryString2O国家二字代码
returnPhone
String50O退货电话
ItemsList OItem信息
 skuString128OSKU
 descriptionString60O英文品名
如果值为空,设置成订单级别的description
1. 不能包含设置的违禁品关键词
2. 必须是英文和法文字符或数字
 nativeDescriptionString255O中文品名
 hsCodeString60OHS Code
 originCountryString60O国家二字代码,三字代码或名称
 itemCountInteger O件数,>0
 unitValueDouble O单价,>0
 weightDouble OItem重量,转换成KG


请求内容

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
        }
    ]
}
  • 无标签