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

    Interface GetOrderDetailOrder

    GetOrderDetailOrder sub-interface for GetOrderDetailResponseData

    interface GetOrderDetailOrder {
        actual_shipping_fee?: number;
        actual_shipping_fee_confirmed?: boolean;
        advance_package?: boolean;
        affiliate_sample_type?: number;
        booking_sn?: string;
        buyer_cancel_reason?: string;
        buyer_cpf_id?: string;
        buyer_preference_for_partial_cancellation?: number;
        buyer_proof_of_collection?: string[];
        buyer_user_id?: number;
        buyer_username?: string;
        can_full_cancel_order?: boolean;
        can_partial_cancel_order?: boolean;
        cancel_by?: string;
        cancel_reason?: string;
        checkout_shipping_carrier?: string;
        cod?: boolean;
        create_time?: number | Date;
        currency?: string;
        days_to_ship?: number;
        dropshipper?: string;
        dropshipper_phone?: string;
        edt_from?: number | Date;
        edt_to?: number | Date;
        estimated_shipping_fee?: number;
        fulfillment_flag?: string;
        goods_to_declare?: boolean;
        hot_listing_order?: boolean;
        invoice_data?: GetOrderDetailInvoiceData;
        is_buyer_shop_collection?: boolean;
        is_international?: boolean;
        item_list?: GetOrderDetailItem[];
        message_to_seller?: string;
        note?: string;
        note_update_time?: number | Date;
        order_chargeable_weight_gram?: number;
        order_sn?: string;
        order_status?: string;
        package_list?: GetOrderDetailPackage[];
        pay_time?: number | Date;
        payment_info?: GetOrderDetailPaymentInfo[];
        payment_method?: string;
        pending_description?: string[];
        pending_terms?: string[];
        pharmacist_name?: string;
        pickup_done_time?: number | Date;
        prescription_approval_time?: number | Date;
        prescription_check_status?: number;
        prescription_images?: string | number;
        prescription_reject_reason?: string;
        prescription_rejection_time?: number | Date;
        recipient_address?: GetOrderDetailRecipientAddress;
        region?: string;
        return_request_due_date?: number | Date;
        reverse_shipping_fee?: number;
        ship_by_date?: number | Date;
        shipping_carrier?: string;
        split_up?: boolean;
        total_amount?: number;
        update_time?: number | Date;
    }
    Index

    Properties

    actual_shipping_fee?: number

    The actual shipping fee of the order if available from external logistics partners.

    actual_shipping_fee_confirmed?: boolean

    Use this filed to judge whether the actual_shipping_fee is confirmed.

    advance_package?: boolean

    Indicate whether order will be fulfilled using advance fulfilment stock or not. If value is true, order will be matched with a booking and seller should not arrange shipment.

    affiliate_sample_type?: number

    Indicates that this order is a refundable sample order. Applicable values:0 = Order is not a refundable sample order1 = Order is a refundable sample order

    booking_sn?: string

    Return by default. Shopee's unique identifier for a booking.Only returned for advance fulfilment matched order only.

    buyer_cancel_reason?: string

    Cancel reason from buyer, could be empty.

    buyer_cpf_id?: string

    Buyer's CPF number for taxation and invoice purposes. Only for Brazil order.

    buyer_preference_for_partial_cancellation?: number

    Indicates the buyer’s preference for handling out-of-stock items in the order. Applicable values:0 = Ship Available Items Only (The buyer allows the seller to cancel unavailable items and continue shipping the remaining available items)1 = Cancel The Entire Order (The buyer does not allow partial cancellation. If any item is unavailable, the seller should cancel the entire order instead)

    buyer_proof_of_collection?: string[]

    The image url of the buyer self collection at the store.

    buyer_user_id?: number

    The user id of buyer of this order, will be empty if it is a non-integrated order in TW region.

    buyer_username?: string

    The name of buyer, will be masked as "****" if it is a non-integrated order in TW region.

    can_full_cancel_order?: boolean

    Indicates whether the order can be full cancelled: - If this value is true, seller can cancel the entire order- If the value is false, full order cancellation is not available for the order

    can_partial_cancel_order?: boolean

    Indicates whether the order is eligible for partial cancellation. This value is determined by both the system eligibility check and the buyer’s out-of-stock handling preference. - If this value is true, seller can cancel selected out-of-stock item quantities while continuing to fulfill the remaining items. - If this value is false, partial cancellation is not allowed.

    cancel_by?: string

    Could be one of buyer, seller, system or Ops.

    cancel_reason?: string

    Use this field to get reason for buyer, seller, and system cancellation.

    checkout_shipping_carrier?: string

    For non masking order, the logistics service provider that the buyer selected for the order to deliver items. For masking order, the logistics service type that the buyer selected for the order to deliver items.

    cod?: boolean

    Return by default. This value indicates whether the order was a COD (cash on delivery) order.

    create_time?: number | Date

    Return by default. Timestamp that indicates the date and time that the order was created.

    currency?: string

    Return by default. The three-digit code representing the currency unit for which the order was paid.

    days_to_ship?: number

    Return by default. Shipping preparation time set by the seller when listing item on Shopee.

    dropshipper?: string

    For Indonesia orders only. The name of the dropshipper.

    dropshipper_phone?: string

    The phone number of dropshipper, could be empty.

    edt_from?: number | Date

    Earliest estimated delivery date of orders (only available for BR region)

    edt_to?: number | Date

    Latest estimated delivery time of orders (only available for BR region)

    estimated_shipping_fee?: number

    The estimated shipping fee is an estimation calculated by Shopee based on specific logistics courier's standard.

    fulfillment_flag?: string

    Use this field to indicate the order is fulfilled by shopee or seller. Applicable values: fulfilled_by_shopee, fulfilled_by_cb_seller, fulfilled_by_local_seller.

    goods_to_declare?: boolean

    Only work for cross-border order.This value indicates whether the order contains goods that are required to declare at customs. "T" means true and it will mark as "T" on the shipping label; "F" means false and it will mark as "P" on the shipping label. This value is accurate ONLY AFTER the order trackingNo is generated, please capture this value AFTER your retrieve the trackingNo.

    hot_listing_order?: boolean

    [Only for PH,TH,VN,MY,BR,TW] True if the order includes hot listing item.

    The invoice data of the order.

    is_buyer_shop_collection?: boolean

    To indicate if this order is buyer self collection at store order

    is_international?: boolean

    [Only for BR] Indicate if the order is SIP order. This field will only be returned if international_label is included in response_optional_field in the request.

    item_list?: GetOrderDetailItem[]

    This object contains the detailed breakdown for the result of this API call.

    message_to_seller?: string

    Return by default. Message to seller.

    note?: string

    The note seller made for own reference.

    note_update_time?: number | Date

    Update time for the note.

    order_chargeable_weight_gram?: number

    display weight used to calculate ASF for this order

    order_sn?: string

    Return by default. Shopee's unique identifier for an order.

    order_status?: string

    Return by default. Enumerated type that defines the current status of the order.

    package_list?: GetOrderDetailPackage[]

    The list of package under an order

    pay_time?: number | Date

    The time when the order status is updated from UNPAID to PAID. This value is NULL when order is not paid yet.

    payment_info?: GetOrderDetailPaymentInfo[]

    [Only for BR] List of payment information, to follow NT 2025.001 (BR government invoice rules).

    payment_method?: string

    The payment method that the buyer selected to pay for the order. Applicable values: See Data Definition- Payment Methods.

    pending_description?: string[]

    The value of this field is the description of pending reason corresponding with pending terms. Applicable values: - For SYSTEM_PENDING: Order is being processed by Shopee.- For KYC_PENDING: Order is pending buyer TW KYC pre-authorization.- For ARRANGE_SHIPMENT_PENDING: Allocating delivery resources due to high order volume. Label print will be available within 4 days after buyer paid.

    pending_terms?: string[]

    The list of pending terms. Applicable values:- SYSTEM_PENDING: Under Shopee internal processing.- KYC_PENDING: Under KYC checking (TW CB order only).- ARRANGE_SHIPMENT_PENDING: Temporarily held due to 3PL capacity constraints.

    pharmacist_name?: string

    Name of the Pharmacist for Prescription Order.

    pickup_done_time?: number | Date

    The timestamp when pickup is done.

    prescription_approval_time?: number | Date

    Time of when the prescription is approved.

    prescription_check_status?: number

    Prescription check status. For ID, PH whitelisted sellers, the applicable values:0: NONE1: PASSED2: FAILEDFor TH whitelisted sellers, the applicable values:0: NONE1: PASSED

    prescription_images?: string | number

    Return prescription images of this order, only for ID and PH whitelist sellers.Please add the prefix to review:for ID: https://cf.shopee.co.id/file/+prescription_imagefor PH:https://cf.shopee.ph/file/+prescription_image

    prescription_reject_reason?: string

    Return the reason why a prescription is rejected. If there is no rejection reason, return empty.Only for ID and PH whitelist sellers

    prescription_rejection_time?: number | Date

    Time of when the prescription is rejected.

    recipient_address?: GetOrderDetailRecipientAddress

    This object contains detailed breakdown for the recipient address.Different parameters might be masked according to each market and kind of seller.For TW region integrated channel orders will be all masked as "****". More details may refer the announcement.

    region?: string

    Return by default. The two-digit code representing the region where the order was made.

    return_request_due_date?: number | Date

    This field represents the deadline for buyers to initiate returns and refunds after order is completed.The “return_request_due_date” response parameter will be returned if the requested order meets ALL the conditions below:- The status of the order is COMPLETED- The return refund eligibility of the order is trueIf you have any questions related to the function of "returns and refunds after order is completed," please refer to the following link: https://seller.shopee.tw/edu/article/18474

    reverse_shipping_fee?: number

    Shopee charges the reverse shipping fee for the returned order.The value of this field will be non-negative.

    ship_by_date?: number | Date

    Return by default. The deadline to ship out the parcel.

    shipping_carrier?: string

    The logistics service provider that the buyer selected for the order to deliver items. Note: If logistics_channel_id is 90021, 90025 or 90026, service_code will be appended, e.g., Entrega Turbo - M1020.

    split_up?: boolean

    To indicate whether this order is split to fullfil order(forder) level. Call GetForderInfo if it's "true".

    total_amount?: number

    The total amount paid by the buyer for the order. This amount includes the total sale price of items, shipping cost beared by buyer; and offset by Shopee promotions if applicable. This value will only return after the buyer has completed payment for the order.

    update_time?: number | Date

    Return by default. Timestamp that indicates the last time that there was a change in value of order, such as order status changed from 'Paid' to 'Completed'.