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

    Interface GetBookingDetailBooking

    GetBookingDetailBooking sub-interface for GetBookingDetailResponseData

    interface GetBookingDetailBooking {
        booking_sn?: string;
        booking_status?: string | number;
        cancel_by?: string;
        cancel_reason?: string;
        create_time?: number | Date;
        dropshipper?: string;
        dropshipper_phone?: string;
        fulfillment_flag?: string;
        item_list?: GetBookingDetailItem[];
        match_status?: string | number;
        order_sn?: string;
        pickup_done_time?: number | Date;
        recipient_address?: GetBookingDetailRecipientAddress;
        region?: string;
        ship_by_date?: number;
        shipping_carrier?: string;
        update_time?: number | Date;
    }
    Index

    Properties

    booking_sn? booking_status? cancel_by? cancel_reason? create_time? dropshipper? dropshipper_phone? fulfillment_flag? item_list? match_status? order_sn? pickup_done_time? recipient_address? region? ship_by_date? shipping_carrier? update_time?

    Properties

    booking_sn?: string

    Return by default. Shopee's unique identifier for a booking.

    booking_status?: string | number

    Return by default. Enumerated type that defines the current status of the booking. Available value: READY_TO_SHIP/PROCESSED/SHIPPED/CANCELLED/MATCHED

    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.

    create_time?: number | Date

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

    dropshipper?: string

    For Indonesia bookings only. The name of the dropshipper.

    dropshipper_phone?: string

    The phone number of dropshipper, could be empty.

    fulfillment_flag?: string

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

    item_list?: GetBookingDetailItem[]

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

    match_status?: string | number

    MATCH_PENDING/MATCH_SUCCESSFUL/MATCH_FAILED

    order_sn?: string

    Shopee's unique identifier for an order. Only return if booking_status is MATCHED.

    pickup_done_time?: number | Date

    The timestamp when pickup is done.

    recipient_address?: GetBookingDetailRecipientAddress

    This object contains detailed breakdown for the recipient address.

    region?: string

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

    ship_by_date?: number

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

    shipping_carrier?: string

    The logistics service provider that will deliver the booking.

    update_time?: number | Date

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

    Settings

    Member Visibility

    On This Page

    Properties