eTowerOne Developers
页面树结构

版本比较

旧版本 87

changes.mady.by.user 许杰力

保存于

比较

新版本 当前版本

changes.mady.by.user 戴书贤

保存于

标识

  • 该行被添加。
  • 该行被删除。
  • 格式已经改变。

invoiceCurrencyCode

接口说明

创建直邮小包订单

路径

...

HTTP Verb 

...

URL

...

qa: https://cfs-qa.etowertech.com/api/supplier-service/

/v1/openApi/packetOrder/b2c/createOrders

请求头样例

...

POST /v1/openApi/packetOrder/b2c/createOrders HTTP/1.1

Host: http://cfs-qa.etowertech.com/
Content-Type: application/json
Accept: application/json
Authorization:WallTech etotest8xkIIphLnbkjRACNj4P:pc9H97D-_b2_TSCVvNj81A
X-WallTech-Date:Tue, 02 Aug 2022 06:43:37 GMT

请求字段（request）

...

referenceNo

...

枚举：请按照页面底部附件“平台名称”要求填写

...

isInsurance

...

isSignature

...

默认为true

true则无需再调用8.预报出库单接口，会自动进行预报

false则需要再调用8.预报出库单接口，否则订单只是草稿订单

...

orderType=Fulfillment相关参数

...

orderType=Fulfillment ：必填；

...

orderType=Fulfillment ：必填；

...

orderType=Fulfillment ：必填；

...

orderType=Fulfillment ：必填；

...

orderType=B2C

才可以填写shipper 对象，且非必填

...

orderType=B2C

才可以填写shipper 对象，且非必填

...

orderType=B2C

才可以填写shipper 对象，且非必填

...

orderType=B2C

才可以填写shipper 对象，且非必填

...

orderType=B2C

才可以填写shipper 对象，且非必填

...

orderType=B2C

才可以填写shipper 对象，且非必填

...

orderType=B2C

才可以填写shipper 对象，且非必填

...

orderType=B2C

才可以填写shipper 对象，且非必填

...

orderType=B2C

才可以填写shipper 对象，且非必填

...

orderType=B2C

才可以填写shipper 对象，且非必填

...

orderType=B2C

才可以填写shipper 对象，且非必填

...

orderType=B2C

才可以填写shipper 对象，且非必填

...

orderType=B2C

才可以填写shipper 对象，且非必填

...

orderType=B2C

才可以填写shipper 对象，且非必填

...

orderType=B2C

才可以填写shipper 对象，且非必填

...

returnAddress

...

orderType=B2C

才可以填写returnAddress对象，且非必填

...

returnAddress

...

orderType=B2C

才可以填写returnAddress对象，且非必填

...

returnAddress

...

orderType=B2C

才可以填写returnAddress对象，且非必填

...

returnAddress

...

orderType=B2C

才可以填写returnAddress对象，且非必填

...

returnAddress

...

orderType=B2C

才可以填写returnAddress对象，且非必填

...

returnAddress

...

orderType=B2C

才可以填写returnAddress对象，且非必填

...

returnAddress

...

orderType=B2C

才可以填写returnAddress对象，且非必填

...

returnAddress

...

orderType=B2C

才可以填写returnAddress对象，且非必填

...

returnAddress

...

orderType=B2C

才可以填写returnAddress对象，且非必填

...

returnAddress

...

orderType=B2C

才可以填写returnAddress对象，且非必填

...

returnAddress

...

orderType=B2C

才可以填写returnAddress对象，且非必填

...

returnAddress

...

orderType=B2C

才可以填写returnAddress对象，且非必填

...

returnAddress

...

orderType=B2C

才可以填写returnAddress对象，且非必填

...

returnAddress

...

orderType=B2C

才可以填写returnAddress对象，且非必填

...

orderType=Fulfillment ：不必填；

...

orderType=Fulfillment ：不必填；

...

orderType=Fulfillment ：不必填；

orderType=B2C ：必填；

...

枚举：

0: url

1:base64

...

拓展字段

...

拓展字段key-value

key：keepShipService
value：boolean

...

orderType=Fulfillment ：可用；

...

attachments

...

1.如有附件则三个字段都必填，如无附件，则三个字段都不必填；

2.最多5个附件；

...

attachments

...

1.如有附件则三个字段都必填，如无附件，则三个字段都不必填；

2.最多5个附件；

...

attachments

...

1.如有附件则三个字段都必填，如无附件，则三个字段都不必填；

2.最多5个附件；

...

attachments

...

 1：Label

不填或其他值：Other

...

1.如有附件则三个字段都必填，如无附件，则三个字段都不必填；

2.最多5个附件；

...

material

...

collection

...

collection

...

collection

...

collection

...

collection

...

collection

...

collection

...

collection

...

collection

...

collection

...

collection

...

collection

...

collection

...

collection

...

请求样例

1、"ordertype":"Fulfillment"

