商品上下架作業 #

賣場上架 #

• 此功能提供供應商申請賣場上架。呼叫此 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/ApplyGdOn
HTTP Method: POST

Request Body #

GdIds #

賣場編號。
資料型態: Integer Array
必填: 是
說明: 輸入賣場編號陣列，最多支援1000筆資料。

• ex. [3480693, 3480691, 3480287]

StartDate #

賣場開始時間。
資料型態: dateTime
必填: 是
說明: 賣場開始時間需大於現在時間，時間格式為

• yyyy-mm-ddThh:mm:ss
• ex. 2024-01-25T23:59:59

EndDate #

賣場結束時間（不用包含時間，上架後結束時間將固定為設定日期的00時00分）。
資料型態: dateTime
必填: 是
說明: 賣場結束時間需大於賣場開始時間，時間格式為

• yyyy-mm-dd
• ex. 2024-06-25
• 實際結束時間將被設定為 2024-06-25 00:00:00

CauseNote #

申請上架說明。
資料型態: String
必填: 否

Request/Response Sample #

{
    "GdIds": [3480693, 3480691, 3480287, 5480287],
    "StartDate": "2025-11-26T18:00:00",
    "EndDate": "2026-10-28",
    "CauseNote": "重新上架"
}

{
    "ResponseCode": 2202,
    "ResponseMessage": "部分成功",
    "Data": [
        {
            "GdId": 3480693,
            "ErrorCode": 0,
            "Message": null,
            "IsSuccess": true
        },
        {
            "GdId": 3480691,
            "ErrorCode": 0,
            "Message": null,
            "IsSuccess": true
        },
        {
            "GdId": 3480287,
            "ErrorCode": 42200102,
            "Message": "無可上架賣場",
            "IsSuccess": false
        },
        {
            "GdId": 5480287,
            "ErrorCode": 42200102,
            "Message": "無可上架賣場",
            "IsSuccess": false
        }
    ]
}

Response Elements #

若操作成功，API 會回傳 HTTP 200 response。並以 JSON 格式回傳完整的賣場上架申請結果。

ResponseCode #

顯示賣場上架申請結果的代碼。其代碼與說明請參考「上架申請結果代碼表」。
資料型態: Integer

ResponseMessage #

顯示賣場上架申請結果的訊息。其內容與定義同「上架申請結果代碼表」。
資料型態: String

上架申請結果代碼表 #

Data #

顯示賣場上架詳細申請結果。Data 的結構分別說明如下：

• GdId：賣場編號
• ErrorCode：錯誤代碼
• Message：錯誤訊息
• IsSuccess：是否申請成功

資料型態: Object Array

GdId #

賣場編號。
資料型態: Integer

ErrorCode #

錯誤代碼。其內容與定義同「賣場上架 ErrorCode」。
資料型態: Integer

Message #

錯誤訊息。其內容與定義同「賣場上架 ErrorCode」。
資料型態: String

賣場上架 ErrorCode #

IsSuccess #

是否申請成功。
資料型態: Boolean