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

    Interface GetShippingDocumentDataInfoShippingDocumentInfo

    GetShippingDocumentDataInfoShippingDocumentInfo sub-interface for GetShippingDocumentDataInfoResponseData

    interface GetShippingDocumentDataInfoShippingDocumentInfo {
        buyer_cpf_id?: string;
        cod?: boolean;
        cod_amount?: string;
        create_date_ymd_sl?: string;
        deliver_area?: string;
        delivery_hub?: string;
        dely_fri_label?: string;
        dely_sat_label?: string;
        dely_sun_label?: string;
        destination_base_code?: string;
        dg_specific_type?: number;
        ec_order_no?: string;
        first_mile_name?: string;
        goods_to_declare?: boolean;
        high_value?: boolean;
        hotspot_id?: string;
        is_lm_dg_bool?: number;
        lane_code?: string;
        last_mile_name?: string;
        last_mile_tracking_number?: string;
        last_third_digits_buyer_phone?: string;
        logistics_channel_id?: number;
        manufacturers_name?: string;
        manufacturers_website?: string;
        mutual_check?: number;
        order_weight?: number;
        parcel_size?: string;
        pickup_code?: string;
        pickup_hub?: string;
        preferred_delivery_option?: number;
        recipient_sort_code?: GetShippingDocumentDataInfoRecipientSortCode;
        return_sort_code?: GetShippingDocumentDataInfoReturnSortCode;
        sender_sort_code?: GetShippingDocumentDataInfoSenderSortCode;
        service_code?: string;
        shipping_carrier?: string;
        shopee_tracking_number?: string;
        sod?: boolean;
        sorting_group?: string;
        spx_receive_station?: GetShippingDocumentDataInfoSpxReceiveStation;
        spx_sub_district?: string;
        third_party_logistic_info?: GetShippingDocumentDataInfoThirdPartyLogisticInfo;
        tracking_number?: string;
        unpackaged_sku_id?: string;
        unpackaged_sku_id_qrcode?: string;
        warehouse_address?: string;
        warehouse_id?: string;
        weekend1_delivery_success_label?: string;
        weekend2_delivery_success_label?: string;
        zone?: string;
        zone_code?: string;
    }
    Index

    Properties

    buyer_cpf_id? cod? cod_amount? create_date_ymd_sl? deliver_area? delivery_hub? dely_fri_label? dely_sat_label? dely_sun_label? destination_base_code? dg_specific_type? ec_order_no? first_mile_name? goods_to_declare? high_value? hotspot_id? is_lm_dg_bool? lane_code? last_mile_name? last_mile_tracking_number? last_third_digits_buyer_phone? logistics_channel_id? manufacturers_name? manufacturers_website? mutual_check? order_weight? parcel_size? pickup_code? pickup_hub? preferred_delivery_option? recipient_sort_code? return_sort_code? sender_sort_code? service_code? shipping_carrier? shopee_tracking_number? sod? sorting_group? spx_receive_station? spx_sub_district? third_party_logistic_info? tracking_number? unpackaged_sku_id? unpackaged_sku_id_qrcode? warehouse_address? warehouse_id? weekend1_delivery_success_label? weekend2_delivery_success_label? zone? zone_code?

    Properties

    buyer_cpf_id?: string

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

    cod?: boolean

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

    cod_amount?: string

    Use this field to indicate cod amount.

    create_date_ymd_sl?: string

    The date of create shipment order.

    deliver_area?: string

    Zone name.

    delivery_hub?: string

    The name of delivery hub.

    dely_fri_label?: string

    Probability of Successful Friday Delivery.The value of L(low), M(medium), H(high) represent the chances of successful delivery attempts on Friday.

    dely_sat_label?: string

    Probability of Successful Saturday DeliveryThe value of L(low), M(medium), H(high) represent the chances of successful delivery attempts on Saturday.

    dely_sun_label?: string

    Probability of Successful Sunday Delivery.The value of L(low), M(medium), H(high) represent the chances of successful delivery attempts on Sunday.

    destination_base_code?: string

    Distribution Center Code.

    dg_specific_type?: number

    Currently only applicable for Brazil, Indonesia, Vietnam, Philippines.For orders with Dangerous Goods, this value indicates the severity of the danger and requires special handling by the logistics provider. 0 = Not classified / no DG sub-type1 = DG_A2 = DG_B3 = DG_C4 = DG_D

    ec_order_no?: string

    The name of ec order.

    first_mile_name?: string

    Only work for cross-border order.The name of the carrier ships cross country or region.

    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.

    high_value?: boolean

    This value indicates whether the order is considered a “high value” item and requires special handling by the logistics provider. The threshold to be considered "high value" item differs by region, and is only applicable to SPX channels. For regions other than Malaysia and Thailand, this field will always return empty.

    hotspot_id?: string

    This ID is used by 3PL to determine parcel routing. For regions other than Malaysia and Thailand, this field will always return empty.

    is_lm_dg_bool?: number

    Use this field to indicate order contains dangerous goods or not.0: Non-dangerous good1: Dangerous good2: Prohibited

    lane_code?: string

    Only work for cross-border order. The string use for waybill printing. The format is "S - region_code and lane_number". For example, S-TH01, S-TH02

    last_mile_name?: string

    Only work for cross-border order.The name of the carrier delivers the parcels in local country or region.

    last_mile_tracking_number?: string

    The last-mile tracking number. Only for Cross Board BR seller.

    last_third_digits_buyer_phone?: string

    Use this field indicates buyer phone number (last 3 digits). For non-TW local sellers

    logistics_channel_id?: number

    The identity of logistic channel.

    manufacturers_name?: string

    The name of manufacturer.

    manufacturers_website?: string

    The website of manufacturer.

    mutual_check?: number

    only apply for ID/VN shops.mutual_check indicates whether the parcel is eligible for Return-on-the-Spot (RoS) co-check. If mutual_check=1, then the parcel is RoS eligible, where drivers and buyers can co-check the parcel. Buyer can then choose to accept or reject the parcel on the spot.If mutual_check=0, then the parcel is ineligible for RoS.

    order_weight?: number

    Use this field to indicate order weight when calculate the shipping fee. The unit of weigh is gram.

    parcel_size?: string

    corresponding locker sizing for self-collection locker channels [only available for specific logistic channels: 148003 and 140006]

    pickup_code?: string

    For drivers to quickly identify parcel to be picked up. Only returned for ID and TH local orders which use instant+sameday for delivery.

    pickup_hub?: string

    The name of pickup hub.

    preferred_delivery_option?: number

    Use this field to indicate delivery address is residential or office address.0: not configured1: office address2: residential address

    recipient_sort_code?: GetShippingDocumentDataInfoRecipientSortCode

    The sort_code of recipient.

    return_sort_code?: GetShippingDocumentDataInfoReturnSortCode

    The sort code for 3PL doing RTS.

    sender_sort_code?: GetShippingDocumentDataInfoSenderSortCode

    The sort_code of sender.

    service_code?: string

    Only work for cross-border order. This code is required at some sorting hub. Please ensure the service_code is INCLUDED on your shipping label, otherwise the parcel cannot be processed by the warehouse. If you didn't retrieve service_code after you first called this API, please try few more times within 30 minutes.

    shipping_carrier?: string

    The logistics service provider that the buyer selected for the order to deliver items.

    shopee_tracking_number?: string

    First mile tracking NO. for CrossBoard BR seller can be used to self-design CB Brazil AWB.

    sod?: boolean

    this value indicates whether the buyer select "scan on delivery" payment channel at checkout.

    sorting_group?: string

    [Only for TW 30029 channel] This field indicate the sorting group value of the package. Available values: - North- South

    spx_receive_station?: GetShippingDocumentDataInfoSpxReceiveStation

    The spx receive station.

    spx_sub_district?: string

    The sub-district of recipient's address.

    third_party_logistic_info?: GetShippingDocumentDataInfoThirdPartyLogisticInfo

    Only used for TW sellers.

    tracking_number?: string

    The tracking number assigned by the shipping carrier for item shipment.

    unpackaged_sku_id?: string

    [Only for TW 30029 channel] Please refer to this number instead of tracking number for this this channel. This field will be empty for other channels.

    unpackaged_sku_id_qrcode?: string

    [Only for TW 30029 channel] Please refer to this field to generate the QR code for the shipping document for this channel. This field will be empty for other channels.

    warehouse_address?: string

    Only work for cross-border order in some special shop. The address info of the warehouse.

    warehouse_id?: string

    Only work for cross-border order in some special shop. The ID of the warehouse.

    weekend1_delivery_success_label?: string

    This value indicates whether an order has a high / medium / low delivery success rate on each weekend (e.g. sat and sun respectively). For regions other than Malaysia, this field will always return empty.High = HMedium = MLow = L

    weekend2_delivery_success_label?: string

    This value indicates whether an order has a high / medium / low delivery success rate on each weekend (e.g. sat and sun respectively). For regions other than Malaysia, this field will always return empty.High = HMedium = MLow = L

    zone?: string

    The zone of this order.

    zone_code?: string

    Delivery Sub Zone.

    Settings

    Member Visibility

    On This Page

    Properties