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

    Interface GetOrderDetailItem

    GetOrderDetailItem sub-interface for GetOrderDetailOrder

    interface GetOrderDetailItem {
        active_qty?: number;
        add_on_deal?: boolean;
        add_on_deal_id?: number;
        bundle_sku_id?: string;
        cancel_requested_qty?: number;
        cancelled_qty?: number;
        components?: GetOrderDetailComponent[];
        consultation_id?: string;
        error_in_fetching_is_prescription_item?: boolean;
        hot_listing_item?: boolean;
        image_info?: GetOrderDetailImageInfo;
        is_b2c_owned_item?: boolean;
        is_fulfillment_mapping?: boolean;
        is_prescription_item?: boolean;
        item_id?: number;
        item_name?: string;
        item_sku?: string;
        line_item_id?: number;
        main_item?: boolean;
        model_discounted_price?: number;
        model_id?: number;
        model_name?: string;
        model_original_price?: number;
        model_quantity_purchased?: number;
        model_sku?: string;
        order_item_id?: number;
        product_location_id?: string;
        promotion_group_id?: number;
        promotion_id?: number;
        promotion_list?: GetOrderDetailPromotion[];
        promotion_type?: string;
        return_requested_qty?: number;
        returned_qty?: number;
        weight?: number;
        wholesale?: boolean;
    }
    Index

    Properties

    active_qty? add_on_deal? add_on_deal_id? bundle_sku_id? cancel_requested_qty? cancelled_qty? components? consultation_id? error_in_fetching_is_prescription_item? hot_listing_item? image_info? is_b2c_owned_item? is_fulfillment_mapping? is_prescription_item? item_id? item_name? item_sku? line_item_id? main_item? model_discounted_price? model_id? model_name? model_original_price? model_quantity_purchased? model_sku? order_item_id? product_location_id? promotion_group_id? promotion_id? promotion_list? promotion_type? return_requested_qty? returned_qty? weight? wholesale?

    Properties

    active_qty?: number

    The quantity of the item model that remains active in the order and is still expected to be fulfilled.

    add_on_deal?: boolean

    To indicate if this item belongs to an addon deal.

    add_on_deal_id?: number

    A unique ID to distinguish groups of items in Cart, and Order. (e.g. AddOnDeal)

    bundle_sku_id?: string

    The unique identifier (SKU ID) of the front-facing Bundle SKU purchased by the buyer on Shopee. Field will only be returned if shop is whitelisted and is_fulfillment_mapping returns true.

    cancel_requested_qty?: number

    The quantity of the item model that is currently under a cancellation request but has not yet reached the final cancelled status.

    cancelled_qty?: number

    The quantity of the item model that has already been successfully cancelled.

    components?: GetOrderDetailComponent[]

    List of underlying Parent SKUs (component level) associated with the mapped Bundle SKU, used by WMS/ERP for physical picking and fulfillment. If is_fulfillment_mapping returns 'false', this array will not be returned. Array will only be returned if shop is whitelisted and is_fulfillment_mapping returns true.

    consultation_id?: string

    An identifier of teleconsultation session which buyer did to order this item. Empty if item is not ordered through teleconsultation session

    error_in_fetching_is_prescription_item?: boolean

    To indicate if there was an error when validating whether this item is prescription. Default false. If is_prescription_item=false and this field is true, the item's prescription status is uncertain (label service call failed). Only for TH, PH, ID local shop.

    hot_listing_item?: boolean

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

    image_info?: GetOrderDetailImageInfo

    Image info of the product.

    is_b2c_owned_item?: boolean

    determine if item is B2C_shop_itemIt should be is_b2c_shop_item but it was a bug from dev. Then now it's is_b2c_owned_item

    is_fulfillment_mapping?: boolean

    Flag indicating whether the item contains any bundle items configured with Fulfillment Mapping (FFM). Returns 'true' if the item uses FFM logic, 'false' otherwise. Field will only be returned if shop is whitelisted.

    is_prescription_item?: boolean

    To indicate if this item is prescription item. Only for PH, TH, ID local shop.

    item_id?: number

    Shopee's unique identifier for an item.

    item_name?: string

    The name of the item.

    item_sku?: string

    A item SKU (stock keeping unit) is an identifier defined by a seller, sometimes called parent SKU. Item SKU can be assigned to an item in Shopee Listings.

    line_item_id?: number

    The identity of order item. In case the order item is a bundle deal, this value will be unique to distinguish the order item

    main_item?: boolean

    To indicate if this item is main item or sub item. True means main item, false means sub item.

    model_discounted_price?: number

    The after-discount price of the item in the listing currency. If there is no discount, this value will be same as that of model_original_price. In case of bundle deal item, this value will return 0 as by design bundle deal discount will not be breakdown to item/model level. Due to technical restriction, the value will return the price before bundle deal if we don't configure it to 0. Please call GetEscrowDetails if you want to calculate item-level discounted price for bundle deal item.

    model_id?: number

    ID of the model that belongs to the same item.

    model_name?: string

    Name of the model that belongs to the same item. A seller can offer models of the same item. For example, the seller could create a fixed-priced listing for a t-shirt design and offer the shirt in different colors and sizes. In this case, each color and size combination is a separate model. Each model can have a different quantity and price.

    model_original_price?: number

    The original price of the item in the listing currency.

    model_quantity_purchased?: number

    The number of identical items purchased at the same time by the same buyer from one listing/item.

    model_sku?: string

    A model SKU (stock keeping unit) is an identifier defined by a seller. It is only intended for the seller's use. Many sellers assign a SKU to an item of a specific type, size, and color, which are models of one item in Shopee Listings.

    order_item_id?: number

    The identify of order item.

    product_location_id?: string

    The fulfilment warehouse ID(s) of the items in the order. (Multi-Warehouse sellers only)

    promotion_group_id?: number

    The identify of product promotion.

    promotion_id?: number

    The ID of the promotion.

    promotion_list?: GetOrderDetailPromotion[]
    promotion_type?: string

    Available type：product_promotion, flash_sale, bundle_deal, add_on_deal_main, add_on_deal_sub.For items which attend multiple promotions will only show one promotion, the order of priority is: bundle_deal > add_on_deal_main > add_on_deal_sub > product_promotion >flash_sale

    return_requested_qty?: number

    The quantity of the item model that is currently under a return/refund request.

    returned_qty?: number

    The quantity of the item model that has already been successfully returned through the return/refund process.

    weight?: number

    The weight of the item

    wholesale?: boolean

    This value indicates whether buyer buy the order item in wholesale price.

    Settings

    Member Visibility

    On This Page

    Properties