代码块
[
    {
        "facility": "ALT4300",
        "channelCode": "ZYMD-SKU-UPS",
        "channelOption": "",
        "referenceNo": "NX_{{$timestamp}}",
        "orderType": "Fulfillment",
        "originPortCode": "",
        "injectPortCode": "",
        "platform": "eBay",
        "incoterm": "",
        "collectionType": null,
        "isInsurance": "",
        "isSignature": "",
        "remark": "testremark1234567890",
        "isoffLineorder": "true",
        "isNeedConfirm": false,
        "extendData": {
            "extend": null
        },
        "consignee": {
            "addressCode": "AU POST",
            "addressLine1": " address1 ",
            "addressLine2": " address2 ",
            "addressLine3": " address3 ",
            "city": " city ",
            "company": " testcompany 测试 ",
            "countryCode": "AU",
            "district": " district",
            "email": " 123456789@12.cn ",
            "extendData": null,
            "name": " 迈克尔 杰克逊 ",
            "phone": " 1551234 56781234 ",
            "state": " state ",
            "taxId": " testtaxid ",
            "taxId1": "testtaxid1",
            "zipCode": " 8238 juej "
        },
        "shipper": {
            "addressLine1": "",
            "addressLine2": "",
            "addressLine3": "",
            "city": "",
            "company": "",
            "countryCode": "",
            "district": "",
            "email": "",
            "extendData": null,
            "name": "",
            "phone": "",
            "state": "",
            "taxId": "",
            "taxId1": "",
            "zipCode": ""
        },
        "returnAddress": {
            "addressLine1": "",
            "addressLine2": "",
            "addressLine3": "",
            "city": "",
            "company": "",
            "countryCode": "",
            "district": "",
            "email": "",
            "extendData": null,
            "name": "",
            "phone": "",
            "returnOption": "",
            "state": "",
            "zipCode": ""
        },
        "parcels": [
            {
                "referenceNo": "123",
                "referenceNo1": "",
                "referenceNo2": "",
                "consignmentId": "",
                "trackingNo": "{{$timestamp}}",
                "label": "http:\/\/erp-huanan.oss-cn-shenzhen.aliyuncs.com\/html2pdf\/ec\/pdf\/2023\/04\/10\/8ed24f790c86a1b950ab89d6fd473c4d.pdf",
                "labelName":"testfile.pdf",
                "labelType": "0",
                "descriptionEn": "",
                "description": "",
                "dangerousGoods": false,
                "batteryType": "false",
                "weight": null,
                "weightUnit": null,
                "length": "",
                "width": "",
                "height": "",
                "dimensionUnit": null,
                "invoiceCurrencyCode": null,
                "invoiceValue": "12",
                "transactionCurrency": "usd",
                "transactionAmount": "5.12",
                "shippingInstruction": "",
                "sortCode": "",
                "attachments":[
                    {
                        "attachName": "1234567890",
                        "attachData": "JVBERi0xLjQKJeLjz9MKMiAwIG9iago8PC9GaWx0ZXIvRmxhdGVEZWNvZGUvTGVuZ3RoIDQ4Pj5zdHJlYW0KeJwr5HIK4TI2UzCxVAhJ4XIN4QrkKlQwVDAAQgiZnKugH5FmqOCSrxDIBQDhfAnBCmVuZHN0cmVhbQplbmRvYmoKNCAwIG9iago8PC9Db250ZW50cyAyIDAgUi9UeXBlL1BhZ2UvUmVzb3VyY2VzPDwvUHJvY1NldCBbL1BERiAvVGV4dCAvSW1hZ2VCIC9JbWFnZUMgL0ltYWdlSV0vWE9iamVjdDw8L1hmMSAxIDAgUj4+Pj4vUGFyZW50IDMgMCBSL01lZGlhQm94WzAgMCAxNDIgODVdPj4KZW5kb2JqCjEgMCBvYmoKPDwvU3VidHlwZS9Gb3JtL0ZpbHRlci9GbGF0ZURlY29kZS9UeXBlL1hPYmplY3QvTWF0cml4WzEgMCAwIDEgMCAwXS9Gb3JtVHlwZSAxL1Jlc291cmNlczw8L1Byb2NTZXRbL1BERi9UZXh0L0ltYWdlQi9JbWFnZUMvSW1hZ2VJXS9Gb250PDwvRjEgNSAwIFI+Pi9YT2JqZWN0PDwvWGYxIDYgMCBSPj4+Pi9MZW5ndGggMTgzL0JCb3hbMCAwIDE0MiA4NV0+PnN0cmVhbQp4nHWOSwvCMBCE95xfMUc9mGbz6OMqVsGLFHPwrrYgVKn6/3FTFIoow+4OyebLDGoZlUEZEE8yF1z45OqoGjWMZbGVi03yMLqojPMwSW/PrG1AcNpYHHtkh5axuqFJYB43GT7XAd4h9ipbM+SzVo0M3Ds1o5oi7YjJikpy0h0ZquSEZSZZqf08XuRVl8JN2LnVhuH4Ay+/4E8602Ps19+AYHWw4PwfgCmXLF6U0rFk4wnoBcqeOrAKZW5kc3RyZWFtCmVuZG9iago1IDAgb2JqCjw8L1N1YnR5cGUvVHlwZTAvVHlwZS9Gb250L0Jhc2VGb250L1NUU29uZy1MaWdodC1VbmlHQi1VQ1MyLUgvRW5jb2RpbmcvVW5pR0ItVUNTMi1IL0Rlc2NlbmRhbnRGb250c1s3IDAgUl0+PgplbmRvYmoKNiAwIG9iago8PC9TdWJ0eXBlL0Zvcm0vRmlsdGVyL0ZsYXRlRGVjb2RlL1R5cGUvWE9iamVjdC9NYXRyaXhbMSAwIDAgMSAwIDBdL0Zvcm1UeXBlIDEvUmVzb3VyY2VzPDwvUHJvY1NldFsvUERGL1RleHQvSW1hZ2VCL0ltYWdlQy9JbWFnZUldPj4vQkJveFswIDAgMTUxLjIgMjRdL0xlbmd0aCAyMDY+PnN0cmVhbQp4nI1SwRHDIAz7dwomyFnGOHigdoDu/ygh3BHEp7/IWJLlWJIkHJ7U0vf90sMalqMObO3riSth6EKHER9ne1sM2mu6XAZkA3VS0OgKk5K1U6ZkLoculOy9Y1LsMs2ta0DKWGhGq8QvygWnGUrQDA4SdXbxVeGUHvxR4JznnfNRuE1nsJqpo7JpXSUDNHbwDwxOGkEeEKXJIWwL2Q4Ht/XcKfbjgS/xQMcD5bzQQtcC3ZyzEs487XZAMKE1wGzrIR8L1i1j3X/iz+sHuNm11gplbmRzdHJlYW0KZW5kb2JqCjcgMCBvYmoKPDwvRFcgMTAwMC9TdWJ0eXBlL0NJREZvbnRUeXBlMC9DSURTeXN0ZW1JbmZvPDwvU3VwcGxlbWVudCA0L1JlZ2lzdHJ5KEFkb2JlKS9PcmRlcmluZyhHQjEpPj4vVHlwZS9Gb250L0Jhc2VGb250L1NUU29uZy1MaWdodC9Gb250RGVzY3JpcHRvciA4IDAgUi9XWzE3IDIxIDQ2MiAyM1s0NjJdIDI1IDI2IDQ2MiAzOFs1NjNdIDQ4Wzc3Ml0gNTJbNDY1IDYwN10gNzBbNDE1XSA3OVs1MjddIDg0WzMzNiAyNzddXT4+CmVuZG9iago4IDAgb2JqCjw8L0Rlc2NlbnQgLTEyMC9DYXBIZWlnaHQgODgwL1N0ZW1WIDkzL1R5cGUvRm9udERlc2NyaXB0b3IvRmxhZ3MgNi9TdHlsZTw8L1Bhbm9zZSgBBQICBAAAAAAAAAApPj4vRm9udEJCb3hbLTI1IC0yNTQgMTAwMCA4ODBdL0ZvbnROYW1lL1NUU29uZy1MaWdodC9JdGFsaWNBbmdsZSAwL0FzY2VudCA4ODA+PgplbmRvYmoKMyAwIG9iago8PC9LaWRzWzQgMCBSXS9UeXBlL1BhZ2VzL0NvdW50IDEvSVRYVCgyLjEuNyk+PgplbmRvYmoKOSAwIG9iago8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMyAwIFI+PgplbmRvYmoKMTAgMCBvYmoKPDwvTW9kRGF0ZShEOjIwMjMwOTExMTkxNTQyKzA4JzAwJykvQ3JlYXRpb25EYXRlKEQ6MjAyMzA5MTExOTE1NDIrMDgnMDAnKS9Qcm9kdWNlcihpVGV4dCAyLjEuNyBieSAxVDNYVCk+PgplbmRvYmoKeHJlZgowIDExCjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDI4OSAwMDAwMCBuIAowMDAwMDAwMDE1IDAwMDAwIG4gCjAwMDAwMDE2NzQgMDAwMDAgbiAKMDAwMDAwMDEyOSAwMDAwMCBuIAowMDAwMDAwNzA3IDAwMDAwIG4gCjAwMDAwMDA4MzEgMDAwMDAgbiAKMDAwMDAwMTIzNCAwMDAwMCBuIAowMDAwMDAxNDg0IDAwMDAwIG4gCjAwMDAwMDE3MzcgMDAwMDAgbiAKMDAwMDAwMTc4MiAwMDAwMCBuIAp0cmFpbGVyCjw8L0luZm8gMTAgMCBSL0lEIFs8MTM5ZmM3ZTE3NTY3OWQ3MDI5YmMyYWVjNjZjYjdiMTQ+PGNmYzI3MjZjZjgzMGExYzhhYjYxNDcyMDE1ZjdkZGNmPl0vUm9vdCA5IDAgUi9TaXplIDExPj4Kc3RhcnR4cmVmCjE5MDUKJSVFT0YK",
                        "attachType": "pdf"
                    }
                ],
                "extendData": {
                    "keepShipService": false
                },
                "items": [
                    {
                        "extendData": null,
                        "hsCode": "",
                        "itemDesc": "",
                        "itemDescEn": "",
                        "itemNumber": "",
                        "matertial": "",
                        "originCountryCode": "",
                        "picture": "",
                        "quantity": "2",
                        "quantityUnit": "",
                        "salesURL": "",
                        "sku": "testals001",
                        "unitPrice": "",
                        "usage": "",
                        "weight": null
                    }
                ],
                "insurance": [
                    {
                        "insuranceAmount": null,
                        "insuranceCurrencyCode": null,
                        "insuranceType": null,
                        "beneficiaryType": null,
                        "beneficiary": null,
                        "beneficiaryId": null,
                        "extendData": null
                    }
                ]
            }
        ],
        "collectionInfo": {
            "date": "",
            "addressLine1": "",
            "addressLine2": "",
            "addressLine3": "",
            "city": "",
            "company": "",
            "countryCode": "",
            "district": "",
            "email": "",
            "extendData": null,
            "name": "",
            "phone": "",
            "state": "",
            "zipCode": ""
        }
    }
]

