商品上下架作業 #
賣場下架 #
- 此功能提供供應商申請賣場下架。呼叫此 API 時,請在 Headers 中加入 api-version: 3。 已申請「供應商自動上下架」權限的供應商,其賣場將自動通過審核;未申請者則需等待業務進行人工審核。
Headers 範例
{
"api-token": "Supplier_XXXX",
"api-supplierid": "XXXX",
"content-type": "application/json",
"accept": "application/json",
"api-version": "3"
}
Endpoint URL: https://tw.scm.yahooapis.com/scmapi/api/Gd/ApplyGdOff
HTTP Method: POST
Request Body #
GdIds #
賣場編號。
資料型態: Integer Array
必填: 是
說明: 輸入賣場編號陣列,最多支援1000筆資料。
- ex. [3480693, 3480691, 3480287]
Cause #
賣場下架原因代碼。
資料型態: Integer
必填: 是
說明: 賣場下架原因代碼如下:
- 2: 其他(請說明)
- 4: 活動結束
- 5: 缺貨
- 6: 賣場錯誤
- 7: 重複上架
- 8: 物流方式調整
- 9: 商品品質異常
- 10: 永久停售
CauseNote #
申請下架說明。
資料型態: String
必填: 僅cause = 2時為必填
Request/Response Sample #
POST /scmapi/api/HomeDelivery/GetShippingOrders
{
"GdIds": [3480693, 3480691, 3480287],
"Cause": 2,
"CauseNote": "申請下架"
}
{
"ResponseCode": 2202,
"ResponseMessage": "部分成功",
"Data": [
{
"GdId": 3480693,
"ErrorCode": 0,
"Message": null,
"IsSuccess": true
},
{
"GdId": 3480691,
"ErrorCode": 0,
"Message": null,
"IsSuccess": true
},
{
"GdId": 3480287,
"ErrorCode": 42200202,
"Message": "無可下架賣場",
"IsSuccess": false
}
]
}
Response Elements #
若操作成功,API 會回傳 HTTP 200 response。並以 JSON 格式回傳完整的賣場下架申請結果。
ResponseCode #
顯示賣場下架申請結果的代碼。其代碼與說明請參考「下架申請結果代碼表」。
資料型態: Integer
ResponseMessage #
顯示賣場下架申請結果的訊息。其內容與定義同「下架申請結果代碼表」。
資料型態: String
下架申請結果代碼表 #
| ResponseCode | ResponseMessage | 英文 Message | 描述 |
|---|---|---|---|
| 2201 | 全部成功 | Success | 申請單全部執行成功 |
| 2202 | 部分成功 | PartialSuccess | 申請單部分成功部分失敗 |
| 2203 | 全部失敗 | Fail | 建立申請單發生 Exception |
| 2204 | 超過資料筆數上限 1000 筆 | Max 1000 records | 最多 1000 筆賣場 |
Data #
顯示賣場下架詳細申請結果。Data 的結構分別說明如下:
- GdId:賣場編號
- ErrorCode:錯誤代碼
- Message:錯誤訊息
- IsSuccess:是否申請成功
資料型態: Object Array
GdId #
賣場編號。
資料型態: Integer
ErrorCode #
錯誤代碼。其內容與定義同「賣場下架 ErrorCode」。
資料型態: Integer
Message #
錯誤訊息。其內容與定義同「賣場下架 ErrorCode」。
資料型態: String
賣場下架 ErrorCode #
| ErrorCode | Message | 描述 |
|---|---|---|
| 400 | 未輸入賣場編號 | 請提供 GdIds |
| 42200202 | 無可下架賣場 | 無符合下架條件的賣場 |
| 40900203 | 尚有未結案的申請單 | 上一筆申請尚未結案 |
| 40000204 | 未輸入下架原因 | 請提供 Reason |
| 40000205 | 下架原因為「其他」時需輸入說明 | 缺少說明內容 |
| 40000206 | 未知的下架原因 | Reason 不在可接受項目中 |
| 50000290 | 新增申請單錯誤 | 系統建立申請單失敗 |
| 50000299 | 執行中發生錯誤 | 系統執行時發生例外 |
IsSuccess #
是否申請成功。
資料型態: Boolean