商品主檔查詢 #

查詢所有賣場商品資料 #

查詢Master Data，取得該供應商所有賣場商品資料。

Endpoint URL: https://tw.scm.yahooapis.com/scmapi/api/Supplier/GetSupplierProduct
HTTP Method: POST

Request Body #

ProductDateStart #

商品建立時間 (起)。
資料型態: dateTime
必填: 是
說明: 時間格式為

yyyy-mm-ddThh:mm:ss
ex. 2024-01-20T00:00:00

ProductDateEnd #

商品建立時間 (迄)。
資料型態: dateTime
必填: 是
說明: 時間格式為

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

QueryType #

查詢條件。
資料型態: String
必填: 是
說明:

All (所有賣場)
OnList (上架中賣場)
OffList (已下架賣場)

CallbackURL #

回呼函式。
資料型態: String
必填: 是
說明:

CallbackURL會回傳商品主檔檔案下載位址。
商品建立時間ProductDate與查詢條件QueryType會取交集查出，而贈品會無視條件查詢出全部贈品。

Request/Response Sample #

POST Request

POST /scmapi/api/Supplier/GetSupplierProduct

{
    "ProductDateStart": "2024-05-10T15:46:32",
    "ProductDateEnd": "2024-07-12T15:46:32",
    "QueryType": "OnList",
    //此為範例，請依照實際開發的CallbackURL代替
    "CallbackURL": "https://XXXX/listingapicallback.ashx"
}

POST Response

{
    "ReturnCode": "00000",
    "ReturnMessage": "成功"
}

Response Elements #

若操作成功，API 會回傳 HTTP 200 response。並透過CallbackURL回傳商品主檔檔案下載位址。

ReturnCode #

回傳碼。
資料型態: String

ReturnMessage #

回傳訊息。
資料型態: String

CallbackURL 說明 #

CallbackURL 會需要您準備一個可以接收回傳資訊的站台，且需要讓Y!購SCM API可以存取得到的網址，回傳的內容會有RecordCount(資料筆數)、FileCount(檔案筆數)、FileList(檔案清單)這三個欄位

在FileList(檔案清單) 裡，會有商品清單下載網址，回傳範例如下：
2024/5/28 下午 12:05:32 {"RecordCount":42350,"FileCount":2,"FileList":["https://xxx.xxx.xxx/xxx/4866-20240528-1--1730531027.csv","https://xxx.xxx.xxx/xxx/4866-20240528-6-1407814964.csv"],"ErrorMessage":null}

範例程式下載點：
https://goo.gl/CE3uar