2、"ordertype":"B2C"

代码块
[
    {
        "facility": "B2C321",
        "channelCode": "UBI.CN2US.AC.GENERAL.LIGHT",
        "channelOption": "B2Cchanneloption",
        "referenceNo": "XB03094",
        "orderType": "B2C",
        "originPortCode": "",
        "injectPortCode": "",
        "platform": "eBay",
        "incoterm": "DDP",
        "collectionType": "Drop off",
        "isInsurance": false,
        "isSignature": false,
        "remark": "testremark",
        "extendData": {
            "extend": null
        },
        "consignee": {
            "addressCode": null,
            "addressLine1": "testaddressline1",
            "addressLine2": "8349hao",
            "addressLine3": "345shi",
            "city": "testcity",
            "company": "testcompany",
            "countryCode": "us",
            "district": "testdistrict",
            "email": "testemail@123.com",
            "extendData": null,
            "name": "testconsigneename",
            "phone": "36247938384",
            "state": "teststate",
            "taxId": "testtaxid",
            "taxId1": "testtaxid1",
            "zipCode": "8238juej"
        },
        "shipper": {
            "addressLine1": "",
            "addressLine2": "",
            "addressLine3": "",
            "city": "",
            "company": "",
            "countryCode": "us",
            "district": "",
            "email": "",
            "extendData": null,
            "name": "",
            "phone": "",
            "state": "",
            "taxId": "",
            "taxId1": "",
            "zipCode": ""
        },
        "returnAddress": {
            "addressLine1": "",
            "addressLine2": "",
            "addressLine3": "",
            "city": "",
            "company": "",
            "countryCode": "",
            "district": "",
            "email": "",
            "extendData": null,
            "name": "",
            "phone": "",
            "returnOption": "",
            "state": "",
            "zipCode": ""
        },
        "parcels": [
            {
                "referenceNo": "PARCEL0323002",
                "referenceNo1": "",
                "referenceNo2": "",
                "consignmentId": "",
                "trackingNo": "",
                "descriptionEn": "descriptionen",
                "description": "description",
                "dangerousGoods": true,
                "batteryType": true,
                "weight": 1.245,
                "weightUnit": null,
                "length": "25",
                "width": "26",
                "height": "27",
                "dimensionUnit": null,
                "invoiceCurrencyCode": "USD",
                "invoiceValue": 12.5,
                "transactionCurrency": null,
                "transactionAmount": null,
                "shippingInstruction": "",
                "sortCode": "",
                "extendData": {
                    "keepShipService": false
                },
                "items": [
                    {
                        "extendData": null,
                        "hsCode": "111",
                        "itemDesc": "desc",
                        "itemDescEn": "descen",
                        "itemNumber": "1",
                        "material": "testmaterial",
                        "originCountryCode": "cn",
                        "picture": "",
                        "quantity": "1",
                        "quantityUnit": "个",
                        "salesURL": "testsalesurl",
                        "sku": "QW",
                        "unitPrice": "21",
                        "usage": "testusage",
                        "weight": "12"
                    }
                ],
                "insurance": [
                    {
                        "insuranceAmount": "12",
                        "insuranceCurrencyCode": "usd",
                        "insuranceType": null,
                        "beneficiaryType": null,
                        "beneficiary": null,
                        "beneficiaryId": null,
                        "extendData": null
                    }
                ]
            }
        ],
        "collection": {
            "date": "2023-03-09",
            "addressLine1": "testaddress1",
            "addressLine2": "testaddress2",
            "addressLine3": "testaddress3",
            "city": "testcity",
            "company": "testcompany",
            "countryCode": "us",
            "district": "testdistrict",
            "email": "testemail@123.com",
            "extendData": null,
            "name": "testname",
            "phone": "phone",
            "state": "teststate",
            "zipCode": "123456"
        }
    }
]

