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

    Interface GetAccessTokenResponseData

    Response data payload for get_access_token

    interface GetAccessTokenResponseData {
        access_token?: string;
        expire_in?: number | Date;
        merchant_id_list?: number[];
        principal_id_list?: number[];
        refresh_token?: string;
        shop_id_list?: number[];
        supplier_id_list?: number[];
        user_id_list?: number[];
    }
    Index

    Properties

    access_token?: string

    Returned when the API call is successful. A dynamic token that can be used multiple times and expires after 4 hours.

    expire_in?: number | Date

    Returned when the API call is successful. The validity period of the access_token, in seconds.

    merchant_id_list?: number[]

    Returned all merchant_ids authorized this time.

    principal_id_list?: number[]

    If the authorized role is principal administrator, return all principal_id under this authorization.

    refresh_token?: string

    Returned when the API call is successful. Use refresh_token to get a new access_token. Valid for each shop_id, merchant_id, supplier_id, or user_id respectively, for 30 days.

    shop_id_list?: number[]

    Returned all shop_ids authorized this time.

    supplier_id_list?: number[]

    Returned all supplier_ids authorized this time.

    user_id_list?: number[]

    Returned all user_ids authorized this time.