消費者市場：韓國、台灣
以分頁方式查詢產品清單。
通路
GET
/v2/providers/seller_api/apis/api/v1/marketplace/seller-products
請求範例端點
https://api-gateway.coupang.com/v2/providers/seller_api/apis/api/v1/marketplace/seller-products?vendorId={vendorId}&nextToken={nextToken}&maxPerPage={maxPerSize}&sellerProductId={sellerProductId}&sellerProductName={sellerProductName}&status={status}&manufacture={manufacture}&createdAt={createdAt}&violationTypes=ATTR&violationTypes=MOTA_V2&violationTypeAndOr=OR
參數需求
主體參數
| Name | Required | Type | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| vendorId | O | String | 賣家ID 由 Coupang 發行給 Vendor 的唯一代碼 ex) A00012345 | ||||||||||||||||||||
| nextToken | Number | 用於呼叫下一頁的 Key 值. 不需輸入，或輸入「1」即可查詢第一頁 | |||||||||||||||||||||
| maxPerPage | Number | 每頁顯示結果數量 預設值：10，最大值：100 | |||||||||||||||||||||
| sellerProductId | Number | 賣家商品 ID (已上架商品 ID) | |||||||||||||||||||||
| sellerProductName | String | 賣家商品名稱 搜尋已上架商品名稱，限 20 個字 | |||||||||||||||||||||
| status | String | 外部供應商商品狀態
| |||||||||||||||||||||
| manufacture | String | 製造商 | |||||||||||||||||||||
| createdAt | String | 商品上架日期/時間 格式： 範例：輸入 "2015-12-17" 可查詢當天全時段 (00:00:00 ~ 23:59:59) | |||||||||||||||||||||
| ViolationTypeSearchField | List | 違規類型搜尋欄位： 1. 2. 3. | |||||||||||||||||||||
| ViolationTypeAndOr | String | 當 "ViolationTypeSearchField" 輸入超過 2 個參數時，此欄位為必填。 可選值：
| |||||||||||||||||||||
請求範例
不需要請求主體
回應訊息
| 欄位名稱 | 類型 | 說明 | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| code | Number | 結果代碼 SUCCESS/ERROR | ||||||||||||||||||||
| message | String | 結果訊息 (描述執行狀況) | ||||||||||||||||||||
| nextToken | String | 下一頁標記：若無下一頁則回傳空字串 (Null string) | ||||||||||||||||||||
| data | Array | |||||||||||||||||||||
| sellerProductId | String | 賣家商品 ID | ||||||||||||||||||||
| sellerProductName | String | 賣家商品名稱 | ||||||||||||||||||||
| displayCategoryCode | Number | 顯示類目代碼 | ||||||||||||||||||||
| categoryId | Number | 類目ID | ||||||||||||||||||||
| productId | Number | 商品ID | ||||||||||||||||||||
| vendorId | String | 賣家ID | ||||||||||||||||||||
| saleStartedAt | String | 販售開始時間 (格式：yyyy-MM-ddTHH:mm:ss) | ||||||||||||||||||||
| saleEndedAt | String | 販售結束時間 (格式：yyyy-MM-ddTHH:mm:ss) | ||||||||||||||||||||
| brand | String | 品牌名稱 | ||||||||||||||||||||
| statusName | String | 已上架商品狀態
| ||||||||||||||||||||
| createdAt | String | 商品上架日期/時間 (格式：yyyy-MM-ddTHH:mm:ss) | ||||||||||||||||||||
Response Example
{
"code": "SUCCESS",
"message": "",
"nextToken": "2",
"data": [
{
"sellerProductId": 239092172,
"sellerProductName": "R07 헬로키티 미니낚시놀이",
"displayCategoryCode": 77413,
"categoryId": 2102,
"productId": 14784194,
"vendorId": "XXXXXXXX",
"mdId": "harry867@",
"mdName": null,
"saleStartedAt": "2017-02-14T06:00:00",
"saleEndedAt": "2099-12-31T00:00:00",
"brand": "상세설명별도참조",
"statusName": "승인완료",
"createdAt": "2017-02-13T02:09:47"
},
{
"sellerProductId": 239092161,
"sellerProductName": "R07 러닝리소스 손가락 지시봉 (10개 세트) (LER2657) - 러닝리소스 지시봉 손가락 포인터 장난감",
"displayCategoryCode": 77413,
"categoryId": 2102,
"productId": 14784126,
"vendorId": "XXXXXXXX",
"mdId": "harry867@",
"mdName": null,
"saleStartedAt": "2017-02-14T06:00:00",
"saleEndedAt": "2099-12-31T00:00:00",
"brand": "상세설명별도참조",
"statusName": "승인완료",
"createdAt": "2017-02-13T02:09:46"
}
]
}錯誤規格
| HTTP 狀態碼 (錯誤類型) | 錯誤訊息 (Error message) | 解決方法 |
|---|---|---|
| 400 (檢查請求參數) | 必須輸入供應商代碼 | 請檢查賣家 ID (vendorId) 是否正確。 |
| 400 (檢查請求參數) | createdAt 格式應為 yyyy-MM-dd | 請檢查商品上架日期/時間 (createdAt) 的格式：必須為 "yyyy-MM-dd"。 |
URL API Name
GET_PRODUCTS_BY_QUERY