返回样例

成功样例

1、"ordertype":"Fulfillment"

代码块
[
    {
        "code": "0",
        "data": {
            "orderNo": "C12283230322000025O",
            "referenceNo": "TestA00001"
        },
        "errors": "",
        "message": "",
        "messageId": "",
        "success": true,
        "warnList": ""
    },
    {
        "code": "0",
        "data": {
            "orderNo": "C12283230322000026O",
            "referenceNo": "TestA00002"
        },
        "errors": "",
        "message": "",
        "messageId": "",
        "success": true,
        "warnList": ""
    }
]

2、"ordertype":"B2C"

代码块
[
{
"code": "0",
"data":
{ "orderNo": "UBI2303230008", "referenceNo": "XB03094" },
"errors": "",
"message": "",
"messageId": "",
"success": true,
"warnList": ""
}
]

失败样例

1、"ordertype":"Fulfillment"

代码块
1、
[{
	"code": "0005",
	"data": {
		"orderNo": "",
		"referenceNo": "test-0022-1"
	},
	"errors": [{
		"code": "600906",
		"message": "warehouseServiceName:qudao1 ,Does not exist in the shipperAddressCode:code0001"
	}],
	"message": "paramter error",
	"messageId": "",
	"success": false
}]

2、
[
    {
        "code": "0005",
        "data": {
            "orderNo": "",
            "referenceNo": "NX_1703583922"
        },
        "errors": [
            {
                "code": "0020",
                "message": "Operation Error: Operation Error: When the file type is a label,the warehouse supports uploading file format: pdf"
            }
        ],
        "message": "paramter error",
        "messageId": "",
        "success": false,
        "warnList": ""
    }
]

2、"ordertype":"B2C"

代码块
[
    {
        "code": "0005",
        "data": "XB03094",
        "errors": [
            {
                "code": "600222",
                "message": "referenceNo:XB03094  field value already exists and cannot be repeated"
            }
        ],
        "message": "paramter error",
        "messageId": "",
        "success": false,
        "warnList": ""
    }
]

ps: test001是 订单唯一编码 ，区分不同订单的不同错误描述。批量操作 成功的不会返回，会直接保存。

附件

isNeedConfirm

invoiceCurrencyCode

接口说明

创建直邮小包订单

路径

HTTP Verb 

URL

Post

qa: https://cfs-qa.etowertech.com/api/supplier-service/

/v1/openApi/packetOrder/b2c/createOrders


请求头样例


POST /v1/openApi/packetOrder/b2c/createOrders HTTP/1.1

Host: http://cfs-qa.etowertech.com/
Content-Type: application/json
Accept: application/json
Authorization:WallTech etotest8xkIIphLnbkjRACNj4P:pc9H97D-_b2_TSCVvNj81A
X-WallTech-Date:Tue, 02 Aug 2022 06:43:37 GMT

请求字段（request）


拓展字段
Table Filter
fixedCols
totalrow
ddSeparator
sparkNameSparkline
hidePaneFiltration Panel
limitHeight
default
cell-width
totalRowName
totalColName
id1678688780671
formatVersion2
order
inverse
numbering
isNewfalse
sort
totalcol
rowsPerPage
separatorPoint (.)
labels
thousandSeparator
ignoreFirstNrows
heightValue
isORAND


一级字段二级字段三级字段类型长度限制中文含义描述是否必填补充描述
businessCode

String
客户业务编码发货人的业务编码O

不传该字段：以鉴权信息为准，鉴权信息识别为哪个发货人，订单就属于哪个发货人；

传了该字段：需要符合鉴权信息的授权范围，当业务编码符合授权范围，则业务编码是哪个发货人，订单就属于哪个发货人

orderType

String
订单类型枚举:
B2C=小包直邮
Fulfillment=仓库一件代发		M
facility

String50发件人网点/仓库代码B2C：发货人网点
Fulfillment：仓库代码		M

referenceNo



String50订单唯一编码区分不同订单用M
originPortCode

