出貨確認

三方作業 #

出貨確認 #

進行三方訂單的出貨確認

Endpoint URL: https://tw.scm.yahooapis.com/scmapi/api/ThirdPartyDelivery/ConfirmOrders
HTTP Method: POST

Request Body #

ConfirmOrders #

顯示訂單相關資訊的內容。ConfirmOrders 的結構分別說明如下:

  • OrderCode:訂單編號
  • PackageNo:第幾個包裝
  • DeliveryType:物流方式

資料型態: Object Array

OrderCode #

訂單編號。
資料型態: String
必填: 是

PackageNo #

第幾個包裝。
資料型態: Integer
必填: 是
說明:
同買家不同訂單編號欲包裝再一起可以使用相同的PackageNo,即會產生同樣的出貨單號。
若設定不同的PackageNo,則會產生不同的出貨單號。

DeliveryType #

物流方式。
資料型態: Integer
必填: 是
說明:

  • DeliveryType= 1『宅配』
  • DeliveryType= 2『小包』
  • DeliveryType= 3『大型商品』

Request/Response Sample #

POST /scmapi/api/ThirdPartyDelivery/ConfirmOrders

[
  {
    "OrderCode": "RM2405070000044",
    "PackageNo": 1,
    "DeliveryType": 1
  },
  {
    "OrderCode": "RM2405070000050",
    "PackageNo": 2,
    "DeliveryType": 1
  }
]
{
    "ResponseCode": "00000",
    "ResponseMessage": "成功",
    "SuccessfulCount": 2,
    "FailedCount": 0,
    "SuccessfulOrders": [
        {
            "PackageNo": 1,
            "PackageSerialNo": 21459,
            "ShipmentNo": "1000003756",
            "BarCode": "1000003756",
            "Code2": " 11",
            "Code3": "",
            "Code4": "",
            "Code5": "",
            "QRCode": "^011000000^",
            "MDCode1": "",
            "MDCode2": "",
            "MDCode3": "",
            "TransporterId": 4,
            "LocationOfficeId": " 11",
            "LocationOfficeName": "",
            "ShippingDate": "2024/07/04 16:27:11",
            "OrderCodes": [
                "RM2405070000044"
            ]
        },
        {
            "PackageNo": 2,
            "PackageSerialNo": 21460,
            "ShipmentNo": "1000003760",
            "BarCode": "1000003760",
            "Code2": " 11",
            "Code3": "",
            "Code4": "",
            "Code5": "",
            "QRCode": "^011000000^",
            "MDCode1": "",
            "MDCode2": "",
            "MDCode3": "",
            "TransporterId": 4,
            "LocationOfficeId": " 11",
            "LocationOfficeName": "",
            "ShippingDate": "2024/07/04 16:27:12",
            "OrderCodes": [
                "RM2405070000050"
            ]
        }
    ],
    "FailedOrders": []
}

Response Elements #

若操作成功,API 會回傳 HTTP 200 response。並以 JSON 格式回傳完整的出貨狀態包含失敗的顯示訊息。

ResponseCode #

回覆出貨狀態代碼。
資料型態: String
說明:

  • 00000:出貨成功
  • 00001:出貨部份失敗,細節請見FailedOrders
  • 99999:出貨失敗,細節請見FailedOrders

ResponseMessage #

回覆出貨狀態成功與否訊息。
資料型態: String
說明:對應ResponseCode

  • 成功
  • 訂單有錯誤
  • 失敗

SuccessfulCount #

成功筆數。
資料型態: Integer

FailedCount #

失敗筆數。
資料型態: Integer

SuccessfulOrders #

顯示各訂單的出貨成功的相關資訊

  • PackageNo:第幾個包裝
  • PackageSerialNo:包裝序號
  • ShipmentNo:託運單號
  • BarCode:託運單號一維條碼標籤
  • Code2:到著碼到著簡碼(新竹物流專用)
  • Code3:到著碼衛星區(新竹物流專用)
  • Code4:到著碼註區(新竹物流專用)
  • Code5:到著碼疊區(新竹物流專用)
  • QRCode:QR Code集貨註區(新竹物流專用)
  • MDCode1:MD到著碼衛星區(新竹物流專用)
  • MDCode2:MD到著碼註區(新竹物流專用)
  • MDCode3:MD到著碼疊區(新竹物流專用)
  • TransporterId:貨運商代碼
  • LocationOfficeId:到貨區碼
  • LocationOfficeName:到貨區碼名稱
  • ShippingDate:出貨確認日
  • OrderCodes:訂單編號

資料型態: Array

各物流商標籤範例 #

PackageNo #

第幾個包裝。
資料型態: Integer

PackageSerialNo #

包裝序號。
資料型態: Integer

ShipmentNo #

託運單號。
資料型態: String

BarCode #

託運單號一維條碼標籤。
資料型態: String

Code2 #

到著碼到著簡碼(新竹物流專用)。
資料型態: String
說明:此為新竹物流專用條碼,非新竹物流會顯示空值。

Code3 #

到著碼衛星區(新竹物流專用)。
資料型態: String
說明:此為新竹物流專用條碼,非新竹物流會顯示空值。

Code4 #

到著碼註區(新竹物流專用)。
資料型態: String
說明:此為新竹物流專用條碼,非新竹物流會顯示空值。

Code5 #

到著碼疊區(新竹物流專用)。
資料型態: String
說明:此為新竹物流專用條碼,非新竹物流會顯示空值。

QRCode #

QR Code集貨註區(新竹物流專用)。
資料型態: String
說明:此為新竹物流專用條碼,非新竹物流會顯示空值。

MDCode1 #

MD到著碼衛星區(新竹物流專用)。
資料型態: String
說明:此為新竹物流專用欄位,非新竹物流會顯示空值。

MDCode2 #

MD到著碼註區(新竹物流專用)。
資料型態: String
說明:此為新竹物流專用欄位,非新竹物流會顯示空值。

MDCode3 #

MD到著碼疊區(新竹物流專用)。
資料型態: String
說明:此為新竹物流專用欄位,非新竹物流會顯示空值。

TransporterId #

貨運商代碼。
資料型態: Integer
說明:此為物流商代碼,會對應出貨物流商查詢的ShipperId欄位。

LocationOfficeId #

到貨區碼。
資料型態: String
說明:此為新竹物流專用欄位,非新竹物流會顯示0或空值。

LocationOfficeName #

到貨區碼名稱。
資料型態: String
說明:此為新竹物流專用欄位,非新竹物流會顯示空值。

ShippingDate #

出貨確認日。
資料型態: String

OrderCodes #

訂單編號。
資料型態: String Array

FailedOrders #

顯示各訂單的出貨失敗的相關資訊

  • PackageNo:第幾個包裝
  • FailedCode:錯誤代碼
  • FailedMessage:錯誤訊息
  • OrderCodes:訂單編號

資料型態: Array

PackageNo #

第幾個包裝。
資料型態: Integer

FailedCode #

錯誤代碼。
資料型態: Integer
說明:請見FailedCode對應表

FailedMessage #

錯誤訊息。
資料型態: String
說明:請見FailedCode對應表

OrderCodes #

訂單編號。
資料型態: String Array

FailedCode對應表 #
FailedCode FailedMessage
2102 訂單非未出貨狀態
2103 非宅配訂單
2104 訂單已出貨
2105 訂單號碼不存在
2106 該訂單已取消
2107 訂單有未結案異動單
2109 無資料或尚未轉單到SCM
2110 物流商代碼不存在
2111 貨運單號有誤
2911 其他錯誤
0000 成功