eTowerOne Developers
页面树结构

版本比较

旧版本 2

changes.mady.by.user 刘子榭

保存于

比较

新版本 当前版本

changes.mady.by.user 刘子榭

保存于

标识

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

...

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


Level 1 FieldLevel 2 FieldLevel 3 FieldTypeLength LimitMeaningDescriptionRequiredRemark
orderType

String
Order Type

Enumeration:

B2C (End-to-end Small Parcel)

Fulfillment (Warehouse Dropshipping)

M

When using eTower WMS module, please pass 'Fulfillment' 

facility

String50Sender Facility/Warehouse Code

B2C: Sender facility code;

Fulfillment: Warehouse code

M

referenceNo



String50Order Unique CodeUsed to differentiate ordersM
originPortCode

String
Origin Port (Airport/Seaport)English Character CodeO
injectPortCode

String50Destination PortEnglish Character CodeO
channelCode

String64Channel NameEnglish & English punctuationM

Note:

When orderType=Fulfillment, use the serviceName returned

in

in 18. Query Warehouse Service List API where serviceType=5 and active=1 for placing orders

channelOption

String64Channel OptionEnglish & English punctuationO
platform

String20Platform

Enumeration:

Please fill according to "Platform Names" attachment at the bottom of the page

O
incoterm

String50Trade Term

Enumeration:

DDU、DDP

O
collectionType 


20Collection Type

Enumeration:

Pickup (door-to-door collection)

Drop off (self-delivery to warehouse).

Default Drop off if not filled

O

isInsurance



Boolean5Whether to Add Insurance

Default false if not filled

O

isSignature



Boolean5Whether Signature Required

Default false if not filled

O
remark


200Remarks
O
isOffLineOrder

Boolean
Abandoned Flied


isNeedConfirm

Boolean
Whether Auto-Confirm

Default is true.


Parameters related to orderType=Fulfillment ：

true means: Order is auto-confirmed, cannot modify after confirmation;

false means:  Order is created as draft, can modify; needs to call "8. Forecast Outbound Order" for confirmation

extendData



Extended Fields

e.g., IOSS, key-value format



consigneeaddressCode
String50Consignee Address Codee.g., ONT8 represents an FBA warehouse

Parameters related to orderType=B2C

name
String50Consignee Name
M


company
String512Consignee Company


phone
String50Consignee Phone


email
String50Consignee Email


countryCode
String2Destination Country 2-Character CodeEnglish codeM


state
String80Consignee Province/State


city
String80Consignee City
M


district
String128Consignee District


addressLine1
String200Consignee Address Line 1
M


addressLine2
String200Consignee Address Line 2


addressLine3
String80Consignee Address Line 3


zipCode
String16Consignee Postal Code


taxId
String255Consignee Tax ID


taxId1
String255Consignee Tax ID1


extendData


Extended Fields


shippername
String50Shipper Name

only  when orderType=B2C

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

,  shipper object can filled and it's optional

company
String512Shipper Company

phone
String50Shipper Phone

email
String50Shipper Email

countryCode
String2Origin Country 2-Character CodeEnglish code
state
String80Shipper Province/State

city
String80Shipper City

district
String128Shipper District

addressLine1
String200Shipper Address Line 1

addressLine2
String200Shipper Address Line 2

addressLine3
String80Shipper Address Line 3

zipCode
String16Shipper Postal Code

taxId
String255Shipper Tax ID

taxId1
String255Shipper Tax ID1

extendData


Extended Fields

拓展字段 key

 key-value



returnAddress

returnOption
退件选项

String50
枚举：退件、销毁
Return OptionEnumeration: Return, Destroy.

only  when orderType=B2C,  shipper object can filled and it's optional

name
退件人姓名

String50Return（from) Contact Name

company
退件人公司

String512Return （from) Company Name

phone
退件人电话

String50Return （from) Phone

email
退件人邮箱

String50Return （from) Email

countryCode
退件人国家二字代码

String2
英文代码英文代码
Return （from) Country 2-Character CodeEnglish code
state
退件人省/州

String80Return （from) Province/State

city
退件人城市

