页面历史

...

Field (API)		Data Type	Length	Mandatory	Details
referenceNo		String	80	M	Unique ID of the client's order
referenceNo1		String	80	O	Client order number
trackingNo		String	40	O	Tracking number
serviceCode		String	64	M	Service code, provided by logistics provider
incoterm		String	3	O	DDU/DDP
description		String	60	M	English product name
nativeDescription		String	255	O	Chinese name
weight		Double		M	weight(>=0.000001)
weightUnit		String	3	O	Weight unit, enumeration value：G, KG,LB Default value：KG
length		Double		O	long
width		Double		O	wide
height		Double		O	high
volume		Double		O	体积volume(>=0.01)
dimensionUnit		String	3	O	长度单位，枚举值：MLength unit, enumeration value：M, CM 默认值：CMDefault value：CM
invoiceValue		Double		M	货值The error between the value of goods (> = 0.01) ，与sumand sum (itemCount itemcount * unitValueunitvalue) 的误差不能超过0cannot exceed 0.1
invoiceCurrency		String	3	M币种，ISO货币代码	Currency, ISO currency code
		Boolean	1	O	枚举值：Yenumerator values：Y/N 默认值：NDefault value：N
authorityToLeave		Boolean
lockerService		Boolean
batteryType		String	64	O	电池类型，枚举值：Battery type, enumeration value： No Battery Lithium Ion Polymer Lithium Ion Alloy 默认值：No Default value：No Battery
batteryPacking		String	64	O	电池包装，枚举值：Battery packaging，enumerator values： No Battery Inside Equipment Packaged with Equipment Battery Only Other 默认值：No Default value：No Battery
dangerousGoods		Boolean		O默认值：false	Default value：false
sku		String	128	O捡货清单，一般面单上会显示出来	The picking list is usually displayed on the face list
serviceOption		String	60	O
instruction		String	255	O派送指令	Dispatch instruction
facility		String	20	O发件网点，物流商提供	Delivery outlets, provided by logistics providers
platform		String	20	O平台代码	Platform code
recipientName		String	50	M	收件人名称Recipient name 限制英语 Limit English / 法语字符/非纯数字自动去除特殊字符French characters / non pure numbers Automatic removal of special characters
recipientTaxId		String	100	O收件人税号	Recipient tax number
recipientCompany		String	50	O收件人公司名	Recipient company name
phone		String	20	O	电话Telephone
email		String	50	O	邮箱mailbox
addressLine1		String	200	M	地址第一行限制英语/法语字符/非纯数字自动去除特殊字符First line of address Limit English / French characters / non pure numbers Automatic removal of special characters
addressLine2		String	200	O地址第二行	Second line of address
addressLine3		String	80	O地址第三行	Third line of address
city		String	80	M	城市
state		String	80	M	省限制英语 Limit English / 法语字符/非纯数字自动去除特殊字符French characters / non pure numbers Automatic removal of special characters
postcode		String	16	O邮编	Zip code
country		String	2	M国家二字代码	Country two character code
shipperName		String	50	M	发件人名称shipperr name 限制英语 Limit English / 法语字符/非纯数字自动去除特殊字符French characters / non pure numbers Automatic removal of special characters
shipperPhone		String	20	O	电话Phone
shipperAddressLine1		String	200	O地址第一行	First line of address
shipperAddressLine2		String	200	O地址第二行	Second line of address
shipperAddressLine3		String	80	O地址第三行	Third line of address
shipperCity		String	80	O	城市City
shipperState		String	80	O	省State
shipperPostcode		String	16	O	邮编Postcode
shipperCountry		String	2	O国家二字代码	Country two character code
returnOption		String	100	O退件选项	return option
returnName		String	50	M退件接收人名称	Return recipient name
returnAddressLine1		String	200	M地址第一行	First line of address
returnAddressLine2		String	200	O地址第二行	Second line of address
returnAddressLine3		String	80	O地址第三行	Third line of address
returnCity		String	80	M	城市City
returnState		String	80	M	省State
returnPostcode		String	16	O	邮编Postcode
returnCountry		String	2	M国家二字代码	Country two character code
items		List		OItem信息	Item information
	itemNo	String	128	M	Item编号itemNo
	sku	String	128	M	SKU
	description	String	60	M	英文品名如果值为空，设置成订单级别的description 1. 不能包含设置的违禁品关键词 2. 必须是英文和法文字符或数字English product name If the value is empty, it is set to the description of the order level 1. The keyword of contraband set cannot be included 2. Must be English and French characters or numbers
	nativeDescription	String	255	O中文品名	Chinese name
	hsCode	String	60	O	HS Code
	originCountry	String	60	M国家二字代码，三字代码或名称	Country two word code, three word code or name
	itemCount	Integer		M	件数，>0number，>0
	unitValue	Double		M单价，>0	Unit Price，>0
	warehouseNo		50	O截取前50个字符	Intercept the first 50 characters
	productURL	String	512	O产品链接	Product link
	itemWeight	Double		OItem重量，转换成KG	Item weight, converted to KG
