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

    Interface GetCourierDeliveryTrackingNumberListRequest

    Request parameters for get_courier_delivery_tracking_number_list

    Use this api to get tracking number for courier delivery method.

    interface GetCourierDeliveryTrackingNumberListRequest {
        cursor?: string;
        from_date?: string;
        from_timestamp?: number;
        page_size?: number;
        time_range_type?: number | string & {} | TimeRangeType;
        to_date?: string;
        to_timestamp?: number;
    }
    Index
    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.

    from_date?: string

    The start time of creation time. Format YYYY-MM-DD, in the shop region's local time. Required when from_timestamp and to_timestamp are not passed. Ignored when they are passed.

    from_timestamp?: number

    Start of the query range, Unix timestamp in seconds. Must be passed together with to_timestamp. When passed, from_date and to_date are ignored.

    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. limit [1, 50]

    time_range_type?: number | string & {} | TimeRangeType

    The time field that the query range applies to and that results are sorted by. Available values: create_time, update_time. Defaults to create_time when not passed.

    to_date?: string

    The end time of creation time. Format YYYY-MM-DD, in the shop region's local time. The whole day is included (until 23:59:59). Required when from_timestamp and to_timestamp are not passed. Ignored when they are passed.

    to_timestamp?: number

    End of the query range, Unix timestamp in seconds. Must be passed together with from_timestamp and must not be earlier than from_timestamp.