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

    Interface ShopListingWithAssociations

    Definition: ShopListingWithAssociations

    interface ShopListingWithAssociations {
        creation_timestamp: number;
        description: string;
        ending_timestamp: number;
        featured_rank: number;
        file_data: string;
        has_variations: boolean;
        images: ListingImage[];
        is_customizable: boolean;
        is_personalizable: boolean;
        is_private: boolean;
        is_supply: boolean;
        item_dimensions_unit: ItemDimensionsUnit;
        item_height: number;
        item_length: number;
        item_weight: number;
        item_weight_unit: ItemWeightUnit;
        item_width: number;
        language: string;
        last_modified_timestamp: number;
        listing_id: number;
        listing_type: boolean;
        materials: string[];
        non_taxable: boolean;
        num_favorers: number;
        occasion: Occasion;
        original_creation_timestamp: number;
        personalization_char_count_max: number;
        personalization_instructions: string;
        personalization_is_required: boolean;
        price: Money;
        processing_max: number;
        processing_min: number;
        production_partners: ShopProductionPartner[];
        quantity: number;
        recipient: Recipient;
        shipping_profile_id: number;
        shop: Shop;
        shop_id: number;
        shop_section_id: number;
        should_auto_renew: boolean;
        state: State;
        state_timestamp: number;
        style: string[];
        tags: string[];
        taxonomy_id: number;
        title: string;
        url: string;
        user: User;
        user_id: number;
        when_made: WhenMade;
        who_made: WhoMade;
    }
    Index
    creation_timestamp: number

    The listing's creation time, in epoch seconds.

    description: string

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

    ending_timestamp: number

    The listing's expiration time, in epoch seconds.

    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.

    file_data: string

    A string describing the files attached to a digital listing.

    has_variations: boolean

    When true, the listing has variations.

    images: ListingImage[]

    Represents a list of listing image resources, each of which contains the reference URLs and metadata for an image

    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. The default value is null.

    is_private: boolean

    When true, this is a private listing intendend for a specific buyer and hidden from shop view.

    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'.

    item_dimensions_unit: ItemDimensionsUnit
    item_height: number

    The numeric length of the product measured in units set in item dimensions unit. Default value is null. If set, the value must be greater than 0.

    item_length: number

    The numeric length of the product measured in units set in item dimensions unit. Default value is null. If set, the value must be greater than 0.

    item_weight: number

    The numeric weight of the product measured in units set in item weight unit. Default value is null. If set, the value must be greater than 0.

    item_weight_unit: ItemWeightUnit
    item_width: number

    The numeric width of the product measured in units set in item dimensions unit. Default value is null. If set, the value must be greater than 0.

    language: string

    The IETF language tag for the default language of the listing. Ex: de, en, es, fr, it, ja, nl, pl, pt, ru.

    last_modified_timestamp: number

    The time of the last update to the listing, in epoch seconds.

    listing_id: number

    The numeric ID for the listing associated to this transaction.

    listing_type: boolean

    An enumerated type string that indicates whether the listing is physical or a digital download.

    materials: string[]

    A list 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) Default value is null.

    non_taxable: boolean

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

    num_favorers: number

    The number of users who marked this listing a favorite.

    occasion: Occasion
    original_creation_timestamp: number

    The listing's creation time, in epoch seconds.

    personalization_char_count_max: number

    This an integer value representing the maximum length for the personalization message entered by the buyer.

    personalization_instructions: string

    When true, this listing requires personalization. The default value is null.

    personalization_is_required: boolean

    When true, this listing requires personalization. The default value is null.

    price: Money
    processing_max: number

    The maximum number of days required to process this listing. Default value is null.

    processing_min: number

    The minimum number of days required to process this listing. Default value is null.

    production_partners: ShopProductionPartner[]

    Represents a list of production partners for a shop.

    quantity: number

    The positive non-zero number of products available for purchase in the listing. Note: The listing quantity is the sum of available offering quantities. You can request the quantities for individual offerings from the ListingInventory resource using the get listing inventory endpoint.

    recipient: Recipient
    shipping_profile_id: number

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

    shop: Shop
    shop_id: number

    The unique positive non-zero numeric ID for an Etsy Shop.

    shop_section_id: number

    The numeric ID of a section in a specific Etsy shop.

    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.

    state: State
    state_timestamp: number

    The date and time of the last state change of this listing.

    style: 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) Default value is null.

    tags: string[]

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

    taxonomy_id: number

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

    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.

    url: string

    The full URL to the listing's page on Etsy.

    user: User
    user_id: number

    The numeric ID for the user posting the listing.

    when_made: WhenMade
    who_made: WhoMade