版本比较

标识

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

API Description 

Create Fulfillment Order

Endpoint

HTTP Verb 

URL

Post

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

/v1/openApi/packetOrder/b2c/createOrders


Sample

Request Headers

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


补充描述MB2C:发货人网点
Fulfillment:仓库代码区分不同订单用英文代码英文代码英文、英文标点英文、英文标点枚举:请按照页面底部附件“平台名称”要求填写boolean 不填默认falseboolean 不填默认false

orderType=Fulfillment :必填;

orderType=B2C :必填;英文代码收件人省/州

orderType=Fulfillment :必填;

orderType=B2C :必填;orderType=Fulfillment :必填;英文代码退件选项退件人电话退件人邮箱退件人国家二字代码退件人省/州退件人城市退件人区退件人地址第一行退件人邮编拓展字段自定义拓展字段澳邮要求MLID+ConsignmentID 2年内不得重复使用数字8位,小数点后3位枚举:CM(默认)、M英文代码电商平台成交币种电商平台成交金额需要包含文件类型,如: 出库单会显示在部分渠道的面单上会显示在部分渠道的面单上拓展字段英文代码拓展字段可能是用来区分不同的保险第三方平台或者产品枚举:
公司=company
个人=自定义拓展字段自定义拓展字段(说明:如果类型是pickup,要填)英文代码
一级字段二级字段三级字段类型长度限制中文含义描述是否必填Level 1 FieldLevel 2 FieldLevel 3 FieldTypeLength LimitMeaningDescriptionRequiredRemark
orderType

String
订单类型Order Type枚举

Enumeration:

B2C

=小包直邮
Fulfillment=仓库一件代发

(End-to-end Small Parcel)

Fulfillment (Warehouse Dropshipping)

M

When using eTower WMS module, please pass 'Fulfillment' 

facility

String50发件人网点Sender Facility/仓库代码Warehouse Code

B2C: Sender facility code;

Fulfillment: Warehouse code

M

referenceNo



String50订单唯一编码Order Unique CodeUsed to differentiate ordersM
originPortCode

String始发港(空港/海港)
Origin Port (Airport/Seaport)English Character CodeO
injectPortCode

String50目的港Destination PortEnglish Character CodeO
channelCode

String64渠道名称Channel NameEnglish & English punctuationM

Note:

When orderType=Fulfillment使用查询仓库服务列表接口中返回的serviceType=5且active=1的serviceName下单, use the serviceName returned in 18. Query Warehouse Service List API where serviceType=5 and active=1 for placing orders

channelOption

String64渠道选项Channel OptionEnglish & English punctuationO
platform

String20平台Platform

Enumeration:

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

O
incoterm

String50Trade Term贸易术语

Enumeration:

枚举:DDU、DDP

DDU、DDP

O
collectionType 


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

Enumeration:

Pickup (door-to-door collection)

Drop off (self-delivery to warehouse).

Default Drop off if not filled

O

isInsurance



Boolean5是否投保Whether to Add Insurance

Default false if not filled

O

isSignature



Boolean5是否签名Whether Signature Required

Default false if not filled

O
remark


200备注Remarks
O
isOffLineOrder

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

orderType=Fulfillment相关参数

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

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


Abandoned Flied


isNeedConfirm

Boolean是否自动确认发送

默认为true

orderType=Fulfillment相关参数

true:订单自动确认,确认后订单信息无法修改

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

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

consigneeWhether 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
String50收件人地址代码比如ONT8表示某个亚马逊仓库Consignee Address Codee.g., ONT8 represents an FBA warehouse

Parameters related to orderType=B2C 相关参数

name
String50收件人姓名Consignee Name
M


company
String512收件人公司Consignee Company


phone
String50收件人电话Consignee Phone


email
String50收件人邮箱Consignee Email


countryCode
String2目的国二字代码Destination Country 2-Character CodeEnglish codeM

orderType=Fulfillment :必填;

orderType=B2C :必填;


stateString80state
String80Consignee Province/State


