Schema library e-commerce

Return a product listing from a public page.

Pass this JSON Schema and a public source URL to/extract/json. Return product name, price, currency, availability, variants, and other fields defined by the schema.

Use this schema The JSON file

tabstack.ai/pricing

TEXT

MARKDOWN

LINKS

extract.tsTypeScript

const res = await client.extract.json({
  url: 'https://example.com/pricing',
  json_schema: {
    type: 'object',
    properties: {
      plan: { type: 'string' },
      price: { type: 'number' },
    },
  },
})

res = client.extract.json(
    url='https://example.com/pricing',
    json_schema={
        'type': 'object',
        'properties': {
            'plan': {'type': 'string'},
            'price': {'type': 'number'},
        },
    },
)

tabstack extract json https://example.com/pricing \
  --schema '{"type":"object","properties":{"plan":{"type":"string"},"price":{"type":"number"}}}'

What it captures

Fields in this product listing.

Schema for e-commerce product listings from marketplaces and direct retail sites.

Field	Type	What it holds
`title`	string, required	Product title or name.
`brand`	string	Brand or manufacturer name.
`asin_or_sku`	string	Platform-specific product identifier (ASIN, SKU, or product ID).
`platform`	string, required	E-commerce platform or marketplace (e.g., Amazon, Walmart, Shopify).
`price`	number, required	Current listed price.
`sale_price`	number	Sale or discounted price.
`currency`	string	ISO 4217 currency code.
`availability`	string, required	Current availability status of the product.
`condition`	string	Condition of the product.
`variant_options`	array	Available variant options (e.g., color, size).
`review_count`	number	Total number of customer reviews.
`review_rating`	number	Average customer review rating.
`seller_name`	string	Name of the seller or vendor.
`fulfillment_type`	string	Fulfillment method (Fulfilled by Amazon, Merchant, or Direct).
`images`	array	URLs of product images.
`description`	string	Full product description text.
`features_list`	array	Bullet-point feature list.
`category`	string	Primary product category.
`subcategory`	string	Product subcategory.
`rank_in_category`	number	Bestseller or sales rank within the category.
`page_title`	string	Title of the source page. Tabstack auto-fills this from page metadata when left empty.
`favicon`	string	Favicon URL of the source page. Tabstack auto-fills this from page metadata when left empty.

Example

Inspect and validate the response shape.

The example below is generated from the schema to demonstrate its structure. Edit the object or paste a real response to validate it in your browser.

What it checks

Pass or fail, and the first reason why.

Whether the text parses as JSON, whether the top level is an object, and whether each field the schema requires is present at the declared type. A null is allowed anywhere. Every key you ask for is present. A field the page does not state can come back null, empty, a placeholder number, or a guessed value. Validate values, not just keys.

Example data, not a live response.

Usage

Send the schema with your source URL.

The schema travels with the request rather than living on your account, so the same call can send a trimmed version for one page and the full one for another. Every key you ask for is present. A field the page does not state can come back null, empty, a placeholder number, or a guessed value. Validate values, not just keys.

product.tsTypeScript

import schema from './product-listing.json'

const res = await client.extract.json({
  url: 'https://example.com/pricing',
  json_schema: schema,
})

tabstack extract json 'https://example.com/pricing' \
  --schema @./product-listing.json

Adaptation

Make the schema match your application.

The schema is a starting point, not a guarantee that every source page contains every field. Three things are worth doing before you write one into your system, and the schema-authoring guide covers the rest.

Remove what you do not need

A shorter schema is a smaller response and fewer fields to handle.

Describe the ambiguous ones

A description tells Extract what to look for when a label could mean two things.

Validate before you store

Check the returned object against the schema rather than trusting it.

Related schemas

Other schemas in this category.

Same category: category search results.
Same category: grocery & cpg product.
Same category: marketplace seller profile.
The job rather than the object: the Extract API.