String
始发港（空港/海港）英文代码O
injectPortCode

String50目的港英文代码O
channelCode

String64渠道名称英文、英文标点M

orderType=Fulfillment

使用查询仓库服务列表接口中返回的serviceType=5且active=1的serviceName下单

传递的是系统界面上的服务名称而非服务代码

channelOption

String64渠道选项英文、英文标点O
platform
Short


String20平台

枚举：请按照页面底部附件“平台名称”要求填写

O
incoterm

String50贸易术语枚举：DDU、DDPO
collectionType 


20揽收类型枚举
Pick up上门揽收
Drop off自送到仓
不填默认Drop off		O

isInsurance



Boolean5是否投保boolean 不填默认falseO

isSignature



Boolean5是否签名boolean 不填默认falseO
remark


200备注
O
isOffLineOrder

Boolean
是否线下订单boolean 不填默认falseO

orderType=Fulfillment相关参数

true：下单时需要传入面单信息，字段：labelType、label、labelName

false：下单时不需要传入面单信息

isNeedConfirm

Boolean
是否自动确认发送

默认为true

true则无需再调用8.预报出库单接口，会自动进行预报

false则需要再调用8.预报出库单接口，否则订单只是草稿订单


orderType=Fulfillment相关参数

true：订单自动确认，确认后订单信息无法修改

false：订单创建为草稿，订单信息可修改；则需要再调用“8.预报出库单”进行确认

extendData



拓展字段比如IOSS
key-value形式



purchaseOrderNo



String
采购订单号
O

orderType=Fulfillment ：相关参数

当前只有部分客户（19579）支持该字段，如果需要新增，请联系管理员。

consigneeaddressCode
String50收件人地址代码比如ONT8表示某个亚马逊仓库

orderType=B2C 相关参数

name
String50收件人姓名
M

orderType=Fulfillment ：必填；

orderType=B2C ：必填；
company
String512收件人公司


phone
String50收件人电话


email
String50收件人邮箱


countryCode
String2目的国二字代码英文代码M

orderType=Fulfillment ：必填；

orderType=B2C ：必填；
state
String80收件人省/州


city
String80收件人城市
M

orderType=Fulfillment ：必填；

orderType=B2C ：必填；
district
String128收件人区


addressLine1
String200收件人地址第一行
M

orderType=Fulfillment ：必填；

orderType=B2C ：必填；
addressLine2
String200收件人地址第二行


addressLine3
String80收件人地址第三行


zipCode
String16收件人邮编


taxId
String255收件人税号


taxId1
String255收件人税号1


extendData


拓展字段


shippername
String50发件人姓名

orderType=B2C

才可以填写shipper 对象，且非必填

company
String512发件人公司

phone
String50发件人电话

email
String50发件人邮箱

countryCode
String2始发国二字代码英文代码
state
String80发件人省/州

city
String80发件人城市

district
String128发件人区

addressLine1
String200发件人地址第一行

addressLine2
String200发件人地址第二行

addressLine3
String80发件人地址第三行

zipCode
String16发件人邮编

taxId
String255发件人税号

taxId1
String255发件人税号1

extendData


拓展字段 key-value

returnAddress

returnOption退件选项String50枚举：退件、销毁

orderType=B2C

才可以填写returnAddress对象，且非必填

name退件人姓名String50


company退件人公司String512


phone退件人电话String50


email退件人邮箱String50


countryCode退件人国家二字代码String2英文代码英文代码
state退件人省/州String80


city退件人城市String80


district退件人区String128


addressLine1退件人地址第一行String200


addressLine2退件人地址第二行String200


addressLine3退件人地址第三行String80


zipCode退件人邮编String16


extendData拓展字段Object



extendData.shippingMethod拓展字段1String255
80
自定义拓展字段
zipCode


extendData.xxx
退件人邮编
拓展字段2String
16extendData
255


parcelsreferenceNo
String80包裹参考号
M
referenceNo1
String80包裹参考号1


referenceNo2
String80包裹参考号2


consignmentId
String50包裹货物ID澳邮要求MLID+ConsignmentID 2年内不得重复使用数字
trackingNoString80包裹跟踪号orderType=Fulfillment  and isoffLineOrder=true 必填


descriptionEn
String255包裹英文描述
M

orderType=Fulfillment ：不必填；

orderType=B2C ：必填；
description
String255包裹中文描述


dangerousGoods
Boolean5包裹是否危险品true=危险品
false=非危险品

batteryType
Boolean5包裹带电类型枚举
true=带电
false=不带电

weight
BigDecimal8,3包裹重量8位，小数点后3位M

orderType=Fulfillment ：不必填；

orderType=B2C ：必填；
weightUnit
String2重量单位枚举：KG(默认)、G、LB

length
BigDecimal8,2包裹长


width
BigDecimal8,2包裹宽


height
BigDecimal8,2包裹高


dimensionUnit
String8尺寸单位枚举：CM（默认）、M

invoiceCurrencyCode
String3发票币种三字代码英文代码

invoiceValue
BigDecimal20,2发票金额
M

orderType=Fulfillment ：不必填；

orderType=B2C ：必填；

transactionCurrency
BigDecimal8,2交易币种电商平台成交币种

transactionAmount
BigDecimal8,2交易金额电商平台成交金额

trackingNo
String80包裹跟踪号

orderType=Fulfillment  且 所选服务是线下服务是时必填

如果订单Label文件数量大于1，从第2个Label开始传入“attachments”参数中，filtType=1表示Lbael

labelType
Short
面单类型

枚举：

0: url

1:base64

C
orderType=Fulfillment  and isoffLineOrder=true 必填
label
String
面单
C
labelName
String
面单名称需要包含文件类型，如: 出库单.pdfC
shippingInstruction
String50装运指示会显示在部分渠道的面单上

sortCode
String50分拣码会显示在部分渠道的面单上

extendData
Object

拓展字段

拓展字段key-value

key：keepShipService
value：boolean


orderType=Fulfillment ：可用；