city
String80收件人城市Consignee City
M


district
String128收件人区Consignee District


addressLine1
String200收件人地址第一行Consignee Address Line 1
MorderType=B2C :必填;


addressLine2
String200收件人地址第二行Consignee Address Line 2


addressLine3
String80收件人地址第三行Consignee Address Line 3


zipCode
String16收件人邮编Consignee Postal Code


taxId
String255收件人税号Consignee Tax ID


taxId1
String255收件人税号1Consignee Tax ID1


extendData


拓展字段Extended Fields


shippername
String50发件人姓名Shipper Name

only  when orderType=B2C才可以填写shipper 对象,且非必填,  shipper object can filled and it's optional

company
String512发件人公司Shipper Company

phone
String50发件人电话Shipper Phone

email
String50发件人邮箱Shipper Email

countryCode
String2始发国二字代码Origin Country 2-Character CodeEnglish code
state
String80发件人省Shipper Province/State

city
String80发件人城市Shipper City

district
String128发件人区Shipper District

addressLine1
String200发件人地址第一行Shipper Address Line 1

addressLine2
String200发件人地址第二行Shipper Address Line 2

addressLine3
String80发件人地址第三行Shipper Address Line 3

zipCode
String16发件人邮编Shipper Postal Code

taxId
String255发件人税号Shipper Tax ID

taxId1
String255发件人税号1Shipper Tax ID1

extendData


Extended Fields

拓展字段 key

 key-value



returnAddress

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

only  when orderType=B2C

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

name退件人姓名

,  shipper object can filled and it's optional

name
String50Return(from) Contact Name

company退件人公司
String512Return (from) Company Name

phone
String50emailReturn (from) Phone

email
String50Return (from) Email

countryCode
String2英文代码英文代码stateReturn (from) Country 2-Character CodeEnglish code
state
String80cityReturn (from) Province/State

city
String80Return (from) City

district
String128Return (from) District

addressLine1
String200Return(from) Address Line 1

addressLine2退件人地址第二行
String200Return(from) Address Line 2

addressLine3退件人地址第三行
String80zipCodeReturn(from) Address Line 3

zipCode
String16Return(from)  Postal Code

extendData
ObjectObject
Extended Fields

extendData.shippingMethod拓展字段1
String255Extended Fields1

extendData.xxx拓展字段2
String255Extended Fields2

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


referenceNo2
String80包裹参考号2Package Reference No2


consignmentId
String50包裹货物IDPackage 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 Type枚举
true=带电
false=不带电trueWith battery
falseWithout battery


weight
BigDecimal8,3包裹重量Package Weight8 digits, 3 decimal placesM

orderType=Fulfillment :不必填;:Optional;

orderType=B2C

:必填;

:Mandatory;

weightUnit
String2Weight Unit重量单位

Enumeration:

枚举:KG

KG (

默认)、G、LB

default),

G,

LB



length
BigDecimal8,2包裹长Package Length


width
BigDecimal8,2包裹宽Package Width


height
BigDecimal8,2包裹高Package Height


dimensionUnit
String8尺寸单位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表示LbaelFulfillment & 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

拓展字段keykey-value format

key:keepShipService
value:boolean


Can be used only when orderType=Fulfillment :可用;

orderType=B2C :不用;



String255Extended 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 ContentBase64格式Base64 formatM
attachTypeString5附件扩展名Attachment Extension仅支持Only supports "rar", "zip", "pdf", "doc", "docx", "xls", "xlsx"M
filtTypeInteger
Attachment Type附件类型

Enumeration:

 1:Label

不填或其他值:Other1:Label

If not filled or other values: Other

O
itemsitemNumberString128商品编号Product Number









itemDescEnString255商品英文描述Product English Description


itemDescString255商品本地描述Product Local Description


skuString128SKU编码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投保类型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拓展字段1Extended Fields1

extendData.xxString255拓展字段2Extended Fields2







collection


date
date揽收日期年月日
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

附件