v2.shop.get_shop_info
GET /api/v2/shop/get_shop_info
Use this call to get information of shop
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/shop/get_shop_info
Common Request Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| partner_id | int | 1 | Partner ID is assigned upon registration is successful. Required for all requests. |
| timestamp | timestamp | 1610000000 | This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes. |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours. |
| shop_id | int | 600000 | Shopee's unique identifier for a shop. Required param for most APIs. |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature generated by partner_id, api path, timestamp, access_token, shop_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2 |
No Request Parameters Set.
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| shop_name | string | openapi_pshop_1 | Name of the shop. |
| region | string | TW | Shop's area. |
| status | string | NORMAL | Applicable status: BANNED, FROZEN, NORMAL. |
| sip_affi_shops | object[] | SIP affiliate shops info list.If you request for SIP primary shop,this field will be returned, if you request for SIP affiliate shop,this field won't be returned | |
| affi_shop_id | int64 | Affiliate shop's id. | |
| region | string | Affiliate Shop's area. | |
| is_cb | boolean | true | Use this filed to indicate whether the shop is a cross-border shop. |
| request_id | string | 0b8f39a76e6ada92247b416c768363ee | The identifier for an API request for error tracking. |
| auth_time | timestamp | 1610533441 | The timestamp when the shop was authorized to the partner. |
| expire_time | timestamp | 1642069441 | Use this field to indicate the expiration date for shop authorization. |
| is_sip | boolean | true | This filed will return "true" when SIP primary shop or affiliate shop calls |
| is_upgraded_cbsc | boolean | true | Use this filed to indicate whether this merchant is upgraded to CBSC, including CNSC and KRSC. |
| merchant_id | int64 | 1000000400 | Shopee’s unique identifier for a merchant. If the shop won't under any merchant, then the value will be null. |
| shop_fulfillment_flag | string | PFF - 3PF Shop | Use this field to indicate the fulfillment type of current shop, the applicable values: **- Pure - FBS Shop:**Single mode, refer to Local/CB shops which only have Shopee official warehouse stock, orders are fulfilled by Shopee from Shopee official warehouse; **- Pure - 3PF Shop:**Single mode, refer to CB shops which only have local seller warehouse stock, orders are fulfilled by seller from local seller warehouse via local logistics channels; - PFF - FBS Shop: 1) Hybird mode, refer to Local shops which have both Shopee official warehouse stock and local seller warehouse stock, orders can be fulfilled by Shopee from Shopee official warehouse and can also fulfilled by seller from local seller warehouse via local logistics channels; 2) Hybrid mode, refer to CB shops which have both Shopee official warehouse stock and CB seller warehouse stock, orders can be fulfilled by Shopee from Shopee official warehouse and can also fulfilled by seller from CB seller warehouse via CB logistics channels; **- PFF - 3PF Shop:**Hybrid mode, refer to CB shops which have both local seller warehouse stock and CB seller warehouse stock, orders can be fulfilled by seller from local seller warehouse via local logistics channels and can also fulfilled by seller from CB seller warehouse via CB logistics channels; - LFF Hybrid Shop: Hybrid mode, refer to CB shops which have 3 types of stock: FBS stock (Shopee official warehouse stock), 3PF stock (CB seller own stock in the local market) and CB SLS stock (CB seller own stock in CN/HK/KR); - Others - Unknown: Returned when obtaining shop_fulfillment_flag information fails |
| is_main_shop | boolean | true | Identifies if the current shop is a Local Shop linked to Cross Border Direct Shop. |
| is_direct_shop | boolean | false | Identifies if the current shop is a Cross Border Direct Shop. |
| linked_main_shop_id | int64 | 0 | Returns the Shop ID of the Local Shop linked to the Cross Border Direct Shop. |
| linked_direct_shop_list | object[] | Returns the list of Cross Border Direct Shops linked to the Local Shop. | |
| direct_shop_id | int64 | 223009454 | Shop ID of the Cross Border Direct Shop. |
| direct_shop_region | string | SG | Shop Region of the Cross Border Direct Shop. |
| is_one_awb | boolean | true | Use this filed to indicate if the shop is in 1-AWB whitelist. If is_one_awb return true, please use new AWB size (10cm x 15cm thermal paper) to print AWB. For more details, please refer to: https://open.shopee.com/announcements/1138?category=3&is_top=false |
| is_mart_shop | boolean | false | Indicates whether the current shop is a Mart Shop. |
| is_outlet_shop | boolean | false | Indicates whether the current shop is an Outlet Shop. |
| mart_shop_id | int64 | 1234567890 | (Only returned when requesting an Outlet Shop) Refers to the Mart Shop ID this Outlet belongs to. |
| outlet_shop_info_list | object[] | (Only returned when requesting a Mart Shop) List of Outlet Shop IDs under this Mart Shop. | |
| outlet_shop_id | int64 | 1234567890 | Shop ID of the Outlet Shop. |