orderType=B2C ：不用；


String255拓展字段










attachments

attachNameString95附件名称
M

1.如有附件则三个字段都必填，如无附件，则三个字段都不必填；

2.最多5个附件；

attachDataString
附件内容Base64格式M
attachTypeString5附件扩展名仅支持"rar", "zip", "pdf", "doc", "docx", "xls", "xlsx"M
filtTypeInteger
附件类型

 1：Label

不填或其他值：Other

O
itemsitemNumberString128商品编号









itemDescEnString255商品英文描述


itemDescString255商品本地描述


skuString128SKU编码
M
hsCodeString128海关编码


quantityInteger9商品数量
M
quantityUnitString10商品数量单位


unitPricedecimal
8,2

单价


pictureString
图片base64

salesURLString500销售链接


originCountryCodeString10原产国二字代码英文代码

weightBigDecimal
8,3

重量


usageString255用途


material

String255材质


extendData

拓展字段


insurance
（说明：如果isInsurance是true要填）		insuranceTypeString30投保类型可能是用来区分不同的保险第三方平台或者产品

beneficiaryTypeString20受益人类型枚举：
公司=company
个人=individual

beneficiaryString255受益人/公司


beneficiaryIdString20身份证/组织机构代码证


insuranceCurrencyCodeString3投保三字代码币种


insuranceAmountBigDecimal20,3保险金额


extendDataObject
拓展字段


extendData.UPCString255拓展字段1自定义拓展字段

extendData.xxString255拓展字段2自定义拓展字段








collection


date
date
揽收日期年月日
（说明：如果类型是pickup，要填）
name
String50客户姓名

company
String512客户公司

phone
String50客户电话

email
String50客户邮箱

countryCode
String2客户国家二字代码英文代码
state
String80客户省/州

city
String80客户城市

district
String128客户区

addressLine1
String200客户地址第一行

addressLine2
String200客户地址第二行

addressLine3
String80客户地址第三行

zipCode
String16客户邮编

extendData


拓展字段



请求样例

1、"ordertype":"Fulfillment"