extendData		List		O扩展字段	Extended field
	vendorid	String	12	O	税号vendorid
	gstexemptionCode	Sting	4	OGST免税码，如果vendorid正确，该字段值自动设置为“PAID”	GST tax exemption code. If the vendorid is correct, the field value is automatically set to "paid"
	senderTaxId	String	255	O	发货人税号senderTaxId
	InjectPort	String	256	O订单配送港口，针对加拿大服务	Order delivery port for Canadian service
pieces		array[map,...]		O	一票多件包裹信息	Parcel Info	单个包裹的请求字段结构同上方要求一致One ticket multiple package information
	Parcel Info				The request field structure of a single package is consistent with the requirements above

Response description

The server returns the order result corresponding to the request, including:

1) Order status(status)

Failed（失败），Success（成功），Partial Success（部分成功）；

2) Error message(errors)

2.1）Error code(code)；

2.2）Error message(message)；

3) Specific message list(data)

3.1）order number（orderId)

3.2）Customer number(referenceNo)

3.3）trackingNo(trackingNo)

3.4）This record indicates the operation status(status)

3.5）More than one ticket（piecesResult）

3.6）Extended field（extraProperty）

3.6.1）Fly into port (injectPort)

3.6.2) Customs clearance method (customsClearanceType)

3.7）Error message list(errors)

3.7.1）Error code(code)

3.7.2) Error message(message)

4) Warning message(warnings)

4.1）Warning code(code)；

4.2）Warning message(message)；

Request message

Single ticket creation

代码块

language	js
borderStyle	solid
firstline	1
title	Request
linenumbers	true

[
  {
    "referenceNo": "reedzhang1231211",
    "country": "AU",
    "serviceCode": "UBI.AU2AU.AUPOST.1",
    "serviceOption": "Expedited",
    "facility": "can",
    "state": "VICTORIA",
    "city": "Berwick",
    "postcode": "3806",
    "addressLine1": "3 Lakeside Drivie",
    "addressLine2": "",
    "recipientName": "Corrie McKee",
    "phone": "0403536112",
    "email": "corrie.mckee@monash.edu",
    "sku": "sw2111202146745684",
    "invoiceCurrency": "USD",
    "invoiceValue": 6.23,
    "weightUnit": "g",
    "weight": 264,
    "description": "sw2111202146745684",
    "nativeDescription": "连衣裙",
    "shipperName": "Jiang Yuanfei",
    "shipperPhone": "+86 02586707811",
    "shipperAddressLine1": "Prologis (Anbo) Logistics Center Datang Town,Sanshui Industrial Park",
    "vendorid": "111",
    "abnnumber": "",
    "gstexemptioncode": "PAID",
    "extendData": {
      "injectPort": null
    },
    "orderItems": [
      {
        "itemCount": 1,
        "originCountry": "CN",
        "description": "sw2111202146745684",
        "nativeDescription": "连衣裙",
        "unitValue": 3.87,
        "itemNo": "8247107",
        "sku": "sw2111202146745684"
      },
      {
        "itemCount": 1,
        "originCountry": "CN",
        "description": "sw2201125303640755",
        "nativeDescription": "背心",
        "unitValue": 2.36,
        "itemNo": "9743766",
        "sku": "sw2201125303640755"
      }
    ],
    "shipperCity": "FO SHAN",
    "volume": 0.1
  }
]

一票多件

代码块

