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
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 | |
|---|
| sparkName | Sparkline |
|---|
| hidePane | Filtration Panel |
|---|
| limitHeight | |
|---|
| default | |
|---|
| cell-width | |
|---|
| totalRowName | |
|---|
| totalColName | |
|---|
| id | 1678688780671 |
|---|
| formatVersion | 2 |
|---|
| order | |
|---|
| inverse | |
|---|
| numbering | |
|---|
| isNew | false |
|---|
| sort | |
|---|
| totalcol | |
|---|
| rowsPerPage | |
|---|
| separator | Point (.) |
|---|
| labels | |
|---|
| thousandSeparator | |
|---|
| ignoreFirstNrows | |
|---|
| heightValue | |
|---|
| isOR | AND |
|---|
|
| 一级字段 | 二级字段 | 三级字段 | 类型 | 长度限制 | 中文含义 | 描述 | 是否必填 | 补充描述| Level 1 Field | Level 2 Field | Level 3 Field | Type | Length Limit | Meaning | Description | Required | Remark | | orderType |
|
| String | 订单类型枚举=小包直邮Fulfillment=仓库一件代发M | (End-to-end Small Parcel) Fulfillment (Warehouse Dropshipping) | M | When using eTower WMS module, please pass 'Fulfillment' | | facility |
|
| String | 50 | 发件人网点仓库代码B2C:发货人网点Fulfillment:仓库代码| Warehouse Code | B2C: Sender facility code; Fulfillment: Warehouse code | M |
| referenceNo |
|
| String | 50 |
订单唯一编码 | 区分不同订单用英文代码| Order Unique Code | Used to differentiate orders | M |
| | originPortCode |
|
| String |
始发港(空港/海港) | 英文代码| Origin Port (Airport/Seaport) | English Character Code | O |
| | injectPortCode |
|
| String | 50 |
目的港 | 英文、英文标点| Destination Port | English Character Code | O |
| | channelCode |
|
| String | 64 |
渠道名称 | | Channel Name | English & English punctuation | M | Note: When orderType=Fulfillment | 使用查询仓库服务列表接口中返回的serviceType=5且active=1的serviceName下单英文、英文标点, use the serviceName returned in Query Warehouse Service List API where serviceType=5 and active=1 for placing orders | | channelOption |
|
| String | 64 |
渠道选项 | 枚举:请按照页面底部附件“平台名称”要求填写| Channel Option | English & English punctuation | O |
| | platform |
|
| String | 20 | Platform |
平台 | Enumeration: Please fill according to "Platform Names" attachment at the bottom of the page | O |
| | incoterm |
|
| String | 50 |
贸易术语 | 枚举:DDU、DDP| Trade Term | Enumeration: DDU、DDP | O |
| | collectionType |
|
|
| 20 | 揽收类型枚举Pick up上门揽收Drop off自送到仓不填默认Drop offEnumeration: Pickup (door-to-door collection) Drop off (self-delivery to warehouse). Default Drop off if not filled | O |
| isInsurance |
|
| Boolean | 5 |
是否投保 | boolean 不填默认false| Whether to Add Insurance | Default false if not filled | O |
| isSignature |
|
| Boolean | 5 |
是否签名 | boolean 不填默认false| Whether Signature Required | Default false if not filled | O |
| | remark |
|
|
| 200 | 备注orderType=Fulfillment相关参数
true:下单时需要传入面单信息,字段:labelType、label、labelName
false:下单时不需要传入面单信息| Remarks |
| O |
| isOffLineOrder |
|
| Boolean |
是否线下订单 | boolean 不填默认false | O | extendData | 拓展字段 | 比如IOSSkey-value形式| Abandoned Flied |
|
|
| | isNeedConfirm |
|
| Boolean |
是否自动确认发送 | 默认为true | orderType=Fulfillment相关参数 true:订单自动确认,确认后订单信息无法修改 false:订单创建为草稿,订单信息可修改;则需要再调用“8.预报出库单”进行确认 | | 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 |
|
| | consignee | addressCode |
| String | 50 |
收件人地址代码 | 比如ONT8表示某个亚马逊仓库 | | Consignee Address Code | e.g., ONT8 represents an FBA warehouse |
| Parameters related to orderType=B2C | 相关参数收件人姓名orderType=Fulfillment :必填;orderType=B2C :必填;收件人公司| Consignee Company |
|
|
| | phone |
| String | 50 | 收件人电话| Consignee Phone |
|
|
| | email |
| String | 50 | 收件人邮箱英文代码| Consignee Email |
|
|
| | countryCode |
| String | 2 |
目的国二字代码 | | Destination Country 2-Character Code | English code | M |
orderType=Fulfillment :必填; orderType=B2C :必填; | 收件人省州收件人城市orderType=Fulfillment :必填;orderType=B2C :必填;收件人区| Consignee District |
|
|
| | addressLine1 |
| String | 200 | 收件人地址第一行| Consignee Address Line 1 |
| M |
orderType=Fulfillment :必填; orderType=B2C :必填;收件人地址第二行| Consignee Address Line 2 |
|
|
| | addressLine3 |
| String | 80 | 收件人地址第三行| Consignee Address Line 3 |
|
|
| | zipCode |
| String | 16 | 收件人邮编| Consignee Postal Code |
|
|
| | taxId |
| String | 255 | 收件人税号| Consignee Tax ID |
|
|
| | taxId1 |
| String | 255 | 收件人税号1| Consignee Tax ID1 |
|
|
| | extendData | 拓展字段
|
|
| Extended Fields |
|
|
| | shipper | name |
| String | 50 | 发件人姓名| Shipper Name |
|
| orderType=B2C 才可以填写shipper 对象,且非必填 | | company |
| String | 512 | 发件人公司| Shipper Company |
|
| | phone |
| String | 50 | 发件人电话| Shipper Phone |
|
| | email |
| String | 50 | 发件人邮箱英文代码| Shipper Email |
|
| | countryCode |
| String | 2 |
始发国二字代码 | | Origin Country 2-Character Code | English code |
| | state |
| String | 80 | 发件人省州发件人城市| Shipper City |
|
| | district |
| String | 128 | 发件人区| Shipper District |
|
| | addressLine1 |
| String | 200 | 发件人地址第一行| Shipper Address Line 1 |
|
| | addressLine2 |
| String | 200 | 发件人地址第二行| Shipper Address Line 2 |
|
| | addressLine3 |
| String | 80 | 发件人地址第三行| Shipper Address Line 3 |
|
| | zipCode |
| String | 16 | 发件人邮编| Shipper Postal Code |
|
| | taxId |
| String | 255 | 发件人税号| Shipper Tax ID |
|
| | taxId1 |
| String | 255 | 发件人税号1| Shipper Tax ID1 |
|
| | extendData |
|
|
| 拓展字段 key-value |
|
| returnAddress | returnOption | 退件选项 | String | 50 | 枚举:退件、销毁 |
|
| only when orderType=B2C | 才可以填写returnAddress对象,且非必填, shipper object can filled and it's optional | | name | 退件人姓名 | String | 50 |
|
|
| | company | 退件人公司 | String | 512 |
|
|
| | phone | 退件人电话 | String | 50 |
|
|
| | email | 退件人邮箱 | String | 50 |
|
|
| | countryCode | 退件人国家二字代码 | String | 2 | 英文代码 | 英文代码 |
| | state | 退件人省/州 | String | 80 |
|
|
| | city | 退件人城市 | String | 80 |
|
|
| | district | 退件人区 | String | 128 |
|
|
| | addressLine1 | 退件人地址第一行 | String | 200 |
|
|
| | addressLine2 | 退件人地址第二行 | String | 200 |
|
|
| | addressLine3 | 退件人地址第三行 | String | 80 |
|
|
| | zipCode | 退件人邮编 | String | 16 |
|
|
| | extendData | 拓展字段 | Object |
|
|
|
| | extendData.shippingMethod | 拓展字段1 | String | 255 | 自定义拓展字段 |
|
| | extendData.xxx | 拓展字段2 | String | 255 |
|
|
| | parcels | referenceNo |
| String | 80 | 包裹参考号 |
| M |
| | referenceNo1 |
| String | 80 | 包裹参考号1 |
|
|
| | referenceNo2 |
| String | 80 | 包裹参考号2 |
|
|
| | consignmentId |
| String | 50 | 包裹货物ID | 澳邮要求MLID+ConsignmentID 2年内不得重复使用数字 |
|
| | descriptionEn |
| String | 255 | 包裹英文描述 |
| M | orderType=Fulfillment :不必填; orderType=B2C :必填; | | description |
| String | 255 | 包裹中文描述 |
|
|
| | dangerousGoods |
| Boolean | 5 | 包裹是否危险品 | true=危险品 false=非危险品 |
|
| | batteryType |
| Boolean | 5 | 包裹带电类型 | 枚举 true=带电 false=不带电 |
|
| | weight |
| BigDecimal | 8,3 | 包裹重量 | 8位,小数点后3位 | M | orderType=Fulfillment :不必填; orderType=B2C :必填; | | weightUnit |
| String | 2 | 重量单位 | 枚举:KG(默认)、G、LB |
|
| | length |
| BigDecimal | 8,2 | 包裹长 |
|
|
| | width |
| BigDecimal | 8,2 | 包裹宽 |
|
|
| | height |
| BigDecimal | 8,2 | 包裹高 |
|
|
| | dimensionUnit |
| String | 8 | 尺寸单位 | 枚举:CM(默认)、M |
|
| | invoiceCurrencyCode |
| String | 3 | 发票币种三字代码 | 英文代码 |
|
| | invoiceValue |
| BigDecimal | 20,2 | 发票金额 |
| M | orderType=Fulfillment :不必填; orderType=B2C :必填; | | transactionCurrency |
| BigDecimal | 8,2 | 交易币种 | 电商平台成交币种 |
|
| | transactionAmount |
| BigDecimal | 8,2 | 交易金额 | 电商平台成交金额 |
|
| | trackingNo |
| String | 80 | 包裹跟踪号 |
|
| orderType=Fulfillment 且 所选服务是线下服务是时必填 如果订单Label文件数量大于1,从第2个Label开始传入“attachments”参数中,filtType=1表示Lbael | | labelType |
| Short |
| 面单类型 | 枚举: 0: url 1:base64 | C | | label |
| String |
| 面单 |
| C | | labelName |
| String |
| 面单名称 | 需要包含文件类型,如: 出库单.pdf | C | | shippingInstruction |
| String | 50 | 装运指示 | 会显示在部分渠道的面单上 |
|
| | sortCode |
| String | 50 | 分拣码 | 会显示在部分渠道的面单上 |
|
| | extendData |
| Object |
| 拓展字段 | 拓展字段key-value key:keepShipService value:boolean |
| orderType=Fulfillment :可用; orderType=B2C :不用; |
|
| String | 255 | 拓展字段 |
|
|
|
|
|
|
|
|
|
|
| attachments | attachName | String | 95 | 附件名称 |
| M | 1.如有附件则三个字段都必填,如无附件,则三个字段都不必填; 2.最多5个附件; | | attachData | String |
| 附件内容 | Base64格式 | M | | attachType | String | 5 | 附件扩展名 | 仅支持"rar", "zip", "pdf", "doc", "docx", "xls", "xlsx" | M | | filtType | Integer |
| 附件类型 | 1:Label 不填或其他值:Other | O | | items | itemNumber | String | 128 | 商品编号 |
|
|
|
|
|
|
|
|
|
| | itemDescEn | String | 255 | 商品英文描述 |
|
|
| | itemDesc | String | 255 | 商品本地描述 |
|
|
| | sku | String | 128 | SKU编码 |
| M |
| | hsCode | String | 128 | 海关编码 |
|
|
| | quantity | Integer | 9 | 商品数量 |
| M |
| | quantityUnit | String | 10 | 商品数量单位 |
|
|
| | unitPrice | decimal |
| 单价 |
|
|
| | picture | String |
| 图片 | base64 |
|
| | salesURL | String | 500 | 销售链接 |
|
|
| | originCountryCode | String | 10 | 原产国二字代码 | 英文代码 |
|
| | weight | BigDecimal |
| 重量 |
|
|
| | usage | String | 255 | 用途 |
|
|
| material | String | 255 | 材质 |
|
|
| | extendData |
|
| 拓展字段 |
|
|
| insurance (说明:如果isInsurance是true要填) | insuranceType | String | 30 | 投保类型 | 可能是用来区分不同的保险第三方平台或者产品 |
|
| | beneficiaryType | String | 20 | 受益人类型 | 枚举: 公司=company 个人=individual |
|
| | beneficiary | String | 255 | 受益人/公司 |
|
|
| | beneficiaryId | String | 20 | 身份证/组织机构代码证 |
|
|
| | insuranceCurrencyCode | String | 3 | 投保三字代码币种 |
|
|
| | insuranceAmount | BigDecimal | 20,3 | 保险金额 |
|
|
| | extendData | Object |
| 拓展字段 |
|
|
| | extendData.UPC | String | 255 | 拓展字段1 | 自定义拓展字段 |
|
| | extendData.xx | String | 255 | 拓展字段2 | 自定义拓展字段 |
|
|
|
|
|
|
|
|
| collection
| date |
| date |
| 揽收日期 | 年月日 |
| (说明:如果类型是pickup,要填) | | name |
| String | 50 | 客户姓名 |
|
| | company |
| String | 512 | 客户公司 |
|
| | phone |
| String | 50 | 客户电话 |
|
| | email |
| String | 50 | 客户邮箱 |
|
| | countryCode |
| String | 2 | 客户国家二字代码 | 英文代码 |
| | state |
| String | 80 | 客户省/州 |
|
| | city |
| String | 80 | 客户城市 |
|
| | district |
| String | 128 | 客户区 |
|
| | addressLine1 |
| String | 200 | 客户地址第一行 |
|
| | addressLine2 |
| String | 200 | 客户地址第二行 |
|
| | addressLine3 |
| String | 80 | 客户地址第三行 |
|
| | zipCode |
| String | 16 | 客户邮编 |
|
| | extendData |
|
|
| 拓展字段 |
|
|
|
请求样例
1、"ordertype":"Fulfillment"
...