Azure Connectors Node.js SDK
    Preparing search index...

    Interface ListingUpdateInput

    Update a listing

    interface ListingUpdateInput {
        channels?: string;
        description?: string;
        featured_rank?: number;
        image_ids?: string;
        is_customizable?: boolean;
        is_personalizable?: boolean;
        is_supply?: boolean;
        is_taxable?: boolean;
        item_dimensions_unit?: string;
        item_height?: number;
        item_length?: number;
        item_weight?: number;
        item_weight_unit?: string;
        item_width?: number;
        materials?: string;
        occasion?: string;
        price?: number;
        processing_max?: number;
        processing_min?: number;
        quantity?: number;
        recipient?: string;
        shipping_profile_id?: number;
        shop_section_id?: number;
        should_auto_renew?: boolean;
        styles?: string;
        tags?: string;
        taxonomy_id?: number;
        title?: string;
        type?: string;
        when_made?: string;
        who_made?: string;
    }
    Index
    channels?: string

    An array of enumerated channel ID strings. A channel is a venue for sellers to reach buyers in order to make sales.

    description?: string

    A description string of the product for sale in the listing.

    featured_rank?: number

    The positive non-zero numeric position in the featured listings of the shop with rank 1 listings appearing in the left-most position in featured listing on a shop’s home page.

    image_ids?: string

    An array of numeric image IDs of the images in a listing, which can include up to 10 images.

    is_customizable?: boolean

    When true, a buyer may contact the seller for a customized order. The default value is true when a shop accepts custom orders. Does not apply to shops that do not accept custom orders.

    is_personalizable?: boolean

    When true, this listing is personalizable.

    is_supply?: boolean

    When true, tags the listing as a supply product, else indicates that it's a finished product. Helps buyers locate the listing under the Supplies heading. Requires 'who made' and 'when made'.

    is_taxable?: boolean

    When true, applicable shop tax rates apply to this listing at checkout.

    item_dimensions_unit?: string

    A string defining the units used to measure the dimensions of the product.

    item_height?: number

    The numeric height of the product measured in units set in 'item dimensions unit'.

    item_length?: number

    The numeric length of the product measured in units set in item dimensions unit.

    item_weight?: number

    The numeric weight of the product measured in units set in item weight unit.

    item_weight_unit?: string

    A string defining the units used to measure the weight of the product.

    item_width?: number

    The numeric width of the product measured in units set in 'item dimensions unit'.

    materials?: string

    A array of material strings for materials used in the product. Valid materials strings contain only letters, numbers, and whitespace characters. (regex: /[^\p{L}\p{Nd}\p{Zs}]/u)

    occasion?: string

    A string indicating an occassion for which this product would make an appropriate gift.

    price?: number

    The positive non-zero price of the product. (Sold product listings are private) Note: The price is the minimum possible price.

    processing_max?: number

    The maximum number of days required to process this listing.

    processing_min?: number

    The minimum number of days required to process this listing.

    quantity?: number

    The positive non-zero number of products available for purchase in the listing.

    recipient?: string

    A string indicating a person for whom this product would make an appropriate gift.

    shipping_profile_id?: number

    The numeric ID of the shipping profile associated with the listing.

    shop_section_id?: number

    The numeric ID of the shop section for this listing.

    should_auto_renew?: boolean

    When true, renews a listing for four months upon expriation. If set to true when previously false, etsy.com renews the listing before it expires, but the renewal period starts immidiately rather than extending the listing's expiration date. Any unused time remaining on the listing is lost. Renewals result in charges to a user's bill.

    styles?: string

    An array of style strings for this listing, each of which is free-form text string such as Formal, or Steampunk. A Listing may have up to two styles. Valid style strings contain only letters, numbers, and whitespace characters. (regex: /[^\p{L}\p{Nd}\p{Zs}]/u)

    tags?: string

    An array of tag strings for the listing. Valid tag strings contain only letters, numbers, whitespace characters, -, ', ™, ©, and ®. (regex: /[^\p{L}\p{Nd}\p{Zs}-'™©®]/u)

    taxonomy_id?: number

    The numeric taxonomy ID of the listing. The seller manages listing taxonomy IDs for their shop.

    title?: string

    The listing's title string. Valid title strings contain only letters, numbers, punctuation marks, mathematical symbols, whitespace characters, ™, ©, and ®. (regex: /[^\p{L}\p{Nd}\p{P}\p{Sm}\p{Zs}™©®]/u) You can only use the %, :, & and + characters once each.

    type?: string

    Indicates whether the listing is physical or a digital download.

    when_made?: string

    A string for the era in which the maker made the product in this listing. Helps buyers locate the listing under the Vintage heading. Requires 'is_supply' and 'who_made'.

    who_made?: string

    An string inidcated who made the product. Helps buyers locate the listing under the Handmade heading. Requires 'is_supply' and 'when_made'.