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

    Interface UpdateAddressRequest

    Request parameters for update_address

    Use this API to update the address of a shop.

    interface UpdateAddressRequest {
        address?: string;
        address_id: number;
        city?: string;
        district?: string;
        geo_info?: string;
        name?: string;
        phone?: string;
        region?: string;
        state?: string;
        town?: string;
        zipcode?: string;
    }
    Index

    Properties

    address?: 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.

    city?: string

    The city of the address.

    district?: string

    The district of the address.

    geo_info?: string

    Geolocation information for the address. Type: JSON stringNote: 1) To clear existing geo info, pass "" or {}.2) To keep existing geo info, do not include this field.3) The JSON may include optional fields:- formattedAddress (string): full formatted address.- region (object) – contains latitude and longitude as floats.- user_verified (boolean) – whether the geolocation is verified by the user.- user_adjusted (boolean) – whether the geolocation was adjusted by the user.

    name?: string

    Recipient’s name at this address.

    phone?: string

    Contact phone number for the recipient.

    region?: string

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

    state?: string

    The state of the address.

    town?: string

    The town of the address.

    zipcode?: string

    The zipcode of the address.