String80Return （from) City

district
退件人区

String128Return （from) District

addressLine1
退件人地址第一行

String200
addressLine2退件人地址第二行
Return（from) Address Line 1

addressLine2
String200
addressLine3退件人地址第三行
Return（from) Address Line 2

addressLine3
String80Return（from) Address Line 3

zipCode
退件人邮编

String16Return（from)  Postal Code

extendData
拓展字段

Object
Object

Extended Fields

extendData.shippingMethod
拓展字段1

String255
自定义拓展字段
Extended Fields1

extendData.xxx
拓展字段2

String255Extended Fields2

parcelsreferenceNo
String80
包裹参考号
Package Reference No
M
referenceNo1
String80
包裹参考号1
Package Reference No1


referenceNo2
String80
包裹参考号2澳邮要求MLID+ConsignmentID 2年内不得重复使用数字
Package Reference No2


consignmentId
String50
包裹货物ID
Package Consignment IDAustralia Post requires MLID+ConsignmentID must not be reused within 2 years

descriptionEn
String255
包裹英文描述
Package Tracking No
M

orderType=Fulfillment

：不必填；

：Optional；

orderType=B2C
：必填；
：Mandatory；
description
String255
包裹中文描述
Package Chinese Description


dangerousGoods
Boolean5
包裹是否危险品
Whether Package is Dangerous Goods

true

=危险品

:Dangerous goods

false

=非危险品枚举

:Non-dangerous goods



batteryType
Boolean5
包裹带电类型
Package Battery Typetrue
=带电
: With battery
false
=不带电
: Without battery

weight
BigDecimal8,3
包裹重量8位，小数点后3位
Package Weight8 digits, 3 decimal placesM

orderType=Fulfillment

：不必填；

：Optional；

orderType=B2C

：必填；枚举：KG(默认)、G、LB

：Mandatory；

weightUnit
String2
重量单位
Weight Unit

Enumeration:

KG (default),

G,

LB



length
BigDecimal8,2
包裹长
Package Length


width
BigDecimal8,2
包裹宽
Package Width


height
BigDecimal8,2
包裹高
Package Height


dimensionUnit
String8
尺寸单位枚举：CM（默认）、M英文代码
Dimension Unit

Enumeration:

CM (default),

M



invoiceCurrencyCode
String3
发票币种三字代码
Invoice Currency Code,3-Character codeEnglish Code

invoiceValue
BigDecimal20,2
发票金额
Invoice Amount
M

orderType=Fulfillment

：不必填；

：Optional；

orderType=B2C

：必填；电商平台成交币种

：Mandatory；

transactionCurrency
BigDecimal8,2
交易币种电商平台成交金额
Transaction CurrencyE-commerce platform transaction currency

transactionAmount
BigDecimal8,2
交易金额
Transaction AmountE-commerce platform transaction amount

trackingNo
String80
包裹跟踪号
Package Tracking No

Required when orderType=

Fulfillment  且 所选服务是线下服务是时必填如果订单Label文件数量大于1，从第2个Label开始传入“attachments”参数中，filtType=1表示Lbael

Fulfillment & selected service is offline service

 If order Label file quantity >1, starting from the 2nd Label， pass the file in "attachments" parameter, filtType=1 represents Label

labelType
Short
面单类型

Label Type
枚举：

Enumeration:

0: url

1:base64

C
label
String
面单需要包含文件类型，如: 出库单

Label
C
labelName
String
面单名称

Label NameMust include file type, e.g.: outbound order.pdfC
shippingInstruction
String50
装运指示会显示在部分渠道的面单上会显示在部分渠道的面单上
Shipping InstructionWill appear on some channel labels

sortCode
String50
分拣码
Sort CodeWill appear on some channel labels

extendData
Object
拓展字段

Extended Fields

拓展字段key

key-value format

key：keepShipService
value：boolean


Can be used only when orderType=Fulfillment

：可用；orderType=B2C ：不用；

; 



String255
拓展字段
Extended Fields










attachments

attachNameString95
附件名称
Attachment Name
M

1

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

.M: If there are attachments, all three fields are required;

