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

    Interface GetBookingListRequest

    Request parameters for get_booking_list

    Use this api to search bookings. You may also filter them by status, if needed.

    interface GetBookingListRequest {
        booking_status?: string | number;
        cursor?: string;
        page_size: number;
        time_from: number;
        time_range_field: string | number;
        time_to: number;
    }
    Index

    Properties

    booking_status?: string | number

    The booking_status filter for retrieving bookings and each one only every request. Available value: READY_TO_SHIP/PROCESSED/SHIPPED/CANCELLED/MATCHED

    cursor?: string

    Specifies the starting entry of data to return in the current call. Default is "". If data is more than one page, the offset can be some entry to start next call.

    page_size: number

    Each result set is returned as a page of entries. Use the "page_size" filters to control the maximum number of entries to retrieve per page (i.e., per call). This integer value is used to specify the maximum number of entries to return in a single "page" of data.The limit of page_size if between 1 and 100.

    time_from: number

    The time_from and time_to fields specify a date range for retrieving bookings (based on the time_range_field). The time_from field is the starting date range. The maximum date range that may be specified with the time_from and time_to fields is 15 days.

    time_range_field: string | number

    The kind of time_from and time_to. Available value: create_time, update_time.

    time_to: number

    The time_from and time_to fields specify a date range for retrieving bookings (based on the time_range_field). The time_from field is the starting date range. The maximum date range that may be specified with the time_from and time_to fields is 15 days.