Shopee SDK API Reference - v2.8.0
    Preparing search index...

    Interface GetShopInfoResponseData

    Response data payload for get_shop_info

    interface GetShopInfoResponseData {
        auth_time?: number | Date;
        expire_time?: number | Date;
        is_cb?: boolean;
        is_direct_shop?: boolean;
        is_main_shop?: boolean;
        is_mart_shop?: boolean;
        is_one_awb?: boolean;
        is_outlet_shop?: boolean;
        is_sip?: boolean;
        is_upgraded_cbsc?: boolean;
        linked_direct_shop_list?: GetShopInfoLinkedDirectShop[];
        linked_main_shop_id?: number;
        mart_outlet_structure_type?: string;
        mart_shop_id?: number;
        merchant_id?: number;
        outlet_shop_info_list?: GetShopInfoOutletShopInfo[];
        region?: string;
        shop_fulfillment_flag?: string | number;
        shop_name?: string;
        sip_affi_shops?: GetShopInfoSipAffiShop[];
        status?: string;
    }
    Index

    Properties

    auth_time? expire_time? is_cb? is_direct_shop? is_main_shop? is_mart_shop? is_one_awb? is_outlet_shop? is_sip? is_upgraded_cbsc? linked_direct_shop_list? linked_main_shop_id? mart_outlet_structure_type? mart_shop_id? merchant_id? outlet_shop_info_list? region? shop_fulfillment_flag? shop_name? sip_affi_shops? status?

    Properties

    auth_time?: number | Date

    The timestamp when the shop was authorized to the partner.

    expire_time?: number | Date

    Use this field to indicate the expiration date for shop authorization.

    is_cb?: boolean

    Use this filed to indicate whether the shop is a cross-border shop.

    is_direct_shop?: boolean

    Identifies if the current shop is a Cross Border Direct Shop.

    is_main_shop?: boolean

    Identifies if the current shop is a Local Shop linked to Cross Border Direct Shop.

    is_mart_shop?: boolean

    Indicates whether the current shop is a Mart Shop.

    is_one_awb?: boolean

    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_outlet_shop?: boolean

    Indicates whether the current shop is an Outlet Shop.

    is_sip?: boolean

    This filed will return "true" when SIP primary shop or affiliate shop calls

    is_upgraded_cbsc?: boolean

    Use this filed to indicate whether this merchant is upgraded to CBSC, including CNSC and KRSC.

    linked_direct_shop_list?: GetShopInfoLinkedDirectShop[]

    Returns the list of Cross Border Direct Shops linked to the Local Shop.

    linked_main_shop_id?: number

    Returns the Shop ID of the Local Shop linked to the Cross Border Direct Shop.

    mart_outlet_structure_type?: string

    (Only returned when requesting a Mart or Outlet Shop)Indicates the structure type of the Mart or Outlet shop. Applicable values are: normal_mart_shop, warehouse_mart_shop, normal_outlet_shop, warehouse_outlet_shop

    mart_shop_id?: number

    (Only returned when requesting an Outlet Shop) Refers to the Mart Shop ID this Outlet belongs to.

    merchant_id?: number

    Shopee’s unique identifier for a merchant. If the shop won't under any merchant, then the value will be null.

    outlet_shop_info_list?: GetShopInfoOutletShopInfo[]

    (Only returned when requesting a Mart Shop) List of Outlet Shop IDs under this Mart Shop.

    region?: string

    Shop's area.

    shop_fulfillment_flag?: string | number

    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

    shop_name?: string

    Name of the shop.

    sip_affi_shops?: GetShopInfoSipAffiShop[]

    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

    status?: string

    Applicable status: BANNED, FROZEN, NORMAL.

    Settings

    Member Visibility

    On This Page

    Properties