language	js
borderStyle	solid
firstline	1
title	Request
linenumbers	true

 [
  {
    "referenceNo": "MAC2022041101012",
    "serviceCode": "UBI.CA2CA.PUROLATOR",
    "recipientName": "AMAZONYYC1",
    "phone": "68765183",
    "addressLine1": "University of Toronto 27",
    "addressLine2": "",
    "addressLine3": "",
    "city": "Toronto",
    "state": " Ontario",
    "postcode": "M5S 1A1",
    "country": "CA",
    "length": "",
    "width": "",
    "height": "",
    "shipperName": "alex",
    "shipperAddressLine1": "test",
    "shipperAddressLine2": "",
    "shipperAddressLine3": "",
    "shipperCity": "ON",
    "shipperState": "ON",
    "shipperPostcode": "k1z3yz",
    "shipperCountry": "CA",
    "shipperPhone": "15000695273",
    "facility": "",
    "weight": 1,
    "invoiceValue": 23.4,
    "invoiceCurrency": "USD",
    "description": "watch,pencil",
    "nativeDescription": "手表,铅笔",
    "sku": "sku001,sku002",
    "orderItems": [
      {
        "itemNo": 1,
        "sku": "sku001",
        "description": "watch",
        "nativeDescription": "手表",
        "hsCode": "hscode001",
        "originCountry": "CN",
        "itemCount": 2,
        "unitValue": 7.8,
        "warehouseNo": "",
        "productURL": "",
        "weight": 2
      },
      {
        "itemNo": 2,
        "sku": "sku002",
        "description": "pencil",
        "nativeDescription": "铅笔",
        "hsCode": "hscode002",
        "originCountry": "CN",
        "itemCount": 1,
        "unitValue": 7.8,
        "warehouseNo": "",
        "productURL": "",
        "weight": 2
      }
    ],
    "pieces": [
      {
        "referenceNo": "MAC2022040601012-1",
        "serviceCode": "UBI.CA2CA.PUROLATOR",
        "recipientName": "AMAZONYYC1",
        "phone": "68765183",
        "addressLine1": "University of Toronto 27",
        "addressLine2": "",
        "addressLine3": "",
        "city": "Toronto",
        "state": " Ontario",
        "postcode": "M5S 1A1",
        "country": "CA",
        "length": "",
        "width": "",
        "height": "",
        "shipperName": "alex",
        "shipperAddressLine1": "test",
        "shipperAddressLine2": "",
        "shipperAddressLine3": "",
        "shipperCity": "ON",
        "shipperState": "ON",
        "shipperPostcode": "k1z3yz",
        "shipperCountry": "CA",
        "shipperPhone": "15000695273",
        "facility": "",
        "invoiceValue": 23.4,
        "invoiceCurrency": "USD",
        "weight": 1,
        "description": "watch,pencil",
        "nativeDescription": "手表,铅笔",
        "sku": "sku001,sku002",
        "orderItems": [
          {
            "itemNo": 1,
            "sku": "sku001",
            "description": "watch",
            "nativeDescription": "手表",
            "hsCode": "hscode001",
            "originCountry": "CN",
            "itemCount": 2,
            "unitValue": 7.8,
            "warehouseNo": "",
            "productURL": "",
            "weight": 2
          },
          {
            "itemNo": 2,
            "sku": "sku002",
            "description": "pencil",
            "nativeDescription": "铅笔",
            "hsCode": "hscode002",
            "originCountry": "CN",
            "itemCount": 1,
            "unitValue": 7.8,
            "warehouseNo": "",
            "productURL": "",
            "weight": 2
          }
        ]
      },
      {
        "referenceNo": "MAC2022040601012-2",
        "serviceCode": "UBI.CA2CA.PUROLATOR",
        "recipientName": "AMAZONYYC1",
        "phone": "68765183",
        "addressLine1": "University of Toronto 27",
        "addressLine2": "",
        "addressLine3": "",
        "city": "Toronto",
        "state": " Ontario",
        "postcode": "M5S 1A1",
        "country": "CA",
        "length": "",
        "width": "",
        "height": "",
        "shipperName": "alex",
        "shipperAddressLine1": "test",
        "shipperAddressLine2": "",
        "shipperAddressLine3": "",
        "shipperCity": "ON",
        "shipperState": "ON",
        "shipperPostcode": "k1z3yz",
        "shipperCountry": "CA",
        "shipperPhone": "15000695273",
        "facility": "",
        "invoiceValue": 15.6,
        "invoiceCurrency": "USD",
        "weight": 1,
        "description": "mask",
        "nativeDescription": "口罩",
        "sku": "sku003",
        "orderItems": [
          {
            "itemNo": 1,
            "sku": "sku003",
            "description": "mask",
            "nativeDescription": "口罩",
            "hsCode": "hscode003",
            "originCountry": "CN",
            "itemCount": 2,
            "unitValue": 7.8,
            "warehouseNo": "",
            "productURL": "",
            "weight": 2
          }
        ]
      },
      {
        "referenceNo": "MAC2022040601012-3",
        "serviceCode": "UBI.CA2CA.PUROLATOR",
        "recipientName": "AMAZONYYC1",
        "phone": "68765183",
        "addressLine1": "University of Toronto 27",
        "addressLine2": "",
        "addressLine3": "",
        "city": "Toronto",
        "state": " Ontario",
        "postcode": "M5S 1A1",
        "country": "CA",
        "length": "",
        "width": "",
        "height": "",
        "shipperName": "alex",
        "shipperAddressLine1": "test",
        "shipperAddressLine2": "",
        "shipperAddressLine3": "",
        "shipperCity": "ON",
        "shipperState": "ON",
        "shipperPostcode": "k1z3yz",
        "shipperCountry": "CA",
        "shipperPhone": "15000695273",
        "facility": "",
        "invoiceValue": 15.6,
        "invoiceCurrency": "USD",
        "weight": 2,
        "description": "pencil,pencil",
        "nativeDescription": "铅笔,铅笔",
        "sku": "sku002,sku002",
        "orderItems": [
          {
            "itemNo": 1,
            "sku": "sku002",
            "description": "pencil",
            "nativeDescription": "铅笔",
            "hsCode": "hscode002",
            "originCountry": "CN",
            "itemCount": 1,
            "unitValue": 7.8,
            "warehouseNo": "",
            "productURL": "",
            "weight": 2
          },
          {
            "itemNo": 2,
            "sku": "sku002",
            "description": "pencil",
            "nativeDescription": "铅笔",
            "hsCode": "hscode002",
            "originCountry": "CN",
            "itemCount": 1,
            "unitValue": 7.8,
            "warehouseNo": "",
            "productURL": "",
            "weight": 1
          }
        ]
      },
      {
        "referenceNo": "MAC2022040601012-4",
        "serviceCode": "UBI.CA2CA.PUROLATOR",
        "recipientName": "AMAZONYYC1",
        "phone": "68765183",
        "addressLine1": "University of Toronto 27",
        "addressLine2": "",
        "addressLine3": "",
        "city": "Toronto",
        "state": " Ontario",
        "postcode": "M5S 1A1",
        "country": "CA",
        "length": "",
        "width": "",
        "height": "",
        "shipperName": "alex",
        "shipperAddressLine1": "test",
        "shipperAddressLine2": "",
        "shipperAddressLine3": "",
        "shipperCity": "ON",
        "shipperState": "ON",
        "shipperPostcode": "k1z3yz",
        "shipperCountry": "CA",
        "shipperPhone": "15000695273",
        "facility": "",
        "invoiceValue": 15.6,
        "invoiceCurrency": "USD",
        "weight": 2,
        "description": "pencil,pencil",
        "nativeDescription": "铅笔,铅笔",
        "sku": "sku002,sku002",
        "orderItems": [
          {
            "itemNo": 1,
            "sku": "sku002",
            "description": "pencil",
            "nativeDescription": "铅笔",
            "hsCode": "hscode002",
            "originCountry": "CN",
            "itemCount": 1,
            "unitValue": 7.8,
            "warehouseNo": "",
            "productURL": "",
            "weight": 2
          },
          {
            "itemNo": 2,
            "sku": "sku002",
            "description": "pencil",
            "nativeDescription": "铅笔",
            "hsCode": "hscode002",
            "originCountry": "CN",
            "itemCount": 1,
            "unitValue": 7.8,
            "warehouseNo": "",
            "productURL": "",
            "weight": 1
          }
        ]
      }
    ]
  }
]

