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

    Type Alias UpdateAddressParams

    UpdateAddressParams: {
        address?: string;
        address_id: number;
        city?: string;
        district?: string;
        geo_info?: string;
        name?: string;
        phone?: string;
        region?: string;
        state?: string;
        town?: string;
        zipcode?: string;
    } & Record<string, string | number | boolean | object | null | undefined>

    Parameters for update address

    Type Declaration

    • Optionaladdress?: string

      The detailed address description of the address.

    • address_id: number

      Unique identifier for the address. You can get the address_id via v2.logistics.get_address_list.

    • Optionalcity?: string

      The city of the address.

    • Optionaldistrict?: string

      The district of the address.

    • Optionalgeo_info?: string

      Geolocation information for the address. Type: JSON string. To clear existing geo info, pass "" or {}. To keep existing geo info, do not include this field.

    • Optionalname?: string

      Recipient's name at this address.

    • Optionalphone?: string

      Contact phone number for the recipient.

    • Optionalregion?: string

      The region of the address. Note: Do not allow to update the region of the address.

    • Optionalstate?: string

      The state of the address.

    • Optionaltown?: string

      The town of the address.

    • Optionalzipcode?: string

      The zipcode of the address.