Interface ItemListing

Represents a product item in Shopify. Contains all the information needed to display and sell a product.

Example

const product: ItemListing = {
  product_id: "123456",
  title: "Sodium Chloride",
  description: "High purity NaCl",
  price: "29.99",
  vendor: "ChemSupplier",
  shopify_variants: [{
    sku: "CHEM-NACL-500G",
    price: 29.99,
    quantity_total: "100"
  }]
};

interface ItemListing {
    product_id: string;
    original_product_id: string;
    title: string;
    description: string;
    link: string;
    price: string;
    list_price: string;
    quantity: string;
    product_code: string;
    image_link: string;
    vendor: string;
    discount: string;
    add_to_cart_id: string;
    total_reviews: string;
    reviews_average_score: string;
    shopify_variants: ShopifyProductVariant[];
    shopify_images: string[];
    shopify_images_alt?: string[];
    tags: string;
}

Index

Properties

product_id original_product_id title description link price list_price quantity product_code image_link vendor discount add_to_cart_id total_reviews reviews_average_score shopify_variants shopify_images shopify_images_alt? tags

Properties

product_id

product_id: string

Unique identifier for the product in Shopify. Used for product operations and URLs.

Example: "123456789"

original_product_id

original_product_id: string

Original product identifier from external system. Used for synchronization with other platforms.

Example: "EXT-123456"

title

title: string

Display title of the product. Used in product listings and detail pages.

Example: "Sodium Chloride, ACS Grade"

description

description: string

Detailed description of the product. Used on product detail pages and for SEO.

Example: "High purity sodium chloride suitable for laboratory use"

link

link: string

URL path to the product's detail page. Can be relative to the store's base URL.

Example: "/products/sodium-chloride-acs"

price

price: string

Current selling price of the product. String value that may include currency symbol.

Example: "29.99"

list_price

list_price: string

Original or MSRP price before any discounts. String value that may include currency symbol.

Example: "34.99"

quantity

quantity: string

Available quantity of the product. String representation of numeric value.

Example: "100"

product_code

product_code: string

Product code or SKU. Merchant-defined unique identifier.

Example: "CHEM-NACL-500G"

image_link

image_link: string

URL to the product's main image. Used in listings and detail pages.

Example: "/images/products/sodium-chloride.jpg"

vendor

vendor: string

Name of the product vendor or manufacturer. Used for filtering and display.

Example: "ChemSupplier Inc."

discount

discount: string

Discount information for the product. String representation of discount details.

Example: "Save 15%"

add_to_cart_id

add_to_cart_id: string

ID used for adding the product to cart. Used in cart operations.

Example: "add-123456789"

total_reviews

total_reviews: string

Total number of reviews for the product. String representation of numeric value.

Example: "42"

reviews_average_score

reviews_average_score: string

Average review score for the product. String representation of numeric value.

Example: "4.5"

shopify_variants

shopify_variants: ShopifyProductVariant[]

Array of product variants. Contains detailed variant information.

shopify_images

shopify_images: string[]

Array of product image URLs. Used for product galleries.

`Optional`shopify_images_alt

shopify_images_alt?: string[]

Optional array of alt text for product images. Used for accessibility and SEO.

Interface ItemListing

Example

Index

Properties

Properties

product_id

Example: "123456789"

original_product_id

Example: "EXT-123456"

title

Example: "Sodium Chloride, ACS Grade"

description

Example: "High purity sodium chloride suitable for laboratory use"

link

Example: "/products/sodium-chloride-acs"

price

Example: "29.99"

list_price

Example: "34.99"

quantity

Example: "100"

product_code

Example: "CHEM-NACL-500G"

image_link

Example: "/images/products/sodium-chloride.jpg"

vendor

Example: "ChemSupplier Inc."

discount

Example: "Save 15%"

add_to_cart_id

Example: "add-123456789"

total_reviews

Example: "42"

reviews_average_score

Example: "4.5"

shopify_variants

shopify_images

Optionalshopify_images_alt

tags

Example: "chemicals,laboratory,ACS grade"

Settings

On This Page

`Optional`shopify_images_alt