GET
/v2/providers/seller_api/apis/api/v1/marketplace/seller-products2609170000產品清單分頁查詢
# 01
簡介
產品清單分頁查詢
# 02
詳細內容
消費者市場:韓國、台灣
以分頁方式查詢產品清單。
路徑
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=ORURL API Name
GET_PRODUCTS_BY_QUERY
# 03
Query 參數
| Name | Type | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| vendorId* | 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 | 商品上架日期/時間 格式: yyyy-MM-dd範例:輸入 "2015-12-17" 可查詢當天全時段 (00:00:00 ~ 23:59:59) | ||||||||||||||||
| ViolationTypeSearchField | array | 違規類型搜尋欄位:
| ||||||||||||||||
| ViolationTypeAndOr | string | 當 "ViolationTypeSearchField" 輸入超過 2 個參數時,此欄位為必填。 可選值:
|
# 04
回應內容
回應訊息
| Name | Type | Description |
|---|---|---|
| code | string | 結果代碼 SUCCESS/ERROR |
| message | string | 結果訊息 (描述執行狀況)
|
| nextToken | string | 下一頁標記:若無下一頁則回傳空字串 (Null string)
|
| data | object[] | |
| sellerProductId data[].sellerProductId | integer | 賣家商品 ID
|
| sellerProductName data[].sellerProductName | string | 賣家商品名稱
|
| displayCategoryCode data[].displayCategoryCode | integer | 顯示類目代碼
|
| categoryId data[].categoryId | integer | 類目ID
|
| productId data[].productId | integer | 商品ID
|
| vendorId data[].vendorId | string | 賣家ID
|
| saleStartedAt data[].saleStartedAt | string | 販售開始時間 (格式: yyyy-MM-ddTHH:mm:ss)
|
| saleEndedAt data[].saleEndedAt | string | 販售結束時間 (格式: yyyy-MM-ddTHH:mm:ss)
|
| brand data[].brand | string | 品牌名稱
|
| statusName data[].statusName | string | 已上架商品狀態 | |
| createdAt data[].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"
}
]
}# 05
錯誤碼
| HTTP | 代碼 | 訊息 |
|---|---|---|
| 400 | HTTP_400 | Bad Request |
錯誤說明
| HTTP | 類型 | 錯誤訊息 | 解決方案 |
|---|---|---|---|
| 400 | 400 (檢查請求參數) | 必須輸入供應商代碼 | 請檢查賣家 ID (vendorId) 是否正確。 |
| 400 | 400 (檢查請求參數) | createdAt 格式應為 | 請檢查商品上架日期/時間 (createdAt) 的格式:必須為 "yyyy-MM-dd"。 |