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

    Interface GetChannelListLogisticsChannel

    GetChannelListLogisticsChannel sub-interface for GetChannelListResponseData

    interface GetChannelListLogisticsChannel {
        auto_call_driver_setting?: GetChannelListAutoCallDriverSetting;
        block_seller_cover_shipping_fee?: boolean;
        channel_relation_rules?: GetChannelListChannelRelationRule[];
        cod_enabled?: boolean;
        compulsory_channel?: boolean;
        enabled?: boolean;
        fee_type?: string;
        force_enable?: boolean;
        item_max_dimension?: GetChannelListItemMaxDimension;
        logistics_capability?: GetChannelListLogisticsCapability;
        logistics_channel_id?: number;
        logistics_channel_name?: string;
        logistics_description?: string;
        mask_channel_id?: number;
        preprint?: boolean;
        seller_logistic_has_configuration?: boolean;
        service_type_identifier?: string;
        size_list?: GetChannelListSize[];
        support_cross_border?: boolean;
        support_pause?: boolean;
        volume_limit?: GetChannelListVolumeLimit;
        weight_limit?: GetChannelListWeightLimit;
    }
    Index

    Properties

    auto_call_driver_setting? block_seller_cover_shipping_fee? channel_relation_rules? cod_enabled? compulsory_channel? enabled? fee_type? force_enable? item_max_dimension? logistics_capability? logistics_channel_id? logistics_channel_name? logistics_description? mask_channel_id? preprint? seller_logistic_has_configuration? service_type_identifier? size_list? support_cross_border? support_pause? volume_limit? weight_limit?

    Properties

    auto_call_driver_setting?: GetChannelListAutoCallDriverSetting
    block_seller_cover_shipping_fee?: boolean

    Indicate whether the channel is blocked to use seller cover shipping fee function.if the channel does not allow sellers to cover shipping fee, then the block_seller_cover_shipping_fee field will return true, otherwise it will return false.

    channel_relation_rules?: GetChannelListChannelRelationRule[]

    Indicate the related rules & channels of this logistic channel.

    cod_enabled?: boolean

    This is to indicate whether this logistic channel supports COD

    compulsory_channel?: boolean

    Indicates if the channel is compulsory. If the value is true, at least one such channel must be enabled.

    enabled?: boolean

    Whether this logistic channel is enabled on shop level.

    fee_type?: string

    SIZE_SELECTIONSIZE_INPUTFIXED_DEFAULT_PRICECUSTOM_PRICE

    force_enable?: boolean

    Indicates whether the logistic channel is force enabled on Shop Level. If true, sellers cannot close this channel.

    item_max_dimension?: GetChannelListItemMaxDimension

    The dimension limit for this logistic channel.

    logistics_capability?: GetChannelListLogisticsCapability

    The capability of one logistic channel.

    logistics_channel_id?: number

    The identity of logistic channel.

    logistics_channel_name?: string

    The name of logistic channel.

    logistics_description?: string

    For checkout channels, this field indicates its corresponding fulfillment channels.

    mask_channel_id?: number

    Indicate the parent logistic channel ID. If it’s 0, it indicates the channel is a checkout(masked) channel; if it’s not 0, indicate the channel is a fulfillment channel and has a checkout channel(checkout channel’s channel_id equals this mask_channel_id) on top of it. Multiple channels may share the same mask_channel_id.

    preprint?: boolean

    Indicate whether this channel support pre-print AWB

    seller_logistic_has_configuration?: boolean

    Indicate If seller has set the Seller logistics configuration if set will return true, otherwise it will return false or null.

    service_type_identifier?: string

    This parameter specifies the delivery service type of logistics channel. Applicable values: - instant- same_day- null

    size_list?: GetChannelListSize[]

    Only for fee_type is SIZE_SELECTION

    support_cross_border?: boolean

    Indicate whether this channel support cross border shipping.

    support_pause?: boolean

    Indicates whether this channel supports the pause operation (Pausing allows the shop to temporarily prevent buyers from placing orders through this logistics channel).- true: This channel is affected by the pause function.- false: This channel is not affected by the pause function.Note: Please first call v2.logistics.get_pause_status to get the current pause status of logistics channels under the shop. If is_paused = true, then call v2.logistics.get_channel_list and identify the range of channels affected by the pause function through support_pause = true.

    volume_limit?: GetChannelListVolumeLimit

    The limit of item volume.

    weight_limit?: GetChannelListWeightLimit

    The weight limit for this logistic channel.

    Settings

    Member Visibility

    On This Page

    Properties