响应报文

代码块

language	java
firstline	1
title	Response
linenumbers	true

 {
    "status": "Success",
    "errors": null,
    "data": [
        {
            "status": "Success",
            "errors": null,
            "warnings": null,
            "orderId": "loMIAw32B4aZRbOseBdrBQ",
            "referenceNo": "MAC20220411010121",
            "trackingNo": "TBV000038042",
            "connoteId": null,
            "piecesResult": [
                {
                    "status": "Success",
                    "errors": null,
                    "warnings": null,
                    "orderId": "jVI2ejMorJrcSSzKW_Dkqw",
                    "referenceNo": "MAC20220411010121-1",
                    "trackingNo": "TBV000038059",
                    "connoteId": null
                },
                {
                    "status": "Success",
                    "errors": null,
                    "warnings": null,
                    "orderId": "PaiwbT-k94aUREQgTbO2mQ",
                    "referenceNo": "MAC20220411010121-2",
                    "trackingNo": "TBV000038067",
                    "connoteId": null
                },
                {
                    "status": "Success",
                    "errors": null,
                    "warnings": null,
                    "orderId": "b77OtFHcwZz8R5JD5GkxpQ",
                    "referenceNo": "MAC20220411010121-3",
                    "trackingNo": "TBV000038075",
                    "connoteId": null
                },
                {
                    "status": "Success",
                    "errors": null,
                    "warnings": null,
                    "orderId": "QQFrxW21yLcYQ4p7jeQ2nQ",
                    "referenceNo": "MAC20220411010121-4",
                    "trackingNo": "TBV000038083",
                    "connoteId": null
                }
            ],
            "extraProperty": {}
        }
    ],
    "warnings": null
}

Float_table_content

Hidable	false

页面树结构

版本比较

旧版本 3

新版本 4

标识

Response description

Request message

Single ticket creation

一票多件

响应报文