Interface CancelOrderParams

Parameters for canceling an order

interface CancelOrderParams {
    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

cancel_reason: string

The reason seller want to cancel this order. Applicable values: OUT_OF_STOCK, UNDELIVERABLE_AREA(only apply for TW and MY)

`Optional`item_list

item_list?: CancelOrderItem[]

Required when cancel_reason is OUT_OF_STOCK

order_sn

order_sn: string

Shopee's unique identifier for an order

`Optional`partial_cancel_item_list

partial_cancel_item_list?: CancelOrderPartialCancelItem[]

The list of item models and quantities that the seller wants to partially cancel