/v1/OrderShipping/ConfirmHomeDelivery (Deprecated)
Deprecated
對宅配訂單執行出貨確認
Request parameters
Parameter |
Value |
Description |
---|---|---|
TransactionId |
string (Require) |
交易序號 |
OrderId |
string (Require) |
訂單編號 |
ShippingSupplierCode |
int (Optional) |
物流商代碼 |
ShippingNumber |
string (Optional) |
貨運單號 |
Sample Request:
https://tw.ews.mall.yahooapis.com/stauth/v1/OrderShipping/ConfirmHomeDelivery?TransactionId=21410233&OrderId=2001&Formal=xml
OR
https://tw.ews.mall.yahooapis.com/oauth/v1/OrderShipping/ConfirmHomeDelivery?TransactionId=21410233&OrderId=2001&Formal=xml
請注意: Order API 使用 https 通訊協定。
Response fields
Field |
Description |
---|---|
OrderShippingConfirmDate |
出貨確認日 |
ErrorCode |
錯誤代碼 |
ErrorMessage |
錯誤訊息 |
Sample response
JSON sample
{
"Response": {
"@Status": "ok",
"Transaction": {
"@Id": "123456",
"Order": {
"@Id": "YM1234567",
"OrderShippingConfirmDate": "2010/11/12"
}
}
}
}
XML sample
<?xml version="1.0" encoding="UTF-8"?>
<Response Status="ok">
<Transaction Id="123456">
<Order Id="YM1234567">
<OrderShippingConfirmDate>2010/11/12</OrderShippingConfirmDate>
</Order>
</Transaction>
</Response>
Errors
ErrorCode |
ErrorMessage |
---|---|
2101 |
為物流處理費 |
2102 |
訂單非未出貨狀態 |
2103 |
非宅配訂單 |
2104 |
若沒有非未出貨的訂單子單,才能出貨 |
2109 |
無資料或尚未轉單到SCM |
2110 |
物流商代碼不存在 |
其他錯誤請參閱共用錯誤表
/v2/OrderShipping/ConfirmHomeDelivery (New)
對宅配訂單執行出貨確認
Request parameters
Parameter |
Value |
Description |
---|---|---|
TransactionId |
string (Require) |
交易序號 |
OrderId |
string (Require) |
訂單編號 |
ShippingSupplierCode |
int (Require) |
物流商代碼 |
ShippingNumber |
string (Require) |
貨運單號 |
Sample Request:
https://tw.ews.mall.yahooapis.com/stauth/v2/OrderShipping/ConfirmHomeDelivery?TransactionId=21410233&OrderId=2001&ShippingSupplierCode=4&ShippingNumber=1234567890&Formal=xml
OR
https://tw.ews.mall.yahooapis.com/oauth/v2/OrderShipping/ConfirmHomeDelivery?TransactionId=21410233&OrderId=2001&ShippingSupplierCode=4&ShippingNumber=1234567890&Formal=xml
請注意: Order API 使用 https 通訊協定。
Response fields
Field |
Description |
---|---|
OrderShippingConfirmDate |
出貨確認日 |
ErrorCode |
錯誤代碼 |
ErrorMessage |
錯誤訊息 |
Sample response
JSON sample
{
"Response": {
"@Status": "ok",
"Transaction": {
"@Id": "123456",
"Order": {
"@Id": "YM1234567",
"OrderShippingConfirmDate": "2010/11/12"
}
}
}
}
XML sample
<?xml version="1.0" encoding="UTF-8"?>
<Response Status="ok">
<Transaction Id="123456">
<Order Id="YM1234567">
<OrderShippingConfirmDate>2010/11/12</OrderShippingConfirmDate>
</Order>
</Transaction>
</Response>
Errors
ErrorCode |
ErrorMessage |
---|---|
2101 |
為物流處理費 |
2102 |
訂單非未出貨狀態 |
2103 |
非宅配訂單 |
2104 |
若沒有非未出貨的訂單子單,才能出貨 |
2109 |
無資料或尚未轉單到SCM |
2110 |
物流商代碼不存在 |
其他錯誤請參閱共用錯誤表
/v1/OrderShipping/QueryStoreDeliveryReceipt
查詢超商出貨單
Request parameters
Parameter |
Value |
Description |
---|---|---|
StartOrderShippingConfirmDate |
Date(Require) |
起始出貨確認日期 (yyyy/mm/dd) |
EndOrderShippingConfirmDate |
Date(Require) |
迄止出貨確認日期 (yyyy/mm/dd) EndOrderShippingConfirmDate - StartOrderShippingConfirmDate 要小於等於3天 |
Position |
int(Require) |
由第幾筆開始拿資料 |
Count |
int(Require) |
資料筆數 Count=1~100 |
Sample Request:
https://tw.ews.mall.yahooapis.com/stauth/v1/OrderShipping/QueryStoreDeliveryReceipt?StartOrderShippingConfirmDate=2010/01/01&EndOrderShippingConfirmDate=2010/01/02&Position=1&Count=1&Format=xml
OR
https://tw.ews.mall.yahooapis.com/oauth/v1/OrderShipping/QueryStoreDeliveryReceipt?StartOrderShippingConfirmDate=2010/01/01&EndOrderShippingConfirmDate=2010/01/02&Position=1&Count=1&Format=xml
請注意: Order API 使用 https 通訊協定。
Response fields
Field |
Description |
---|---|
TransactionList |
包含符合查詢條件的Transaction List,屬性:
|
TotalCount |
符合查詢條件的總資料筆數 |
Transaction |
包含一筆Transaction的資料,屬性:
|
StoreType |
超商種類
|
DeliveryReceiptList |
包含此筆交易的DeliveryReceipt,屬性:
|
DeliveryReceipt |
包含一筆DeliveryReceipt的資料,屬性:
|
DistributionChannelStatus |
超商通路狀態
|
DistributionChannelStatusDesc |
超商通路狀態描述 |
OrderList |
包含此筆出貨單的OrderList,屬性:
|
Order |
包含一筆Order的資料,屬性:
|
OrderStatue |
訂單狀態
|
OrderStatusDesc |
訂單狀態描述 |
Sample response
JSON sample
{"Response":
{
"@Status":"ok",
"TransactionList":
{
"@Count":1,
"@TotalCount":10,
"Transaction":
[
{
"@Id":"1234567",
"StoreType":"7-11",
"DeliveryReceiptList":
[
{
"@Count":"1",
"DeliveryReceipt":
[
{
"@Id":7654321,
"DistributionChannelStatus":"0",
"_DistributionChannelStatusDesc":"\u7522\u751f\u51fa\u8ca8\u55ae",
"OrderList":
{
"@Count":"2",
"Order":
[
{
"@Id":"YM1008310000077",
"OrderStatus":"NEW",
"_OrderStatusDesc":"\u672a\u7d50\u6848"
},
{
"@Id":"YM1008310000078",
"OrderStatus":"NEW",
"_OrderStatusDesc":"\u672a\u7d50\u6848"
}
]
}
}
]
}
]
}
]
}
}
}
XML sample
<?xml version="1.0" encoding="UTF-8"?>
<Response Status="ok">
<TransactionList Count="1" TotalCount="10">
<Transaction Id="1234567">
<StoreType>7-11</StoreType>
<DeliveryReceiptList Count="1">
<DeliveryReceipt Id="7654321">
<DistributionChannelStatus>0</DistributionChannelStatus>
<DistributionChannelStatusDesc><![CDATA[產生出貨單]]></DistributionChannelStatusDesc>
<OrderList Count="2">
<Order Id="YM1008310000077">
<OrderStatus>NEW</OrderStatus>
<OrderStatusDesc><![CDATA[未結案]]></OrderStatusDesc>
</Order>
<Order Id="YM1008310000078">
<OrderStatus>NEW</OrderStatus>
<OrderStatusDesc><![CDATA[未結案]]></OrderStatusDesc>
</Order>
</OrderList>
</DeliveryReceipt>
</DeliveryReceiptList>
</Transaction>
</TransactionList>
</Response>
Errors
/v1/OrderShipping/GetStoreDeliveryReceiptDetail
取得超商出貨單明細資料
Request parameters
Parameter |
Value |
Description |
---|---|---|
DeliveryReceiptId |
string (Optional) |
出貨單編號 |
PinCode |
string (Optional) |
交貨便服務代碼 |
請注意: 若訂單為 7-11 門市交寄,請務必以PinCode(交貨便服務代碼)查詢!
Sample Request:
https://tw.ews.mall.yahooapis.com/stauth/v1/OrderShipping/GetStoreDeliveryReceiptDetail?DeliveryReceiptId=123456&Format=xml
OR
https://tw.ews.mall.yahooapis.com/oauth/v1/OrderShipping/GetStoreDeliveryReceiptDetail?DeliveryReceiptId=123456&Format=xml
請注意: Order API 使用 https 通訊協定。
Response fields
Field |
Description |
---|---|
Id |
出貨單編號 |
PinCode |
交貨便服務代碼 |
TransactionId |
交易序號 |
StoreType |
超商種類
|
SerialNumber |
For列印超商標籤時使用 |
DeliveryReceiptPrice |
出貨單金額 |
DistributionChannelStatus |
通路狀態
|
_DistributionChannelStatusDesc |
通路狀態描述 |
OrderShippingConfirmDate |
出貨確認日 |
LastDeliveryDate |
最晚送貨日 |
OrderDelayShippingDate |
可以延遲出貨日 |
_ReceiverName |
收件者姓名 |
_TakeDeliveryConvenienceStoreName |
取貨門市名稱 |
TakeDeliveryConvenienceStoreId |
取貨門市代碼 |
Barcode |
條碼 |
DeliveryToConvenienceStoreDate |
門市進貨日(貨品抵達門市日期) |
ConvenienceStoreReturnDate |
門市退貨日(門市退回貨品日期) |
ConvenienceStoreOrderId |
廠商訂單編號 |
_StoreName |
商店名稱 |
_CustomerCareInfo |
客服資訊 |
_Url |
網址 |
_SenderName |
寄件人姓名 |
OrderList |
包含此筆出貨單的OrderList,屬性:
|
Order |
包含一筆Order的資料,屬性:
|
OrderStatus |
訂單狀態
|
_DeliverType |
交寄方式 |
_OrderStatusDesc |
訂單狀態描述 |
OrderProductList |
包含此筆訂單的Order Product List,屬性
|
Product |
包含一筆訂購的商品資料,屬性:
|
SaleType |
SaleType
|
_CustomizeProductId |
自定貨號 |
_ProductName |
商品名稱 注意:當ProductName=物流服務費,此訂單不需要執行出貨確認 |
_Spec |
商品規格 |
Amount |
數量 |
Subtotal |
金額小計(折扣後價格) |
FirstBarcode |
一段標:母代碼 (_eshopcode) + 配送編號 (_shpno) |
RoutingBarcode |
『理貨條碼(5)』:
|
PickupEShopBarcode |
『取貨條碼ㄧ (9)』:
|
PickupCodBarcode |
『取貨條碼二(16)』:
|
PickupLogisticCode |
取件物流碼(18) = 物流編號 (17) + 物流檢核碼(1) |
LogisticCode |
物流編號 (17): 取件物流碼前 17 碼 = 1(表示全家)+ 母代碼 + 00 + 日翊訂單編號 |
LogisticCheckSum |
物流檢核碼(1): 取件物流碼第 18 碼檢核碼 (依據對照表 CheckSumCodes) EX : D |
_QrCode |
QR Code 的內容 |
StoreEquimentId |
門市設備代碼 |
StoreRegion |
門市區域 |
StoreRoute |
理貨路線 |
StoreRouteTrim |
理貨路順 |
_ReturnPeriod |
退貨週期 |
_ReturnType |
退貨方式 |
PickupUserName |
取貨人姓名 |
MobilePhone |
取貨人手機末 3 碼 |
ConvenienceStoreId |
取貨店號 |
_ConvenienceStoreName |
取貨門市店名 |
OrderInformation |
訂單資料(一起買序號+超商子代碼) |
LogisticOrderNumber |
全家(日翊) / 萊爾富 訂單編號 |
DistributionCenter |
大物流代碼,固定為 DRE |
CustomerInformation |
客服專線:(02)7722-9966 / tw.mall.yahoo.com |
Remark |
收款備註: 『請收款結帳』:超商『取貨付款』完成付款即取貨 『請核對證件』:超商『取貨不付款』(純取貨需核對證件後取貨) |
OfficialName |
官網名稱,請固定為『雅虎奇摩』 |
Sample response
JSON sample
{
"Response": {
"@Status": "ok",
"DeliveryReceipt": {
"@Id": "S834016884830",
"PinCode": "",
"TransactionId": "197040950",
"StoreType": "Family",
"SerialNumber": "57216400",
"DeliveryReceiptPrice": "1388",
"DistributionChannelStatus": "A",
"OrderShippingConfirmDate": "2019/12/03",
"LastDeliveryDate": "2019/12/04",
"OrderDelayShippingDate": "2019/12/07",
"TakeDeliveryConvenienceStoreId": "F014370",
"Barcode": "834S834016884830",
"FirstBarcode": "834S834016884830",
"RoutingBarcode": "1DZ16",
"PickupEShopBarcode": "834097901",
"PickupCodBarcode": "0537846410138838",
"PickupLogisticCode": "18340009705378464Q",
"LogisticCode": "18340009705378464",
"LogisticCheckSum": "Q",
"StoreEquimentId": "6",
"StoreRegion": "3",
"StoreRoute": "DZ",
"StoreRouteTrim": "16",
"MobilePhone": "835",
"ConvenienceStoreId": "F014370",
"OrderInformation": "19704095012",
"LogisticOrderNumber": "097053784",
"DistributionCenter": "DRE",
"CustomerInformation": "(02)7722-9966 / tw.mall.yahoo.com",
"Remark": "請收款結帳",
"OfficialName": "雅虎奇摩",
"DeliveryToConvenienceStoreDate": "2019/12/05",
"ConvenienceStoreReturnDate": "2019/12/12",
"ConvenienceStoreOrderId": "197040950-57216400",
"SenderMobile": "",
"OrderList": {
"@Count": "4",
"Order": [
{
"@Id": "YM19120250118",
"OrderStatus": "SHIPPED",
"OrderProductList": {
"@Count": "1",
"Product": {
"@Id": "p04621839048_1",
"SaleType": "PreSaleByShipdays",
"Amount": "1",
"Subtotal": "92",
"_CustomizeProductId": "08190003-C24-F",
"_ProductName": "LU-特N細長珍珠髮夾組-白 現+預【08190003】",
"_Spec": "白"
}
},
"_DeliverType": "全家(物流交寄)",
"_OrderStatusDesc": "完成出貨"
},
{
"@Id": "YM19120250118",
"OrderStatus": "SHIPPED",
"OrderProductList": {
"@Count": "1",
"Product": {
"@Id": "p04621960874_3",
"SaleType": "PreSaleByShipdays",
"Amount": "1",
"Subtotal": "355",
"_CustomizeProductId": "09190027-A29-F",
"_ProductName": "LU-Q多色毛呢貝蕾帽-13色 【09190027】",
"_Spec": "米"
}
},
"_DeliverType": "全家(物流交寄)",
"_OrderStatusDesc": "完成出貨"
},
{
"@Id": "YM19120250118",
"OrderStatus": "SHIPPED",
"OrderProductList": {
"@Count": "1",
"Product": {
"@Id": "p0462196819_2",
"SaleType": "PreSaleByShipdays",
"Amount": "1",
"Subtotal": "470",
"_CustomizeProductId": "03190148-A33-F",
"_ProductName": "LU-M混色針織背心-3色【03190148】",
"_Spec": "杏"
}
},
"_DeliverType": "全家(物流交寄)",
"_OrderStatusDesc": "完成出貨"
},
{
"@Id": "YM19120250119",
"OrderStatus": "SHIPPED",
"OrderProductList": {
"@Count": "1",
"Product": {
"@Id": "p04621971_3",
"SaleType": "PreSaleByShipdays",
"Amount": "1",
"Subtotal": "471",
"_CustomizeProductId": "01190742-A63-F",
"_ProductName": "LU-M素面長版襯衫-5色 【01190742】",
"_Spec": "桔"
}
},
"_DeliverType": "全家(物流交寄)",
"_OrderStatusDesc": "完成出貨"
}
]
},
"_DistributionChannelStatusDesc": "顧客取貨(A)",
"_ReceiverName": "黃",
"_TakeDeliveryConvenienceStoreName": "全家大發輔大二店",
"_QrCode": "B1|| || || || ||18340009705378464Q||2||014370||1DZ16|| 6||0||834097901||0537846410138838|| || ",
"_ReturnPeriod": "當日退",
"_ReturnType": "其他-佶傳",
"_ConvenienceStoreName": "全家大發輔大二店",
"_StoreName": "Lu",
"_CustomerCareInfo": "0422153318",
"_Url": "tw.mall.yahoo.com",
"_SenderName": ""
},
"_Message": ""
}
}
XML sample
<?xml version="1.0" encoding="UTF-8"?>
<Response Status="ok">
<Transaction Id="5475153">
<DeliveryReceipt Id="S834016626042">
<PinCode></PinCode>
<StoreType>Family</StoreType>
<SerialNumber>56360610</SerialNumber>
<DeliveryReceiptPrice>1590</DeliveryReceiptPrice>
<DistributionChannelStatus>0</DistributionChannelStatus>
<DistributionChannelStatusDesc><![CDATA[產生出貨單]]></DistributionChannelStatusDesc>
<OrderShippingConfirmDate>2010/09/23</OrderShippingConfirmDate>
<LastDeliveryDate>2010/09/24</LastDeliveryDate>
<OrderDelayShippingDate>2010/09/28</OrderDelayShippingDate>
<ReceiverName><![CDATA[王小明]]></ReceiverName>
<TakeDeliveryConvenienceStoreName><![CDATA[元大門市]]></TakeDeliveryConvenienceStoreName>
<TakeDeliveryConvenienceStoreId>F011421</TakeDeliveryConvenienceStoreId>
<Barcode>834S834016626042</Barcode>
<FirstBarcode>834S834016626042</FirstBarcode>
<RoutingBarcode>1SN13</RoutingBarcode>
<PickupEShopBarcode>834097901</PickupEShopBarcode>
<PickupCodBarcode>0200204310015116</PickupCodBarcode>
<PickupLogisticCode>183400097020020430</PickupLogisticCode>
<LogisticCode>18340009702002043</LogisticCode>
<LogisticCheckSum>0</LogisticCheckSum>
<QrCode>B1|| || || || ||183400097020020430||2||011421||1SN13|| 0||0||834097901||0200204310015116|| || </QrCode>
<StoreEquimentId>0</StoreEquimentId>
<StoreRegion>1</StoreRegion>
<StoreRoute>SN</StoreRoute>
<StoreRouteTrim>13</StoreRouteTrim>
<MobilePhone>628</MobilePhone>
<ConvenienceStoreId>F011421</ConvenienceStoreId>
<OrderInformation>1930127869136</OrderInformation>
<LogisticOrderNumber>09702002043</LogisticOrderNumber>
<DistributionCenter>DRE</DistributionCenter>
<CustomerInformation>(02)7722-9966 / tw.mall.yahoo.com</CustomerInformation>
<Remark>請收款結帳</Remark>
<OfficialName>雅虎奇摩</OfficialName>
<DeliveryToConvenienceStoreDate>2010/09/25</DeliveryToConvenienceStoreDate>
<ConvenienceStoreReturnDate>2010/10/02</ConvenienceStoreReturnDate>
<ConvenienceStoreOrderId><![CDATA[5475153-16379]]></ConvenienceStoreOrderId>
<StoreName><![CDATA[B商店]]></StoreName>
<CustomerCareInfo><![CDATA[02123456789]]></CustomerCareInfo>
<Url><![CDATA[http://tw.mall.yahoo.com]]></Url>
<OrderList Count="1">
<Order Id="YM1008020000008">
<OrderStatus>NEW</OrderStatus>
<OrderStatusDesc><![CDATA[未結案]]></OrderStatusDesc>
<OrderDate>1900/01/01</OrderDate>
<OrderProductList Count="1">
<Product Id="100_1">
<SaleType>Normal</SaleType>
<CustomizedProductId><![CDATA[A0001主件100_1]]></CustomizedProductId>
<ProductName><![CDATA[主件一]]></ProductName>
<Spec><![CDATA[]]></Spec>
<Amount>2</Amount>
<Subtotal>1590</Subtotal>
</Product>
</OrderProductList>
</Order>
</OrderList>
</DeliveryReceipt>
</Transaction>
</Response>
Errors
/v1/OrderShipping/ConfirmStoreDelivery
對超商訂單執行出貨確認(物流交寄)
Request parameters
Parameter |
Value |
Description |
---|---|---|
TransactionId |
string(Require) |
交易序號 |
OrderId |
string(Require) |
訂單編號,可接受多筆,但須屬於同一個交易序號下的訂單編號 ex. 請注意:
|
Sample Request:
https://tw.ews.mall.yahooapis.com/stauth/v1/OrderShipping/ConfirmStoreDelivery?TransactionId=23000&OrderId=YM1234567890123&OrderId=YM1234567890124&Format=xml
OR
https://tw.ews.mall.yahooapis.com/oauth/v1/OrderShipping/ConfirmStoreDelivery?TransactionId=23000&OrderId=YM1234567890123&OrderId=YM1234567890124&Format=xml
請注意: Order API 使用 https 通訊協定。
Response fields
Field |
Description |
---|---|
StoreType |
超商種類
|
DeliveryReceiptId |
出貨單編號 |
DeliveryReceiptPrice |
出貨單金額 |
OrderShippingConfirmDate |
出貨確認日 |
LastDeliveryDate |
最晚送貨日 |
OrderDelayShippingDate |
可以延遲出貨日 |
DeliveryToConvenienceStoreDate |
門市進貨日(貨品抵達門市日期) |
ConvenienceStoreReturnDate |
門市退貨日(門市退回貨品日期) |
OrderList |
包含此筆出貨單的OrderList,屬性:
|
Order |
包含一筆Order的資料,屬性:
|
ErrorCode |
錯誤代碼 |
ErrorMessage |
錯誤訊息 |
Sample response
JSON sample
{"Response":
{
"@Status":"ok",
"DeliveryReceipt":
{
"@Id":"10016380",
"StoreType":"7-11",
"DeliveryReceiptPrice":"1590",
"OrderShippingConfirmDate":"2010/09/23",
"LastDeliveryDate":"2010/09/24",
"OrderDelayShippingDate":"2010/09/28",
"DeliveryToConvenienceStoreDate":"2010/09/25",
"ConvenienceStoreReturnDate":"2010/10/02",
"OrderList":
[
{
"Order":
[
{
"@Id":"YM1008020000008"
},
{
"@Id":"YM1008020000009"
}
]
}
]
}
}
}
XML sample
<?xml version="1.0" encoding="UTF-8"?>
<Response Status="ok">
<DeliveryReceipt Id="10016380">
<StoreType>7-11</StoreType>
<DeliveryReceiptPrice>1590</DeliveryReceiptPrice>
<OrderShippingConfirmDate>2010/09/23</OrderShippingConfirmDate>
<LastDeliveryDate>2010/09/24</LastDeliveryDate>
<OrderDelayShippingDate>2010/09/28</OrderDelayShippingDate>
<DeliveryToConvenienceStoreDate>2010/09/25</DeliveryToConvenienceStoreDate>
<ConvenienceStoreReturnDate>2010/10/02</ConvenienceStoreReturnDate>
<OrderList>
<Order Id="YM1008020000008"></Order>
<Order Id="YM1008020000009"></Order>
</OrderList>
</DeliveryReceipt>
</Response>
Errors
ErrorCode |
ErrorMessage |
---|---|
2121 |
部分訂單不屬此交易序號 |
2122 |
出貨金額不可=0 |
2123 |
請勿傳入物流服務費 |
2124 |
部分訂單已出貨,請再確認 |
2125 |
部分訂單已取消,請再確認 |
2127 |
無法取得店家資料 |
2128 |
訂單無法出貨,請再確認。 |
2129 |
門市關轉OR店號轉換,請隔日再試行出貨 |
其他錯誤請參閱共用錯誤表
/v1/OrderShipping/ConfirmStoreDeliveryC2C
對超商訂單執行出貨確認(門市交寄)
Request parameters
Parameter |
Value |
Description |
---|---|---|
TransactionId |
string(Require) |
交易序號 |
OrderId |
string(Require) |
訂單編號,可接受多筆,但須屬於同一個交易序號下的訂單編號 ex. 請注意:
|
SenderName |
string(Require) |
寄件人姓名 |
SenderMobile |
string(Require) |
寄件人手機 |
Sample Request:
https://tw.ews.mall.yahooapis.com/stauth/v1/OrderShipping/ConfirmStoreDeliveryC2C?TransactionId=23000&OrderId=YM1234567890123&OrderId=YM1234567890124&SenderName=seller&SenderMobile=0911222333&Format=xml
OR
https://tw.ews.mall.yahooapis.com/oauth/v1/OrderShipping/ConfirmStoreDeliveryC2C?TransactionId=23000&OrderId=YM1234567890123&OrderId=YM1234567890124&SenderName=seller&SenderMobile=0911222333&Format=xml
請注意: Order API 使用 https 通訊協定。
Response fields
Field |
Description |
---|---|
StoreType |
超商種類
|
DeliveryReceiptId |
出貨單編號 |
PinCode |
交貨便服務代碼 (7-11門市交寄使用) |
DeliveryReceiptPrice |
出貨單金額 |
OrderShippingConfirmDate |
出貨確認日 |
LastDeliveryDate |
最晚送貨日 |
OrderDelayShippingDate |
可以延遲出貨日 |
DeliveryToConvenienceStoreDate |
門市進貨日(貨品抵達門市日期) |
ConvenienceStoreReturnDate |
門市退貨日(門市退回貨品日期) |
OrderList |
包含此筆出貨單的OrderList,屬性:
|
Order |
包含一筆Order的資料,屬性:
|
ErrorCode |
錯誤代碼 |
ErrorMessage |
錯誤訊息 |
Sample response
JSON sample
{"Response":
{
"@Status":"ok",
"DeliveryReceipt":
{
"@Id":"10016380",
"StoreType":"7-11",
"DeliveryReceiptId":"2036904K",
"PinCode":"E60766352104",
"DeliveryReceiptPrice":"1590",
"OrderShippingConfirmDate":"2010/09/23",
"LastDeliveryDate":"2010/09/24",
"OrderDelayShippingDate":"2010/09/28",
"DeliveryToConvenienceStoreDate":"2010/09/25",
"ConvenienceStoreReturnDate":"2010/10/02",
"OrderList":
[
{
"Order":
[
{
"@Id":"YM1008020000008"
},
{
"@Id":"YM1008020000009"
}
]
}
]
}
}
}
XML sample
<?xml version="1.0" encoding="UTF-8"?>
<Response Status="ok">
<DeliveryReceipt Id="10016380">
<StoreType>7-11</StoreType>
<DeliveryReceiptId>2036904K</DeliveryReceiptId>
<PinCode>E60766352104</PinCode>
<DeliveryReceiptPrice>1590</DeliveryReceiptPrice>
<OrderShippingConfirmDate>2010/09/23</OrderShippingConfirmDate>
<LastDeliveryDate>2010/09/24</LastDeliveryDate>
<OrderDelayShippingDate>2010/09/28</OrderDelayShippingDate>
<DeliveryToConvenienceStoreDate>2010/09/25</DeliveryToConvenienceStoreDate>
<ConvenienceStoreReturnDate>2010/10/02</ConvenienceStoreReturnDate>
<OrderList>
<Order Id="YM1008020000008"></Order>
<Order Id="YM1008020000009"></Order>
</OrderList>
</DeliveryReceipt>
</Response>
Errors
ErrorCode |
ErrorMessage |
---|---|
2121 |
部分訂單不屬此交易序號 |
2122 |
出貨金額不可=0 |
2123 |
請勿傳入物流服務費 |
2124 |
部分訂單已出貨,請再確認 |
2125 |
部分訂單已取消,請再確認 |
2127 |
無法取得店家資料 |
2128 |
訂單無法出貨,請再確認。 |
2129 |
門市關轉OR店號轉換,請隔日再試行出貨 |
其他錯誤請參閱共用錯誤表
/v1/OrderShipping/CancelStoreDeliveryReceipt
取消超商出貨單
Request parameters
Parameter |
Value |
Description |
---|---|---|
DeliveryReceiptId |
string (Optional) |
出貨單編號 |
PinCode |
string (Optional) |
交貨便服務代碼 |
請注意: 若訂單為 7-11 門市交寄,請務必以PinCode(交貨便服務代碼)查詢!
Sample Request:
https://tw.ews.mall.yahooapis.com/stauth/v1/OrderShipping/CancelStoreDeliveryReceipt?DeliveryReceiptId=1234567&Format=xml
OR
https://tw.ews.mall.yahooapis.com/oauth/v1/OrderShipping/CancelStoreDeliveryReceipt?DeliveryReceiptId=1234567&Format=xml
請注意: Order API 使用 https 通訊協定。
Response fields
Field |
Description |
---|---|
SuccessList |
成功的出貨單列表 |
DeliveryReceipt |
包含一筆DeliveryReceipt的資料,屬性:
|
OrderList |
包含此筆出貨單的OrderList,屬性:
|
Order |
包含一筆Order的資料,屬性:
|
ErrorCode |
錯誤代碼 |
ErrorMessage |
錯誤訊息 |
Sample response
JSON sample
{
"Response":
{
"@Status":"ok",
"SuccessList":
{
"DeliveryReceipt":
{
"@Id":"123456",
"OrderList":
{
"@Count":2,
"Order":
[
{
"@Id":"YM1008020000010"
},
{
"@Id":"YM1008020000011"
}
]
}
}
}
}
}
XML sample
<?xml version="1.0" encoding="UTF-8"?><Response Status="ok">
<SuccessList>
<DeliveryReceipt Id="123456">
<OrderList Count="2">
<Order Id="YM1008020000010"></Order>
<Order Id="YM1008020000011"></Order>
</OrderList>
</DeliveryReceipt>
</SuccessList>
</Response>
Errors
ErrorCode |
ErrorMessage |
---|---|
2141 |
無法重新包裝:最晚送貨日需大於系統日 |
2142 |
無法重新包裝,請再確認。 |
已交寄無法作廢。 |
其他錯誤請參閱共用錯誤表
/v1/OrderShipping/ConfirmESD
對ESD訂單執行出貨確認
Request parameters
Parameter |
Value |
Description |
---|---|---|
TransactionId |
string(Require) |
交易序號 |
OrderId |
string(Require) |
訂單編號 |
ProductId.n |
string(Require) |
商品編號_商品規格編號 請將parameter中的"n"以數字代換,ex:ProductId.1=p1020128060_1&ProductId.2=p1020128061_1
|
DownloadSite.n |
string(Optional) |
下載網址 請將parameter中的"n"以數字代換,n為對應ProductId.n所屬的資料內容 若未傳入則default=商店首頁 |
DownloadSiteNote.n |
string(Optional) |
下載網址說明 請將parameter中的"n"以數字代換,n為對應ProductId.n所屬的資料內容 |
ProductKey.n |
string(Optional) |
商品序號 請將parameter中的"n"以數字代換,n為對應ProductId.n所屬的資料內容
|
ShippingNote |
string(Optional) |
出貨備註 |
OthersEmail |
string(Optional) |
其他Email
|
Sample Request:
https://tw.ews.mall.yahooapis.com/stauth/v1/OrderShipping/ConfirmESD?TransactionId=23000&OrderId=YM1234567890123&ProductId.1=p1234567890_1&Format=xml
OR
https://tw.ews.mall.yahooapis.com/oauth/v1/OrderShipping/ConfirmESD?TransactionId=23000&OrderId=YM1234567890123&ProductId.1=p1234567890_1&Format=xml
請注意: Order API 使用 https 通訊協定。
Response fields
Field |
Description |
---|---|
OrderShippingConfirmDate |
出貨確認日 |
ErrorCode |
錯誤代碼 |
ErrorMessage |
錯誤訊息 |
Sample response
JSON sample
{
"Response": {
"@Status": "ok",
"Transaction": {
"@Id": "123456",
"Order": {
"@Id": "YM1234567",
"OrderShippingConfirmDate": "2010/11/12"
}
}
}
}
XML sample
<?xml version="1.0" encoding="UTF-8"?>
<Response Status="ok">
<Transaction Id="123456">
<Order Id="YM1234567">
<OrderShippingConfirmDate>2010/11/12</OrderShippingConfirmDate>
</Order>
</Transaction>
</Response>
Errors
ErrorCode |
ErrorMessage |
---|---|
2151 |
此為[物流服務費]無需出貨 |
2152 |
[商品編號]筆數不符 |
2153 |
傳入[商品編號]無效 |
2154 |
[商品序號]筆數不符 |
2155 |
供應商不存在 |
2156 |
訂單非未出貨狀態 |
其他錯誤請參閱共用錯誤表