if no attachments, none are required.

2.

最多5个附件；

Maximum 5 attachments.

attachDataString
附件内容

Attachment Content
Base64格式
Base64 formatM
attachTypeString5
附件扩展名
Attachment Extension
仅支持
Only supports "rar", "zip", "pdf", "doc", "docx", "xls", "xlsx"M
filtTypeInteger
Attachment Type
附件类型

Enumeration:

 1：Label

不填或其他值：Other

1：Label

If not filled or other values: Other

O
itemsitemNumberString128
商品编号
Product Number









itemDescEnString255
商品英文描述
Product English Description


itemDescString255
商品本地描述
Product Local Description


skuString128
SKU编码
SKU Code
M
hsCodeString128
海关编码
Customs Code


quantityInteger9
商品数量
Product Quantity
M
quantityUnitString10
商品数量单位
Product Quantity Unit


unitPricedecimal
单价

Unit Price


pictureString
图片

Imagebase64

salesURLString500
销售链接英文代码
Sales Link


originCountryCodeString10
原产国二字代码
Origin Country 2-Character CodeEnglish Code

weightBigDecimal
重量

Weight


usageString255
用途
Purpose


material

String255
材质
Material


extendData
拓展字段


Extended Fields


insurance

（说明：如果isInsurance是true要填）

(Note: Fill if isInsurance is true)

insuranceTypeString30
投保类型可能是用来区分不同的保险第三方平台或者产品枚举：
公司=company
个人=
Insurance TypeCan be used to differentiate different insurance third-party platforms or products
Note: Fill if isInsurance is true








beneficiaryTypeString20
受益人类型
Beneficiary Type

Enumeration: company,

individual


beneficiaryString255
受益人
Beneficiary/
公司
Company

beneficiaryIdString20
身份证/组织机构代码证
ID Card/Organization Code Certificate

insuranceCurrencyCodeString3
投保三字代码币种
Insurance 3-Character Currency Code

insuranceAmountBigDecimal20,3
保险金额
Insurance Amount

extendDataObject
拓展字段

Extended Fields

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


extendData.xxString255
拓展字段2
Extended Fields2







collection


date
date
揽收日期年月日（说明：如果类型是pickup，要填）

Collection DateYear-Month-Day
Note: Fill if Collection Type is pickup
name
String50
客户姓名
Customer Name

company
String512
客户公司
Customer Company

phone
String50
客户电话
Customer Phone

email
String50
客户邮箱英文代码
Customer Email

countryCode
String2
客户国家二字代码
Customer Country 2-Character CodeEnglish Code
state
String80
客户省
Customer Province/
州
State

city
String80
客户城市
Customer City

district
String128
客户区
Customer District

addressLine1
String200
客户地址第一行
Customer Address Line 1

addressLine2
String200
客户地址第二行
Customer Address Line 2

addressLine3
String80
客户地址第三行
Customer Address Line 3

zipCode
String16
客户邮编
Customer Postal Code

extendData
拓展字段



Extended Fields

...





Sample Request

1、"ordertype":"Fulfillment"

...

代码块
[
    {
        "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"
        }
    }
]

...




Sample Response

...

Success Response

1、"ordertype":"Fulfillment"

...

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

...

Failure Response

1、"ordertype":"Fulfillment"

...

代码块
[
    {
        "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": ""
    }
]


Platform Name Enumeration:

Platform Name

eBay
Amazon
Aliexpress
Wish
LAZADA
Cdiscount
LINIO
Tobox
TopHatter
KiliMall
Shopify
Shopee
Joom
JD
BigCommerce
Ourmall
ZoodMall
Jumia
Jolly
Walmart
Vova
Shoplazza
Mercadolibre
AlibabaInternation
Tokopedia
Taobao
Daraz
Allegro
Pdd
Coupang
Newegg
EBG
Akulaku
Ueeshop
Shopline
shopBase
otto
yahoo
des
wayfair
OverStock
fordeal
TiKi
manomano
blibli
ozon
Shein
wownow
tiktok
Qoo10
shoppaas
JUMIA
wowma
Other

附件