代码块
[
    {
    {
        "businessCode":"B0900919",
        "facility": "ALT4300",
        "channelCode": "ZYMD-SKU-UPS",
        "channelOption": "",
        "referenceNo": "NX_{{$timestamp}}",
        "orderType": "Fulfillment",
        "originPortCode": "",
        "injectPortCode": "",
        "platform": "eBay",
        "incoterm": "",
        "collectionType": null,
        "isInsurance": "",
        "isSignature": "",
        "remark": "testremark1234567890",

       "isoffLineorder": "true",
        "isNeedConfirm": false,
        "extendData": {
            "extend": null
        },
		"purchaseOrderNo":"test2026",
        "consignee": {
            "addressCode": "AU POST",
            "addressLine1": " address1 ",
            "addressLine2": " address2 ",
            "addressLine3": " address3 ",
            "city": " city ",
            "company": " testcompany 测试 ",
            "countryCode": "AU",
            "district": " district",
            "email": " 123456789@12.cn ",
            "extendData": null,
            "name": " 迈克尔 杰克逊 ",
            "phone": " 1551234 56781234 ",
            "state": " state ",
            "taxId": " testtaxid ",
            "taxId1": "testtaxid1",
            "zipCode": " 8238 juej "
        },
        "shipper": {
            "addressLine1": "",
            "addressLine2": "",
            "addressLine3": "",
            "city": "",
            "company": "",
            "countryCode": "",
            "district": "",
            "email": "",
            "extendData": null,
            "name": "",
            "phone": "",
            "state": "",
            "taxId": "",
            "taxId1": "",
            "zipCode": ""
        },
        "returnAddress": {
            "addressLine1": "",
            "addressLine2": "",
            "addressLine3": "",
            "city": "",
            "company": "",
            "countryCode": "",
            "district": "",
            "email": "",
            "extendData": null,
            "name": "",
            "phone": "",
            "returnOption": "",
            "state": "",
            "zipCode": ""
        },
        "parcels": [
            {
                "referenceNo": "123",
                "referenceNo1": "",
                "referenceNo2": "",
                "consignmentId": "",
                "trackingNo": "{{$timestamp}}",
                "label": "http:\/\/erp-huanan.oss-cn-shenzhen.aliyuncs.com\/html2pdf\/ec\/pdf\/2023\/04\/10\/8ed24f790c86a1b950ab89d6fd473c4d.pdf",
                "labelName":"testfile.pdf",
                "labelType": "0",
                "descriptionEn": "",
                "description": "",
                "dangerousGoods": false,
                "batteryType": "false",
                "weight": null,
                "weightUnit": null,
                "length": "",
                "width": "",
                "height": "",
                "dimensionUnit": null,
                "invoiceCurrencyCode": null,
                "invoiceValue": "12",
                "transactionCurrency": "usd",
                "transactionAmount": "5.12",
                "shippingInstruction": "",
                "sortCode": "",
                "attachments":[
                    {
                        "attachName": "1234567890",
                        "attachData": "JVBERi0xLjQKJeLjz9MKMiAwIG9iago8PC9GaWx0ZXIvRmxhdGVEZWNvZGUvTGVuZ3RoIDQ4Pj5zdHJlYW0KeJwr5HIK4TI2UzCxVAhJ4XIN4QrkKlQwVDAAQgiZnKugH5FmqOCSrxDIBQDhfAnBCmVuZHN0cmVhbQplbmRvYmoKNCAwIG9iago8PC9Db250ZW50cyAyIDAgUi9UeXBlL1BhZ2UvUmVzb3VyY2VzPDwvUHJvY1NldCBbL1BERiAvVGV4dCAvSW1hZ2VCIC9JbWFnZUMgL0ltYWdlSV0vWE9iamVjdDw8L1hmMSAxIDAgUj4+Pj4vUGFyZW50IDMgMCBSL01lZGlhQm94WzAgMCAxNDIgODVdPj4KZW5kb2JqCjEgMCBvYmoKPDwvU3VidHlwZS9Gb3JtL0ZpbHRlci9GbGF0ZURlY29kZS9UeXBlL1hPYmplY3QvTWF0cml4WzEgMCAwIDEgMCAwXS9Gb3JtVHlwZSAxL1Jlc291cmNlczw8L1Byb2NTZXRbL1BERi9UZXh0L0ltYWdlQi9JbWFnZUMvSW1hZ2VJXS9Gb250PDwvRjEgNSAwIFI+Pi9YT2JqZWN0PDwvWGYxIDYgMCBSPj4+Pi9MZW5ndGggMTgzL0JCb3hbMCAwIDE0MiA4NV0+PnN0cmVhbQp4nHWOSwvCMBCE95xfMUc9mGbz6OMqVsGLFHPwrrYgVKn6/3FTFIoow+4OyebLDGoZlUEZEE8yF1z45OqoGjWMZbGVi03yMLqojPMwSW/PrG1AcNpYHHtkh5axuqFJYB43GT7XAd4h9ipbM+SzVo0M3Ds1o5oi7YjJikpy0h0ZquSEZSZZqf08XuRVl8JN2LnVhuH4Ay+/4E8602Ps19+AYHWw4PwfgCmXLF6U0rFk4wnoBcqeOrAKZW5kc3RyZWFtCmVuZG9iago1IDAgb2JqCjw8L1N1YnR5cGUvVHlwZTAvVHlwZS9Gb250L0Jhc2VGb250L1NUU29uZy1MaWdodC1VbmlHQi1VQ1MyLUgvRW5jb2RpbmcvVW5pR0ItVUNTMi1IL0Rlc2NlbmRhbnRGb250c1s3IDAgUl0+PgplbmRvYmoKNiAwIG9iago8PC9TdWJ0eXBlL0Zvcm0vRmlsdGVyL0ZsYXRlRGVjb2RlL1R5cGUvWE9iamVjdC9NYXRyaXhbMSAwIDAgMSAwIDBdL0Zvcm1UeXBlIDEvUmVzb3VyY2VzPDwvUHJvY1NldFsvUERGL1RleHQvSW1hZ2VCL0ltYWdlQy9JbWFnZUldPj4vQkJveFswIDAgMTUxLjIgMjRdL0xlbmd0aCAyMDY+PnN0cmVhbQp4nI1SwRHDIAz7dwomyFnGOHigdoDu/ygh3BHEp7/IWJLlWJIkHJ7U0vf90sMalqMObO3riSth6EKHER9ne1sM2mu6XAZkA3VS0OgKk5K1U6ZkLoculOy9Y1LsMs2ta0DKWGhGq8QvygWnGUrQDA4SdXbxVeGUHvxR4JznnfNRuE1nsJqpo7JpXSUDNHbwDwxOGkEeEKXJIWwL2Q4Ht/XcKfbjgS/xQMcD5bzQQtcC3ZyzEs487XZAMKE1wGzrIR8L1i1j3X/iz+sHuNm11gplbmRzdHJlYW0KZW5kb2JqCjcgMCBvYmoKPDwvRFcgMTAwMC9TdWJ0eXBlL0NJREZvbnRUeXBlMC9DSURTeXN0ZW1JbmZvPDwvU3VwcGxlbWVudCA0L1JlZ2lzdHJ5KEFkb2JlKS9PcmRlcmluZyhHQjEpPj4vVHlwZS9Gb250L0Jhc2VGb250L1NUU29uZy1MaWdodC9Gb250RGVzY3JpcHRvciA4IDAgUi9XWzE3IDIxIDQ2MiAyM1s0NjJdIDI1IDI2IDQ2MiAzOFs1NjNdIDQ4Wzc3Ml0gNTJbNDY1IDYwN10gNzBbNDE1XSA3OVs1MjddIDg0WzMzNiAyNzddXT4+CmVuZG9iago4IDAgb2JqCjw8L0Rlc2NlbnQgLTEyMC9DYXBIZWlnaHQgODgwL1N0ZW1WIDkzL1R5cGUvRm9udERlc2NyaXB0b3IvRmxhZ3MgNi9TdHlsZTw8L1Bhbm9zZSgBBQICBAAAAAAAAAApPj4vRm9udEJCb3hbLTI1IC0yNTQgMTAwMCA4ODBdL0ZvbnROYW1lL1NUU29uZy1MaWdodC9JdGFsaWNBbmdsZSAwL0FzY2VudCA4ODA+PgplbmRvYmoKMyAwIG9iago8PC9LaWRzWzQgMCBSXS9UeXBlL1BhZ2VzL0NvdW50IDEvSVRYVCgyLjEuNyk+PgplbmRvYmoKOSAwIG9iago8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMyAwIFI+PgplbmRvYmoKMTAgMCBvYmoKPDwvTW9kRGF0ZShEOjIwMjMwOTExMTkxNTQyKzA4JzAwJykvQ3JlYXRpb25EYXRlKEQ6MjAyMzA5MTExOTE1NDIrMDgnMDAnKS9Qcm9kdWNlcihpVGV4dCAyLjEuNyBieSAxVDNYVCk+PgplbmRvYmoKeHJlZgowIDExCjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDI4OSAwMDAwMCBuIAowMDAwMDAwMDE1IDAwMDAwIG4gCjAwMDAwMDE2NzQgMDAwMDAgbiAKMDAwMDAwMDEyOSAwMDAwMCBuIAowMDAwMDAwNzA3IDAwMDAwIG4gCjAwMDAwMDA4MzEgMDAwMDAgbiAKMDAwMDAwMTIzNCAwMDAwMCBuIAowMDAwMDAxNDg0IDAwMDAwIG4gCjAwMDAwMDE3MzcgMDAwMDAgbiAKMDAwMDAwMTc4MiAwMDAwMCBuIAp0cmFpbGVyCjw8L0luZm8gMTAgMCBSL0lEIFs8MTM5ZmM3ZTE3NTY3OWQ3MDI5YmMyYWVjNjZjYjdiMTQ+PGNmYzI3MjZjZjgzMGExYzhhYjYxNDcyMDE1ZjdkZGNmPl0vUm9vdCA5IDAgUi9TaXplIDExPj4Kc3RhcnR4cmVmCjE5MDUKJSVFT0YK",
                        "attachType": "pdf"
                    }
                ],
                "extendData": {
                    "keepShipService": false
                },
                "items": [
                    {
                        "extendData": null,
                        "hsCode": "",
                        "itemDesc": "",
                        "itemDescEn": "",
                        "itemNumber": "",
                        "matertial": "",
                        "originCountryCode": "",
                        "picture": "",
                        "quantity": "2",
                        "quantityUnit": "",
                        "salesURL": "",
                        "sku": "testals001",
                        "unitPrice": "",
                        "usage": "",
                        "weight": null
                    }
                ],
                "insurance": [
                    {
                        "insuranceAmount": null,
                        "insuranceCurrencyCode": null,
                        "insuranceType": null,
                        "beneficiaryType": null,
                        "beneficiary": null,
                        "beneficiaryId": null,
                        "extendData": null
                    }
                ]
            }
        ],
        "collectionInfo": {
            "date": "",
            "addressLine1": "",
            "addressLine2": "",
            "addressLine3": "",
            "city": "",
            "company": "",
            "countryCode": "",
            "district": "",
            "email": "",
            "extendData": null,
            "name": "",
            "phone": "",
            "state": "",
            "zipCode": ""
        }
    }
]

2、"ordertype":"B2C"


代码块
[
    {
		"businessCode":"B0900919",
        "facility": "B2C321",
        "channelCode": "UBI.CN2US.AC.GENERAL.LIGHT",
        "channelOption": "B2Cchanneloption",
        "referenceNo": "XB03094",
        "orderType": "B2C",
        "originPortCode": "",
        "injectPortCode": "",
        "platform": "eBay",
        "incoterm": "DDP",
        "collectionType": "Drop off",
        "isInsurance": false,
        "isSignature": false,
        "remark": "testremark",
        "extendData": {
            "extend": null
        },
        "consignee": {
            "addressCode": null,
            "addressLine1": "testaddressline1",
            "addressLine2": "8349hao",
            "addressLine3": "345shi",
            "city": "testcity",
            "company": "testcompany",
            "countryCode": "us",
            "district": "testdistrict",
            "email": "testemail@123.com",
            "extendData": null,
            "name": "testconsigneename",
            "phone": "36247938384",
            "state": "teststate",
            "taxId": "testtaxid",
            "taxId1": "testtaxid1",
            "zipCode": "8238juej"
        },
        "shipper": {
            "addressLine1": "",
            "addressLine2": "",
            "addressLine3": "",
            "city": "",
            "company": "",
            "countryCode": "us",
            "district": "",
            "email": "",
            "extendData": null,
            "name": "",
            "phone": "",
            "state": "",
            "taxId": "",
            "taxId1": "",
            "zipCode": ""
        },
        "returnAddress": {
            "addressLine1": "",
            "addressLine2": "",
            "addressLine3": "",
            "city": "",
            "company": "",
            "countryCode": "",
            "district": "",
            "email": "",
            "extendData": null,
            "name": "",
            "phone": "",
            "returnOption": "",
            "state": "",
            "zipCode": ""
        },
        "parcels": [
            {
                "referenceNo": "PARCEL0323002",
                "referenceNo1": "",
                "referenceNo2": "",
                "consignmentId": "",
                "trackingNo": "",
                "descriptionEn": "descriptionen",
                "description": "description",
                "dangerousGoods": true,
                "batteryType": true,
                "weight": 1.245,
                "weightUnit": null,
                "length": "25",
                "width": "26",
                "height": "27",
                "dimensionUnit": null,
                "invoiceCurrencyCode": "USD",
                "invoiceValue": 12.5,
                "transactionCurrency": null,
                "transactionAmount": null,
                "shippingInstruction": "",
                "sortCode": "",
                "extendData": {
                    "keepShipService": false
                },
                "items": [
                    {
                        "extendData": null,
                        "hsCode": "111",
                        "itemDesc": "desc",
                        "itemDescEn": "descen",
                        "itemNumber": "1",
                        "material": "testmaterial",
                        "originCountryCode": "cn",
                        "picture": "",
                        "quantity": "1",
                        "quantityUnit": "个",
                        "salesURL": "testsalesurl",
                        "sku": "QW",
                        "unitPrice": "21",
                        "usage": "testusage",
                        "weight": "12"
                    }
                ],
                "insurance": [
                    {
                        "insuranceAmount": "12",
                        "insuranceCurrencyCode": "usd",
                        "insuranceType": null,
                        "beneficiaryType": null,
                        "beneficiary": null,
                        "beneficiaryId": null,
                        "extendData": null
                    }
                ]
            }
        ],
        "collection": {
            "date": "2023-03-09",
            "addressLine1": "testaddress1",
            "addressLine2": "testaddress2",
            "addressLine3": "testaddress3",
            "city": "testcity",
            "company": "testcompany",
            "countryCode": "us",
            "district": "testdistrict",
            "email": "testemail@123.com",
            "extendData": null,
            "name": "testname",
            "phone": "phone",
            "state": "teststate",
            "zipCode": "123456"
        }
    }
]




返回样例


成功样例

1、"ordertype":"Fulfillment"

...

代码块
[
    {
        "code": "0005",
        "data": "XB03094",
        "errors": [
            {
                "code": "600222",
                "message": "referenceNo:XB03094  field value already exists and cannot be repeated"
            },
			{
				"code":"700094",
                "message": "Multiple business codes are not allowed for the same order"
			}
        ],
        "message": "paramter error",
        "messageId": "",
        "success": false,
        "warnList": ""
    }
]

ps: test001是 订单唯一编码 ，区分不同订单的不同错误描述。批量操作 成功的不会返回，会直接保存。


附件

...