转至元数据结尾
转至元数据起始

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

与当前比较 查看页面历史

« 前一个 版本 60 下一个 »

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)


Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

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

String50发件人网点B2C:shipper facility
FF:warehouse
M

orderUniqueNumber

referenceNo



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

String10订单类型枚举:
B2C=小包直邮(此处为该值)
Fulfillment=仓库一件代发
M
originPortCode

String
始发港(空港/海港)英文代码O
injectPortCode

String50目的港英文代码O
channelCode

String64渠道代码英文、英文标点M
channelOption

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

Short20平台

枚举

1: Amazon

2: eBay

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

O
incoterm

String50贸易术语枚举
DDU
DDP
O
collectionType 


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

insuranceOrNot

isInsurance



Boolean5是否投保boolean 不填默认falseO

signatureOrNot

isSignature



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


200备注
O
extendData



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


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

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拓展字段




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


referenceNo2
String80包裹参考号2


consignmentId
String50包裹货物ID澳邮要求MLID+ConsignmentID 2年内不得重复使用数字

trackingNo
String80包裹跟踪号


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交易金额电商平台成交金额

shippingInstruction
String50装运指示会显示在部分渠道的面单上

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

extendData


拓展字段

拓展字段key-value(新增)

'keepShipService': xxx boolean 是/否

'xxId':xxx


orderType=Fulfillment :可用;

orderType=B2C :不用;
itemsitemNumberString128商品编号


itemDescEnString255商品英文描述


itemDescString255商品本地描述


skuString128SKU编码
M
hsCodeString128海关编码


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


unitPricedecimal8,2单价


pictureString
图片base64

salesURLString500销售链接


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

weightBigDecimal8,3重量


usageString255用途


matertial

material

String255材质


extendData

拓展字段


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

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


beneficiaryString255受益人/公司


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


insuranceCurrencyCodeString3投保三字代码币种


insuranceAmountBigDecimal20,3保险金额


extendData

拓展字段


collectionInfo

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"

[
    {
        "facility": "Australian Warehouse",
        "channelCode": "AU test",
        "channelOption": "",
        "referenceNo": "TestA00001",
        "orderType": "Fulfillment",
        "platform": "eBay",
        "remark": "testremark",
        "consignee": {
            "addressCode": "11113",
            "addressLine1": "street9230",
            "addressLine2": "8349hao",
            "addressLine3": "345shi",
            "city": "testcity",
            "company": "testcompany",
            "countryCode": "us",
            "district": "testdistrict",
            "email": "testemail@123.com",
            "extendData": null,
            "name": "Mack",
            "phone": "36247938384",
            "state": "teststate",
            "taxId": "testtaxid",
            "taxId1": "testtaxid1",
            "zipCode": "8238juej"
        },
        "parcels": [
            {
                "referenceNo": "12",
                "referenceNo1": "",
                "referenceNo2": "",
                "consignmentId": "",
                "trackingNo": "",
                "descriptionEn": "",
                "description": "",
                "dangerousGoods": false,
                "batteryType": "false",
                "weight": 1.245,
                "weightUnit": null,
                "length": "",
                "width": "",
                "height": "",
                "dimensionUnit": "CM",
                "invoiceCurrencyCode": null,
                "invoiceValue": "12.22",
                "transactionCurrency": "USD",
                "transactionAmount": "5.12",
                "shippingInstruction": "",
                "sortCode": "",
                "extendData": {
                    "keepShipService": false
                },
                "items": [
                    {
                        "quantity": "1",
                        "sku": "SKG"
                    },
                    {
                        "quantity": "2",
                        "sku": "TESTcommodity"
                    }
                ]
            }
        ]
    },
    {
        "facility": "Australian Warehouse",
        "channelCode": "AU test",
        "channelOption": "",
        "referenceNo": "TestA00002",
        "orderType": "Fulfillment",
        "platform": "eBay",
        "remark": "testremark",
        "consignee": {
            "addressCode": "11113",
            "addressLine1": "street9230",
            "addressLine2": "8349hao",
            "addressLine3": "345shi",
            "city": "testcity",
            "company": "testcompany",
            "countryCode": "us",
            "district": "testdistrict",
            "email": "testemail@123.com",
            "extendData": null,
            "name": "Mack",
            "phone": "36247938384",
            "state": "teststate",
            "taxId": "testtaxid",
            "taxId1": "testtaxid1",
            "zipCode": "8238juej"
        },
        "parcels": [
            {
                "referenceNo": "12",
                "referenceNo1": "",
                "referenceNo2": "",
                "consignmentId": "",
                "trackingNo": "",
                "descriptionEn": "",
                "description": "",
                "dangerousGoods": false,
                "batteryType": "false",
                "weight": 1.245,
                "weightUnit": null,
                "length": "",
                "width": "",
                "height": "",
                "dimensionUnit": "CM",
                "invoiceCurrencyCode": null,
                "invoiceValue": "12.22",
                "transactionCurrency": "USD",
                "transactionAmount": "5.12",
                "shippingInstruction": "",
                "sortCode": "",
                "extendData": {
                    "keepShipService": false
                },
                "items": [
                    {
                        "quantity": "1",
                        "sku": "SKG"
                    },
                    {
                        "quantity": "2",
                        "sku": "TESTcommodity"
                    }
                ]
            }
        ]
    }
]

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"

[
    {
        "code": "0005",
        "data": "TestA00001",
        "errors": [
            {
                "code": "600904",
                "message": "referenceNo:TestA00001,Already exists in the system"
            }
        ],
        "message": "paramter error",
        "messageId": "",
        "success": false,
        "warnList": ""
    },
    {
        "code": "0005",
        "data": "TestA00002",
        "errors": [
            {
                "code": "600904",
                "message": "referenceNo:TestA00002,Already exists in the system"
            }
        ],
        "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是 订单唯一编码 ,区分不同订单的不同错误描述。批量操作 成功的不会返回,会直接保存。


尚未有文件在此分享

  • 无标签