Shopee SDK API Reference - v1.11.0
    Preparing search index...

    Type Alias AddItemParams

    Parameters for adding a new item

    type AddItemParams = {
        attribute_list?: ItemAttribute[];
        authorised_brand_id?: number;
        brand?: BrandInfo;
        category_id: number;
        certification_info?: {
            certification_list?: {
                certification_no: string;
                certification_proofs: {
                    file_name: string;
                    image_id: number;
                    ratio: number;
                }[];
                expiry_date?: number;
                permit_id: number;
            }[];
        };
        compatibility_info?: {
            vehicle_info_list: {
                brand_id: number;
                model_id: number;
                version_id?: number;
                year_id?: number;
            }[];
        };
        complaint_policy?: ComplaintPolicy;
        condition?: string;
        description: string;
        description_info?: DescriptionInfo;
        description_type?: string;
        dimension?: Dimension;
        ds_cat_rcmd_id?: string;
        gtin_code?: string;
        image: ImageInput;
        item_dangerous?: number;
        item_name: string;
        item_sku?: string;
        item_status?: string;
        logistic_info?: LogisticInfo[];
        medicine_id?: number;
        original_price: number;
        pre_order?: PreOrder;
        promotion_images?: { image_id_list?: string[] };
        purchase_limit_info?: PurchaseLimitInfo;
        scheduled_publish_time?: number;
        seller_stock?: SellerStockUpdate[];
        size_chart_info?: { size_chart?: string; size_chart_id?: number };
        tax_info?: TaxInfo;
        video_upload_id?: string[];
        weight?: number;
        wholesale?: Wholesale[];
    }
    Index

    Properties

    attribute_list? authorised_brand_id? brand? category_id certification_info? compatibility_info? complaint_policy? condition? description description_info? description_type? dimension? ds_cat_rcmd_id? gtin_code? image item_dangerous? item_name item_sku? item_status? logistic_info? medicine_id? original_price pre_order? promotion_images? purchase_limit_info? scheduled_publish_time? seller_stock? size_chart_info? tax_info? video_upload_id? weight? wholesale?

    Properties

    attribute_list?: ItemAttribute[]

    Attribute list

    authorised_brand_id?: number

    ID of authorised reseller brand

    brand?: BrandInfo

    Brand information

    category_id: number

    Category ID

    certification_info?: {
        certification_list?: {
            certification_no: string;
            certification_proofs: {
                file_name: string;
                image_id: number;
                ratio: number;
            }[];
            expiry_date?: number;
            permit_id: number;
        }[];
    }

    Certification information

    compatibility_info?: {
        vehicle_info_list: {
            brand_id: number;
            model_id: number;
            version_id?: number;
            year_id?: number;
        }[];
    }

    Compatibility information

    complaint_policy?: ComplaintPolicy

    Complaint policy (PL only)

    condition?: string

    Item condition: NEW or USED

    description: string

    Item description

    description_info?: DescriptionInfo

    Description info for extended description

    description_type?: string

    Description type

    dimension?: Dimension

    Package dimensions

    ds_cat_rcmd_id?: string

    Category recommendation service ID

    gtin_code?: string

    GTIN code

    image: ImageInput

    Image information

    item_dangerous?: number

    Item dangerous goods indicator

    item_name: string

    Item name

    item_sku?: string

    Item SKU

    item_status?: string

    Item status: NORMAL or UNLIST

    logistic_info?: LogisticInfo[]

    Logistics information

    medicine_id?: number

    Medicine ID

    original_price: number

    Original price of the item

    pre_order?: PreOrder

    Pre-order information

    promotion_images?: { image_id_list?: string[] }

    Promotion Image

    purchase_limit_info?: PurchaseLimitInfo

    Purchase limit information

    scheduled_publish_time?: number

    Scheduled publish time

    seller_stock?: SellerStockUpdate[]

    Seller stock list

    size_chart_info?: { size_chart?: string; size_chart_id?: number }

    Size chart information

    tax_info?: TaxInfo

    Tax information

    video_upload_id?: string[]

    Video upload IDs

    weight?: number

    Item weight in KG

    wholesale?: Wholesale[]

    Wholesale pricing

    Settings

    Member Visibility

    On This Page

    Properties