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

    Interface UpdateItemRequest

    Request parameters for update_item

    Update item.

    interface UpdateItemRequest {
        attribute_list?: UpdateItemAttribute[];
        authorised_brand_id?: number;
        brand?: UpdateItemBrand;
        category_id?: number;
        certification_info?: UpdateItemCertificationInfo;
        compatibility_info?: UpdateItemCompatibilityInfo;
        complaint_policy?: UpdateItemComplaintPolicy;
        condition?: string;
        description?: string;
        description_info?: UpdateItemDescriptionInfo;
        description_type?: string;
        dimension?: UpdateItemDimension;
        ds_cat_rcmd_id?: string;
        gtin_code?: string | number;
        image?: UpdateItemImage;
        item_dangerous?: number;
        item_id: number;
        item_name?: string;
        item_sku?: string;
        item_status?: string;
        medicine_id?: number;
        pre_order?: UpdateItemPreOrder;
        promotion_images?: UpdateItemPromotionImage;
        purchase_limit_info?: UpdateItemPurchaseLimitInfo;
        scheduled_publish_time?: number | Date;
        size_chart_info?: UpdateItemSizeChartInfo;
        tax_info?: UpdateItemTaxInfo;
        video_upload_id?: string[];
        weight?: number;
        wholesale?: UpdateItemWholesale[];
    }
    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_id item_name? item_sku? item_status? medicine_id? pre_order? promotion_images? purchase_limit_info? scheduled_publish_time? size_chart_info? tax_info? video_upload_id? weight? wholesale?

    Properties

    attribute_list?: UpdateItemAttribute[]

    Item attributes.

    authorised_brand_id?: number

    ID of authorised reseller brand.

    brand?: UpdateItemBrand
    category_id?: number

    ID of category.

    certification_info?: UpdateItemCertificationInfo

    For PH product certification inputRequired for some category and attribute option

    compatibility_info?: UpdateItemCompatibilityInfo
    complaint_policy?: UpdateItemComplaintPolicy

    Complaint Policy for item. Only required for local PL sellers, ignored otherwise.

    condition?: string

    Condition of item, could be NEW or USED.

    description?: string

    Description of item.

    description_info?: UpdateItemDescriptionInfo

    New description field. Only whitelist sellers can use it. If you use the field, please upload the description_type=extended otherwise api will return error. If you don't use this field, you don't need to upload the description_type or upload description_type=normal

    description_type?: string

    Values: See Data Definition- description_type (normal , extended). If you want to use extended_description or change description type ,this field must be inputed

    dimension?: UpdateItemDimension

    The dimension of this item.Updating the dimension of this item will overwrite the dimension of all models under this item.

    ds_cat_rcmd_id?: string

    category recommendation service id

    gtin_code?: string | number
    • GTIN is an identifier for trade items, developed by the international organization GS1.- They have 8 to 14 digits. The most common are UPC, EAN, JAN and ISBN.- GTIN will help boost positioning in online marketing channels like Google and Facebook.- That incorporation with GTIN will also aid in Search and Recommendation in Shopee itself allowing buyers to have higher likelihood of finding one's listing.Note: If you want to set “Item without GTIN”, please pass the gtin_code as "00".The validation rule is based on the value return in gtin_validation_rule" field in v2.product.get_item_limit API- Mandatory: This field is required and must contain a correctly formatted GTiN number.- Flexible: This field is required and must contain either a correctly formatted GTlN number or "00" to declare that the item/model has no valid GTlN.- Optional: This field is optional and can contain a correctly formatted GTiN number, "00" or be omitted entirely.
    image?: UpdateItemImage

    Images of item.

    item_dangerous?: number

    This field is only applicable for local sellers in Indonesia and Malaysia. Use this field to identify whether a product is a dangerous product. 0 for non-dangerous product and 1 for dangerous product. For more information, please visit the market's respective Seller Education Hub.

    item_id: number

    ID of item.

    item_name?: string

    Item name.

    item_sku?: string

    SKU tag for item.

    item_status?: string

    Item status, could be UNLIST or NORMAL.

    medicine_id?: number

    [Only for ID local sellers] as a unique identifier for each standardized medicine, the medicine id can only be obtained offline

    pre_order?: UpdateItemPreOrder

    Pre Order setting.

    promotion_images?: UpdateItemPromotionImage

    Promotion ImageCurrently only allow one promoton imageYou could set promotion image only if the product images' ratio is 3:4

    purchase_limit_info?: UpdateItemPurchaseLimitInfo

    purchase limit info

    scheduled_publish_time?: number | Date

    Scheduled publish time of this item: 1) Can only set scheduled_publish_time for item with UNLIST status2) Can only set the time from current time +1hour to current time +90days, and the time is only allowed to be accurate to the minute

    size_chart_info?: UpdateItemSizeChartInfo
    tax_info?: UpdateItemTaxInfo

    Tax information

    video_upload_id?: string[]

    Video upload ID returned from video uploading API.If you want to delete it, please pass it with blank.

    weight?: number

    The weight of this item, the unit is KG.Updating the weight of this item will overwrite the weight of all models under this item.

    wholesale?: UpdateItemWholesale[]

    Wholesale setting.If you want to delete it, please pass it with blank.

    Settings

    Member Visibility

    On This Page

    Properties