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

    Interface BindFirstMileTrackingNumberRequest

    Request parameters for bind_first_mile_tracking_number

    Use this api to bind first mile tracking number.

    interface BindFirstMileTrackingNumberRequest {
        first_mile_tracking_number: string;
        height?: number;
        length?: number;
        logistics_channel_id: number;
        order_list: BindFirstMileTrackingNumberOrder[];
        region: string | number;
        shipment_method: string;
        volume?: number;
        warehouse_id?: string;
        warehouse_type?: number;
        weight?: number;
        width?: number;
    }
    Index

    Properties

    first_mile_tracking_number height? length? logistics_channel_id order_list region shipment_method volume? warehouse_id? warehouse_type? weight? width?

    Properties

    first_mile_tracking_number: string

    If using "pickup" or "self_deliver" as the shipment method the "first_mile_tracking_number" field should pass the value generated from v2.first_mile.generate_first_mile_tracking_number.If using "dropoff" as the shipment method the "first_mile_tracking_number" field should pass the tracking number provide by the supplier.

    height?: number

    The height of the parcel.

    length?: number

    The length of the parcel.

    logistics_channel_id: number

    The identity of first-mile logistic channel.If you using "dropoff" or "pickup" as shipment method, please call v2.first_mile.get_channel_list to get the logsitc_channel_id then fill it.If you using "self_deliver"as shipment method then the logistics_channel_id should be "null".

    order_list: BindFirstMileTrackingNumberOrder[]

    The set of ordersn. You can specify up to 50 ordersns in this call.one fm_tn maximum number of total bind orders is 10000.

    region: string | number

    Use this field to specify the region you want to ship parcel.Available value: cn,kr. Please fill in the field according to the region of the Merchant to which the shop belongs.

    shipment_method: string

    The shipment method for bound orders, should be pickup, dropoff or self_deliver.

    volume?: number

    The volume of the parcel.

    warehouse_id?: string

    The identity of transit warehouse address. Retrieved from v2.first_mile.get_transit_warehouse_list.Note: When the first-mile delivery mode is "Drop Off", this field is expected to be a required field. However, to avoid affecting your existing services, this field will be temporarily optional until April 30, 2026. Please complete the integration before then to avoid any impact on your services if it is changed to a required field later.

    warehouse_type?: number

    Warehouse type. Retrieved from v2.first_mile.get_transit_warehouse_list.0 = normal warehouse1 = vendor warehouseNote: When the first-mile delivery mode is "Drop Off", this field is expected to be a required field. However, to avoid affecting your existing services, this field will be temporarily optional until April 30, 2026. Please complete the integration before then to avoid any impact on your services if it is changed to a required field later.

    weight?: number

    The weight of the parcel.

    width?: number

    The width of the parcel.

    Settings

    Member Visibility

    On This Page

    Properties