Get Showcase
This endpoint used to get existing showcase based on shopID and FSID.
Path
get
/v1/showcase/fs/:fs_id/get?shop_id={{shop_id}}
Request Parameters
Parameter | Type | Required | Location | Description |
---|---|---|---|---|
fs_id | Integer | Required | path | Fulfillment service unique identifier |
shop_id | Integer | Optional | path | Shop unique identifier |
page | Integer | Optional | path | USelect which page to show, default value: 1 |
page_count | Integer | Optional | path | Showcase contained in each page, default value: 10 |
hide_zero | Boolean | Optional | path | Hide showcase if product equal to zero, default value: false |
display | String | Optional | path | To determine which showcase that you want to see. Accepted value: showcase to get user showcases only, group to get group showcases only, all to get both, default value: all |
Example Request
- Curl
curl -X GET \
'https://fs.tokopedia.net/v1/showcase/fs/13004/get?shop_id=479573' \
-H 'Authorization: Bearer avK2WV5pSda4HlxC5mLrFA'
Response Parameters
Name | Type | Demo Value | Description |
---|---|---|---|
showcase | Object Array | ||
showcase_group | Object Array | ||
Boolean | false | ||
Integer Array | [4,5] | ||
String | progamer/v1/shop/showcase?display=all&hide_no_count=false&p=1&take=10 | Previous Showcase URL | |
String | progamer/v1/shop/showcase?display=all&hide_no_count=false&p=2&take=10 | Next Showcase URL |
Success Response Examples
{
"header": {
"process_time": 0.153555533,
"messages": "Your request has been processed successfully"
},
"data": {
"showcase": [
{
"id": 1420235,
"Name": "testshowcase2",
"alias": "testshowcase2",
"uri": "https://staging.tokopedia.com/progamer/etalase/testshowcase2",
"product_count": 0,
"is_highlighted": false,
"badge": "",
"ace_default_sort": 0
}
],
"showcase_group": [
{
"id": 2,
"Name": "Semua Produk",
"alias": "etalase",
"uri": "https://staging.tokopedia.com/progamer",
"product_count": 0,
"is_highlighted": false,
"badge": "",
"ace_default_sort": 0
},
{
"id": 3,
"Name": "Produk Terjual",
"alias": "sold",
"uri": "https://staging.tokopedia.com/progamer/sold?sort=7",
"product_count": 0,
"is_highlighted": false,
"badge": "",
"ace_default_sort": 14
}
],
"use_ace": false,
"showcase_without_ace": [
4,
5
],
"prev_link": "progamer/v1/shop/showcase?display=all&hide_no_count=false&p=1&take=10",
"next_link": "progamer/v1/shop/showcase?display=all&hide_no_count=false&p=2&take=10"
}
}
Error Response Examples
{
"header": {
"process_time": 0.00133305,
"messages": "We could not process your request due to malformed request, please check again",
"reason": "shop_id cannot be empty",
"error_code": "SHW_DLV_003"
},
"data": null
}
Error Codes
Error Code | Error Message | Description |
---|---|---|
SHP_GRPC_001 | Failed Send GRPC Request | Failed sending request to upstream |
SHP_GRPC_002 | There Are Error From Ext Service | Failed getting response from upstream |
SHP_GRPC_003 | Data Not Found | Failed finding data from upstream |
SHP_API_003 | Failed To Fetching Request | Failed fetching response from upstream |
SHP_USC_001 | FS ID is not associated with Shop ID | FS ID is not connected with the Shop ID, please kindly check |
SHP_USC_004 | Shop information is empty | Failed getting shop info, please kindly check |
SHP_DLV_001 | FS ID is not valid | Invalid FS ID, please kindly check |
SHP_DLV_002 | Shop ID is not valid | Invalid Shop ID, please kindly check |
SHP_DLV_003 | Page format is not valid | Invalid Page format, please kindly check |
SHP_DLV_009 | invalid hide_zero format | Invalid hide_zero format, please kindly check |
SHP_DLV_010 | page_count value exceed limit | Invalid page_count value, please kindly check |
SHP_DLV_011 | invalid display value | Invalid display value, please kindly check |
SHP_DLV_012 | fs_id cannot be empty | fs_id is empty, please kindly check |
SHP_DLV_013 | shop_id cannot be empty | shop_id is empty, please kindly check |
SHP_DLV_014 | invalid page_count format | invalid page_count format, please kindly check |