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

    Interface CancelOrderRequest

    Request parameters for cancel_order

    Use this api to cancel an order. This action can only be performed before the order has been shipped.

    interface CancelOrderRequest {
        cancel_reason: string;
        item_list?: CancelOrderItem[];
        order_sn: string;
        partial_cancel_item_list?: CancelOrderPartialCancelItem[];
    }
    Index

    Properties

    cancel_reason item_list? order_sn partial_cancel_item_list?

    Properties

    cancel_reason: string

    The reason seller want to cancel this order. Applicable values: OUT_OF_STOCKCUSTOMER_REQUESTUNDELIVERABLE_AREA (Note: Only apply for TW and MY)COD_NOT_SUPPORTED

    item_list?: CancelOrderItem[]

    Required when cancel_reason is OUT_OF_STOCK.

    order_sn: string

    Shopee's unique identifier for an order.

    partial_cancel_item_list?: CancelOrderPartialCancelItem[]

    The list of item models and quantities that the seller wants to partially cancel. This field should be provided when the seller intends to cancel only part of the order due to unavailable items while continuing to fulfill the remaining items.

    Settings

    Member Visibility

    On This Page

    Properties