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

    Interface GetPackageDetailPackage

    GetPackageDetailPackage sub-interface for GetPackageDetailResponseData

    interface GetPackageDetailPackage {
        allow_self_design_awb?: boolean;
        buyer_preference_for_partial_cancellation?: number;
        buyer_proof_of_collection?: string[];
        can_full_cancel_order?: boolean;
        can_partial_cancel_order?: boolean;
        can_split_order?: boolean;
        can_unsplit_order?: boolean;
        days_to_ship?: number;
        driver_info?: GetPackageDetailDriverInfo;
        fulfillment_status?: string;
        group_shipment_id?: number;
        invoice_pending?: GetPackageDetailInvoicePending;
        is_buyer_shop_collection?: boolean;
        is_pre_order?: boolean;
        is_shipment_arranged?: boolean;
        is_split_up?: boolean;
        item_list?: GetPackageDetailItem[];
        logistics_channel_id?: number;
        order_sn?: string;
        package_number?: string;
        package_query_number?: string;
        parcel_chargeable_weight_gram?: number;
        pending_description?: string[];
        pending_terms?: string[];
        pharmacist_name?: string;
        pickup_done_time?: number;
        preparation_end_time?: number | Date;
        prescription_approval_time?: number | Date;
        prescription_images?: string | number;
        prescription_rejection_time?: number | Date;
        recipient_address?: GetPackageDetailRecipientAddress;
        ship_by_date?: number;
        shipping_carrier?: string;
        sorting_group?: string;
        status_info_tag?: GetPackageDetailStatusInfoTag;
        tracking_number?: string;
        tracking_number_expiration_date?: number;
        update_time?: number;
        virtual_contact_number?: string;
    }
    Index

    Properties

    allow_self_design_awb?: boolean

    To indicate whether the package allows for self-designed AWB, if allow_self_design_awb returns false, it means that the package does not allow for self-designed AWB and only the system-AWB can be used.

    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 proof for buyer self collection at the store.

    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.

    can_split_order?: boolean

    This field indicates whether this order can be split into multiple packages for separate shipment.- true: Support splitting, can call v2.order.split_order to execute- false: Does not support splitting

    can_unsplit_order?: boolean

    This field indicates whether this order can be unsplit.- true: Support unsplitting, can call v2.order.unsplit_order to execute- false: Does not support unsplitting

    days_to_ship?: number

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

    After the driver is successfully called, the driver's information will be returned.Note: Data availability depends on the specific 3PL provider; certain fields may be omitted due to provider policies, PII restrictions, or data unavailability.

    fulfillment_status?: string

    The Shopee fulfillment status for the package. Applicable values: See V2.0 Data Definition - PackageFulfillmentStatus.

    group_shipment_id?: number

    The common identifier for multiple orders combined in the same parcel.

    is_buyer_shop_collection?: boolean

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

    is_pre_order?: boolean

    This field indicates whether this order is a pre-order.- true: Pre-order- false: Non pre-order

    is_shipment_arranged?: boolean

    Only effective when the package's logistics_status/fulfillment_status is LOGISTICS_READY. This parameter further distinguishes between two scenarios:- true: Package shipment has been arranged (Seller has processed shipment, system is generating tracking number, not yet updated to LOGISTICS_REQUEST_CREATED, no duplicate action needed)- false: Package awaiting shipment arrangement (Seller hasn't processed shipment yet, shipping arrangement required)

    is_split_up?: boolean

    To indicate whether this parcel is split.

    item_list?: GetPackageDetailItem[]

    The lis of items in the package.

    logistics_channel_id?: number

    The identity of logistic channel.

    order_sn?: string

    Shopee's unique identifier for an order.

    package_number?: string

    Shopee's unique identifier for the package under an order.

    package_query_number?: string

    [Only for TW non-integrated channel] The query number used in virtual phone number calls to contact the recipient of this package.

    parcel_chargeable_weight_gram?: number

    display weight used to calculate ASF for this parcel

    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

    The timestamp when pickup is done.

    preparation_end_time?: number | Date

    The system-calculated deadline for package preparation. When the package fulfillment_status/logistics_status changes to "LOGISTICS_READY", the system calculates this time based on the "Preparation Time" configured for the logistics channel of this package. Notes: 1) Only effective for logistics channels that have Auto Call Driver enabled and Preparation Time configured.2) Seller needs to complete packing and waybill printing before this time to ensure the package is ready when the driver arrives.3) When this time is reached, the system will automatically arrange shipment and trigger driver dispatch:- If driver calling is successful, the package fulfillment_status/logistics_status will change from “LOGISTICS_READY” to “LOGISTICS_REQUEST_CREATED”.- If driver calling fails, the package fulfillment_status/logistics_status will remain unchanged, and the seller must arrange shipment manually.

    prescription_approval_time?: number | Date

    Time of when the prescription is approved.

    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_rejection_time?: number | Date

    Time of when the prescription is rejected.

    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.

    ship_by_date?: number

    The deadline to ship out the package.

    shipping_carrier?: string

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

    sorting_group?: string

    [Only for TW 30029 channel] This field indicate the sorting group value of the package. This field is only available for logistics_channel_id = 30029 and after the package has been arranged for shipment.

    Package shipping urgency tag information.

    tracking_number?: string

    The tracking number of this package.

    tracking_number_expiration_date?: number

    [TW only] Tracking number expiration date

    update_time?: number

    Timestamp that indicates the last time that there was a change in value of package.

    virtual_contact_number?: string

    [Only for TW non-integrated channel] The virtual phone number to contact the recipient.