Shopee SDK API Reference - v1.11.0
    Preparing search index...

    Type Alias GetShopInfoResponse

    GetShopInfoResponse: BaseResponse & {
        auth_time: number;
        expire_time: number;
        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?: LinkedDirectShop[];
        linked_main_shop_id?: number;
        mart_shop_id?: number;
        merchant_id?: number;
        outlet_shop_info_list?: OutletShopInfo[];
        region: string;
        shop_fulfillment_flag?: string;
        shop_name: string;
        sip_affi_shops?: SipAffiShop[];
        status: string;
    }

    Response for getting shop information

    Type Declaration

    • auth_time: number

      The timestamp when the shop was authorized to the partner

    • expire_time: number

      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

    • Optionalis_direct_shop?: boolean

      Identifies if the current shop is a Cross Border Direct Shop

    • Optionalis_main_shop?: boolean

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

    • Optionalis_mart_shop?: boolean

      Indicates whether the current shop is a Mart Shop

    • Optionalis_one_awb?: boolean

      Use this filed to indicate if the shop is in 1-AWB whitelist

    • Optionalis_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

    • Optionalis_upgraded_cbsc?: boolean

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

    • Optionallinked_direct_shop_list?: LinkedDirectShop[]

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

    • Optionallinked_main_shop_id?: number

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

    • Optionalmart_shop_id?: number

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

    • Optionalmerchant_id?: number

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

    • Optionaloutlet_shop_info_list?: OutletShopInfo[]

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

    • region: string

      Shop's area

    • Optionalshop_fulfillment_flag?: string

      Use this field to indicate the fulfillment type of current shop

    • shop_name: string

      Name of the shop

    • Optionalsip_affi_shops?: SipAffiShop[]

      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