店配作業 #
退貨單查詢 #
查詢退貨訂單資訊，結果Cache 10分鐘。
Endpoint URL: https://tw.scm.yahooapis.com/scmapi/api/StoreDelivery/GetReturnOrders
HTTP Method: POST
Request Body #
ReturnStatus #
退貨單狀態。
資料型態: String
必填: 是
說明:
- All:全部
- NonClose:未結案
- Close:已結案
- Cancel:取消
DateType #
日期條件。
資料型態: String
必填: 是
說明:
- ReturnCreateDate:退貨單建立日
- ReturnCloseDate:退貨單結案日
StartDate #
起始日期。
資料型態: dateTime
必填: 是
說明: 時間格式為
- yyyy-mm-ddThh:mm:ss
- ex. 2024-01-25T23:59:59
EndDate #
迄止日期。
資料型態: dateTime
必填: 是
說明: 時間格式為
- yyyy-mm-ddThh:mm:ss
- ex. 2024-01-25T23:59:59
Request/Response Sample #
POST /scmapi/api/StoreDelivery/GetReturnOrders
{
"ReturnStatus": "All",
"DateType": "ReturnCreateDate",
"StartDate": "2024-06-01T01:00:00",
"EndDate": "2024-07-30T23:21:55"
}
{
"ReturnOrdersCount": 3,
"ReturnOrders": [
{
"OrderInfo": {
"OrderCode": "RM2406190000704",
"ReturnCode": "2024061900003R",
"ReturnSerialNumber": "1967278",
"ReturnCreateDate": "2024-06-19T11:03:05.127",
"ReturnCloseDate": "2024-06-19T14:47:28",
"ReturnCancelDate": "1900-01-01T00:00:00",
"ReturnShpcode": "",
"ReturnCause": "瑕疵/故障",
"ReturnCauseNote": "",
"Note": ""
},
"Receiver": {
"ReceiverName": "",
"Address": null,
"Phone": "",
"Mobile": ""
},
"Product": {
"Id": 6804909,
"ProductName": "贈品",
"Attribute": "",
"SupplierNo": "",
"Type": "",
"Qty": 1,
"Cost": 0,
"SubTotal": 0
}
},
{
"OrderInfo": {
"OrderCode": "RM2406190000704",
"ReturnCode": "2024061900002R",
"ReturnSerialNumber": "1967277",
"ReturnCreateDate": "2024-06-19T11:03:04.967",
"ReturnCloseDate": "2024-06-19T14:47:28",
"ReturnCancelDate": "1900-01-01T00:00:00",
"ReturnShpcode": "",
"ReturnCause": "瑕疵/故障",
"ReturnCauseNote": "",
"Note": ""
},
"Receiver": {
"ReceiverName": "",
"Address": null,
"Phone": "",
"Mobile": ""
},
"Product": {
"Id": 6497187,
"ProductName": "1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567891",
"Attribute": "",
"SupplierNo": "",
"Type": "",
"Qty": 1,
"Cost": 0,
"SubTotal": 0
}
},
{
"OrderInfo": {
"OrderCode": "RM2407110000973",
"ReturnCode": "2024071200004R",
"ReturnSerialNumber": "1967284",
"ReturnCreateDate": "2024-07-12T11:39:57.077",
"ReturnCloseDate": "2024-07-12T11:40:52",
"ReturnCancelDate": "1900-01-01T00:00:00",
"ReturnShpcode": "",
"ReturnCause": "瑕疵/故障",
"ReturnCauseNote": "",
"Note": ""
},
"Receiver": {
"ReceiverName": "",
"Address": null,
"Phone": "",
"Mobile": ""
},
"Product": {
"Id": 6910530,
"ProductName": "[供應商宅配運費]測試賣場2",
"Attribute": "",
"SupplierNo": "",
"Type": "",
"Qty": 1,
"Cost": 50,
"SubTotal": 50
}
}
]
}
Response Elements #
若操作成功，API 會回傳 HTTP 200 response。並以 JSON 格式回傳完整的已退貨清單。
ReturnOrdersCount #
資料筆數。
資料型態: Integer
ReturnOrders #
顯示已退貨清單的內容。ReturnOrders 的結構分別說明如下：
- OrderInfo：訂單相關資訊
- Receiver：取件人相關資訊
- Product：商品相關資訊
資料型態: Object Array
OrderInfo #
顯示退貨單相關資訊的內容。OrderInfo 的結構分別說明如下：
- OrderCode：訂單編號
- ReturnCode：退貨單編號
- ReturnSerialNumber：退貨單序號
- ReturnCreateDate：退貨單成立日期
- ReturnCloseDate：退貨單結案日期
- ReturnCancelDate：退貨單取消日期
- ReturnShpcode：退貨單託運單號
- ReturnCause：退貨原因
- ReturnCauseNote：退貨原因備註
- Note：取貨備註
資料型態: Object
OrderCode #
訂單編號。
資料型態: String
ReturnCode #
退貨單編號。
資料型態: String
ReturnSerialNumber #
退貨單序號。
資料型態: String
ReturnCreateDate #
退貨單成立日期。
資料型態：dateTime
說明：時間格式為
- yyyy-mm-ddThh:mm:ss
- ex. 2024-01-20T00:00:00
ReturnCloseDate #
退貨單結案日期。
資料型態：dateTime
說明：若退貨單未結案則顯示1900-01-01T00:00:00
時間格式：
- yyyy-mm-ddThh:mm:ss
- ex. 2024-01-20T00:00:00
ReturnCancelDate #
退貨單取消日期。
資料型態: dateTime
說明: 若退貨單未取消則顯示1900-01-01T00:00:00
時間格式：
- yyyy-mm-ddThh:mm:ss
- ex. 2024-01-20T00:00:00
ReturnShpcode #
退貨單託運單號。
資料型態: String
ReturnCause #
退貨原因。
資料型態: String
說明：對應於API退貨原因查詢
- “1”: “瑕疵/故障”
- “7”: “價格比別家貴”
- “14”: “不需要或重複購買”
- “25”: “重訂(改買別款.改付款等)”
- “26”: “品質不好(質感.性能等)”
- “27”: “與網頁說明不同”
- “28”: “寄錯/缺件”
- “29”: “購物中心同商品降價”
- “32”: “不明件-代收又驗退”
- “41”: “已過優惠期間”
- “42”: “預約/訂位不易”
- “43”: “評價不佳/使用經驗不好”
- “44”: “序號使用問題”
- “45”: “O2O店家關店”
- “51”: “材質不喜歡”
- “52”: “穿起來太大”
- “53”: “穿起來太小”
- “54”: “圖片與實物有落差”
- “55”: “網頁說明不夠完整”
- “90”: “其他”
- “-1”: “拒收”
ReturnCauseNote #
退貨原因備註。
資料型態: String
Note #
取貨備註。
資料型態: String
Receiver #
顯示取件人相關資訊的內容。Receiver 的結構分別說明如下：
- ReceiverName：取件人姓名
- Address：取件人地址
- Phone：取件人電話
- Mobile：取件人手機
資料型態: Object
ReceiverName #
取件人姓名。
資料型態: String
Address #
取件人地址。
資料型態: String
Phone #
取件人電話。
資料型態: String
Mobile #
取件人手機。
資料型態: String
Product #
顯示商品相關資訊的內容。Product 的結構分別說明如下：
- Id：商品編號
- ProductName：商品名稱
- Attribute：商品屬性
- SupplierNo：供應商料號
- Type：行銷活動活動代碼
- Qty：商品數量
- Cost：商品成本
- SubTotal：商品成本小計
資料型態: Object
Id #
商品編號。
資料型態: Integer
ProductName #
商品名稱。
資料型態: String
Attribute #
商品屬性。
資料型態: String
SupplierNo #
供應商料號。
資料型態: String
Type #
行銷活動活動代碼。
資料型態: String
Qty #
商品數量。
資料型態: Integer
Cost #
商品成本。
資料型態: Integer
SubTotal #
商品成本小計。
資料型態: Integer