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

    Interface ShipBookingRequest

    Request parameters for ship_booking

    Use this api to initiate logistics including arrange pickup, dropoff. Should call v2.logistics.get_booking_shipping_parameter to fetch all required param first.

    interface ShipBookingRequest {
        booking_sn: string;
        dropoff?: any;
        pickup?: ShipBookingPickup;
    }
    Index

    Properties

    booking_sn dropoff? pickup?

    Properties

    booking_sn: string

    Shopee's unique identifier for a booking.

    dropoff?: any

    Required parameter ONLY if get_shipping_parameter returns "dropoff" under "info_needed". Developer should still include "dropoff" field in the call even if "dropoff" has empty value. 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.

    pickup?: ShipBookingPickup

    Required parameter ONLY if get_shipping_parameter returns "pickup" under "info_needed". Developer should still include "pickup" field in the call even if "pickup" has empty value.

    Settings

    Member Visibility

    On This Page

    Properties