页面树结构

版本比较

标识

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

Description


Put orders into a bag and handover them to the first carrier.
Use the interface in three ways.

1. Create bags and new parcels at the same time. The parcels will be associated with the
corresponding bag automatically.


2. Create bags and put existing parcels into them.


3. Create bags and new parcels (same as A). Meanwhile, put some existing parcels into
new bags (same as B).


Interfaceverify:

    • Upon successful Handover request, the bag will be generated immediately with the
    • state "Closed", and all the parcels in the bag will also have the state "Closed".There can be no more than 2000 parcels in each bag

Path

Post/services/shipper/handover


Request parameters


FIELD

Required / optional

Length

Describe

batchNo

O

80

Batch number

handoverTime

O

 

Handover time(YYYY-MM-DD'T'HH:MM:SSZ)

consignor

O

80

consignor

consignee

O

80

consignee

driver

O

80

driver

plateNbr

O

80

license plate number

remark

O

Double

remark

bags

M

Array

bags


Request content

1. Create large package and new order at the same time

Request

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

{
    "batchNo": "20200810001",
    "handoverTime": "2020-08-10T11:45:22+08:00",
    "consignor": "test",
    "consignee": "test",
    "driver": "张三",
    "plateNbr": "沪A8888",
    "remark": "测试",
    "bags": [{
      "bagNo": "20201102001-001",
      "serviceCode": "UBI.CN2AU.AUPOST",
      "facility": "SZX",
      "destCountry": "AU",
      "sortCode": "",
      "battery": false,
      "parcels": [{
        "referenceNo": "TESTBDAU15303483645716",
        "serviceCode": "UBI.CN2AU.AUPOST",
        "recipientName": "WUBIN",
        "phone": "+49 3068838320",
        "addressLine1": "Stellingdamm9",
        "addressLine2": "",
        "city": "Cudgewa",
        "postcode": "3705",
        "state": "VIC",
        "country": "AU",
        "weight": 0.646,
        "invoiceCurrency": "USD",
        "batteryType": "NoBattery",
        "description": "Pants",
        "nativeDescription": "货物中文描述",
        "extendData": {
          "vendorid": "64652016681",
          "gstexemptioncode": "Paid"
        },
        "orderItems": [{
          "itemNo": 1,
          "sku": "159110805",
          "description": "Pants",
          "hsCode": "6104620050",
          "originCountry": "CHINA",
          "unitValue": "38.44",
          "itemCount": 2
        }],
        "invoiceValue": "76.88"
      }]
    }]
  }


2. Large package is associated with existing order

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

{
    "bags": [
      {
        "bagNo": "ZXHX1082270",
        "battery": false,
        "destCountry": "AU",
        "facility": "CAN",
        "parcels": [
          {
            "trackingNo": "JDQ002447301000931502"
          }
        ],
        "serviceCode": "UBI.ASP.CN2AU.AUPOST",
        "totalWeight": 0.064
      }
    ],
    "batchNo": "ZXYD1016617",
    "handoverTime": 1597039375903
  }


3. Large packages are associated with new orders and existing orders

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

{
    "batchNo": "20200810001",
    "handoverTime": "2020-08-11T22:08:08+0800",
    "consignor": "test",
    "consignee": "test",
    "driver": "张三",
    "plateNbr": "沪A8888",
    "remark": "测试",
    "bags": [{
        "bagNo": "20201102001-001",
        "serviceCode": "UBI.ASP.CN2AU.AUPOST",
        "facility": "SZX",
        "destCountry": "AU",
        "sortCode": "YYZ",
        "battery": false,
        "totalWeight": 0.3,
        "extendData": {
            "sortCode": "M1A1"
         },
        "parcels": [{
            "referenceNo": "TESTBDAU15303483645716"
        }]
    }, {
        "bagNo": "20171102001-002",
        "serviceCode": "UBI.ASP.CN2AU.AUPOST",
        "facility": "SZX",
        "destCountry": "AU",
        "sortCode": "YYZ",
        "battery": false,
        "totalWeight": 0.3,
        "parcels": [{
            "referenceNo": "TESTBDAU15303483645717",
            "serviceCode": "UBI.ASP.CN2AU.AUPOST",
            "recipientName": "WUBIN",
            "phone": "+49 3068838320",
            "addressLine1": "Stellingdamm 9",
            "addressLine2": "",
            "city": "Cudgewa",
            "postcode": "3705",
            "state": "VIC",
            "country": "AU",
            "weight": 0.646,
            "invoiceCurrency": "USD",
            "batteryType": "No Battery",
            "description": "Pants",
            "nativeDescription": "货物中文描述",
            "extendData": {
                "vendorid": "6465201 6681",
                "gstexemptioncode": "Paid"
            },
            "orderItems": [{
                "itemNo": 1,
                "sku": "159110805",
                "description": "Pants",
                "hsCode": "6104620050",
                "originCountry": "CHINA",
                "unitValue": "38.44",
                "itemCount": 2
            }],
            "invoiceValue": "76.88"
        }]
    }]
}


Response content

ResponseElements
Return results including:

1)Status

2) Errors

3) Reference No.

4) Tracking No

5) Bag No.



Response message

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

{
    "status": "Success",
    "errors": null,
    "data": [
        {
            "status": "Success",
            "errors": [],
            "bagNo": "20171102001-001",
            "orderResults": [
                {
                    "status": "Success",
                    "errors": null,
                    "orderId": null,
                    "referenceNo": "TESTBDAU15303483645716",
                    "trackingNo": null,
                    "connoteId": null
                }
            ]
        },
        {
            "status": "Success",
            "errors": [],
            "bagNo": "20171102001-002",
            "orderResults": [
                {
                    "status": "Success",
                    "errors": null,
                    "orderId": null,
                    "referenceNo": "TESTBDAU15303483645717",
                    "trackingNo": null,
                    "connoteId": null
                }
            ]
        }
    ]
}