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

    Interface AddItemRequest

    Request parameters for add_item

    Add a new item.

    interface AddItemRequest {
        attribute_list?: AddItemAttribute[];
        authorised_brand_id?: number;
        brand?: AddItemBrand;
        category_id: number;
        certification_info?: AddItemCertificationInfo;
        compatibility_info?: AddItemCompatibilityInfo;
        complaint_policy?: AddItemComplaintPolicy;
        condition?: string;
        cssp_id?: number;
        description: string;
        description_info?: AddItemDescriptionInfo;
        description_type?: string;
        dimension?: AddItemDimension;
        ds_cat_rcmd_id?: string;
        gtin_code?: string | number;
        image: AddItemImage;
        item_dangerous?: number;
        item_name: string;
        item_sku?: string;
        item_status?: string;
        logistic_info: AddItemLogisticInfo[];
        medicine_id?: number;
        original_price: number;
        pre_order?: AddItemPreOrder;
        promotion_images?: AddItemPromotionImage;
        purchase_limit_info?: AddItemPurchaseLimitInfo;
        scheduled_publish_time?: number | Date;
        seller_stock?: AddItemSellerStock[];
        size_chart_info?: AddItemSizeChartInfo;
        ssp_id?: number;
        tax_info?: AddItemTaxInfo;
        video_upload_id?: string[];
        weight: number;
        wholesale?: AddItemWholesale[];
    }
    Index

    Properties

    attribute_list?: AddItemAttribute[]

    This field is optional(expect Indonesia) depending on the specific attribute under different categories. Should call shopee.item.GetAttributes to get attribute first. Must contain all all mandatory attribute.

    authorised_brand_id?: number

    ID of authorised reseller brand.

    brand?: AddItemBrand
    category_id: number

    ID of category

    certification_info?: AddItemCertificationInfo

    For PH product certification inputRequired for some category and attribute option

    compatibility_info?: AddItemCompatibilityInfo
    complaint_policy?: AddItemComplaintPolicy

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

    condition?: string

    Condition of item, USED、Used and used will be mapped to Used; NEW、New and new will be mapped to New. Required for BR.

    cssp_id?: number

    The ID of the country-specific Standardized Shop Product (CSSP) to associate with the default model of the new item. The value must be greater than 0 when provided. This field is required when ssp_id is provided.

    description: string

    if description_type is normal , Description information should be set by this field.

    description_info?: AddItemDescriptionInfo

    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, this field must be inputed

    dimension?: AddItemDimension

    The dimension of 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.

    Item images

    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_name: string

    Item name

    item_sku?: string

    SKU tag of item

    item_status?: string

    Item status, could be UNLIST or NORMAL

    logistic_info: AddItemLogisticInfo[]

    Logistic channel setting

    medicine_id?: number

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

    original_price: number

    Item price

    pre_order?: AddItemPreOrder

    Pre order setting

    promotion_images?: AddItemPromotionImage

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

    purchase_limit_info?: AddItemPurchaseLimitInfo

    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

    seller_stock?: AddItemSellerStock[]

    seller stock(Please notice that stock(including Seller Stock and Shopee Stock) should be larger than or equal to real-time reserved stock)

    size_chart_info?: AddItemSizeChartInfo
    ssp_id?: number

    The ID of the Standardized Shop Product (SSP) to associate with the default model of the new item. The value must be greater than 0 when provided. If ssp_id is provided, cssp_id must also be provided.

    tax_info?: AddItemTaxInfo

    Tax information

    video_upload_id?: string[]

    Video upload ID returned from video uploading API. Only accept one video_upload_id.

    weight: number

    The weight of this item, the unit is KG.

    wholesale?: AddItemWholesale[]

    Wholesale setting