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

    Interface MassShipOrderRequest

    Request parameters for mass_ship_order

    Use this api to initiate logistics including arrange pickup, dropoff or shipment for non-integrated logistic channels. Should call v2.logistics.get_mass_shipping_parameter to fetch all required params first. It's recommended to initiate logistics one hour after the orders were placed since there is one-hour window buyer can cancel any order without request to seller. The API can only batch arrange shipment for multiple packages under the same product_location_id and same logistics_channel_id.

    interface MassShipOrderRequest {
        dropoff?: MassShipOrderDropoff;
        logistics_channel_id?: number;
        non_integrated?: MassShipOrderNonIntegrated;
        package_list: MassShipOrderPackage[];
        pickup?: MassShipOrderPickup;
        product_location_id?: string;
    }
    Index

    Properties

    dropoff? logistics_channel_id? non_integrated? package_list pickup? product_location_id?

    Properties

    dropoff?: MassShipOrderDropoff

    Required parameter ONLY if GetParameterForInit returns "dropoff" or if GetLogisticsInfo returns "dropoff" under "info_needed" for the same order. Developer should still include "dropoff" field in the call even if "dropoff" has empty value. For logistic_id 80003 and 80004, both Regular and JOB shipping methods are supported. If you choose Regular shipping method, please use "tracking_no" to call Init API. If you choose JOB shipping method, please use "sender_real_name" to call Init API. Note that only one of "tracking_no" and "sender_real_name" can be selected.

    logistics_channel_id?: number

    The API can only batch arrange shipment for multiple packages under the same product_location_id and same logistics_channel_id. Use this field to specify the logistics_channel_id for the request. If not specified, will use the logistics_channel_id corresponds to the first package_number by default.

    non_integrated?: MassShipOrderNonIntegrated

    Optional parameter when get_mass_shipping_parameter returns "non-integrated" under "info_needed".

    package_list: MassShipOrderPackage[]

    The list of packages you want to arrange shipment. limit [1, 50].

    pickup?: MassShipOrderPickup

    Required parameter ONLY if GetParameterForInit returns "pickup" or if GetLogisticsInfo returns "pickup" under "info_needed" for the same order. Developer should still include "pickup" field in the call even if "pickup" has empty value.

    product_location_id?: string

    The API can only batch arrange shipment for multiple packages under the same product_location_id and same logistics_channel_id. Use this field to specify the product_location_id for the request. If not specified, will use the product_location_id corresponds to the first package_number by default.

    Settings

    Member Visibility

    On This Page

    Properties