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

    Interface GetOrderListRequest

    Request parameters for get_order_list

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

    interface GetOrderListRequest {
        cursor?: string;
        logistics_channel_id?: number;
        order_status?: string | number;
        page_size: number;
        request_order_status_pending?: boolean;
        response_optional_fields?: string;
        time_from: number | Date;
        time_range_field: string | number;
        time_to: number | Date;
    }
    Index

    Properties

    cursor? logistics_channel_id? order_status? page_size request_order_status_pending? response_optional_fields? time_from time_range_field time_to

    Properties

    cursor?: string

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

    logistics_channel_id?: number

    The identity of logistic channel. Valid only for BR.

    order_status?: string | number

    The order_status filter for retriveing orders and each one only every request. Available value: UNPAID/READY_TO_SHIP/PROCESSED/SHIPPED/COMPLETED/IN_CANCEL/CANCELLED/INVOICE_PENDING

    page_size

    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.

    request_order_status_pending?: boolean

    Compatible parameter during migration period, send True will let API support PENDING status, send False or don’t send will fallback to old logic.

    response_optional_fields?: string

    Optional fields in response. Available value: order_status.

    time_from: number | Date

    The time_from and time_to fields specify a date range for retrieving orders (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 | Date

    The time_from and time_to fields specify a date range for retrieving orders (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.

    Settings

    Member Visibility

    On This Page

    Properties